users/me is deprecated and replaced by users/self (iZettle#143)

* Replaced the deprecated `users/me` with `users/self`

* Updated CHANGELOG with the info about users/me deprecation.

* Editorial fixes

* Update CHANGELOG.adoc

Co-authored-by: AndreaFilyo <[email protected]>

Co-authored-by: AndreaFilyo <[email protected]>

* Updated based on Anand's comment

* Clarified how to specify the organization UUID and how to use `self`

Co-authored-by: AndreaFilyo <[email protected]>

Author: Astro-Choco

CHANGELOG.adoc

@@ -7,6 +7,20 @@ Each log entry uses the following tags:
 - For API changes and the corresponding documentation changes, the log is tagged with the name of the changes API. For example, `OAuth API`.
 - For documentation changes that are editorial and are not introduced by any API change, the log is tagged with `Editorial changes`.
 
+.**January 18, 2022** `OAuth API` `Editorial changes`
+[%collapsible]
+====
+**Replaced the deprecated endpoint `users/me` with `users/self`**
+
+The following updates were done for the deprecation:
+
+- The OAuth API endpoint `users/me` is deprecated and replaced by `users/self`.
+- Until `users/me` is removed, all API requests to it will be redirected to `users/self`.
+- The API documentation is updated to include `users/self` instead of `users/me`.
+
+> **Note:** The support for the deprecated `users/me` will continue until further notice. It is recommended to replace `users/me` with `users/self` in your integration as soon as possible.
+====
+
 .**November 24, 2021** `Editorial changes`
 [%collapsible]
 ====
@@ -29,7 +43,7 @@ The improvements include the following:
 The Password grant OAuth flow has been deprecated and will be removed on 31st January 2022. Please update your Zettle integration to another authentication flow to keep it running. For information about how to update the authentication flow, see xref:oauth-api/zettle-password-grant-migration-guide/zettle-password-grant-migration-guide.md[Zettle Password grant migration guide].
 ====
 
-.**July 20 2021** `Finance API`
+.**July 20, 2021** `Finance API`
 [%collapsible]
 ====
 **Finance API documentation improvements**
@@ -41,7 +55,7 @@ The improvements include the following:
 - Added user guides.
 ====
 
-.**May 3 2021** `Pusher API`
+.**May 3, 2021** `Pusher API`
 [%collapsible]
 ====
 **Pusher API documentation improvements**
@@ -53,7 +67,7 @@ The improvements include the following:
 - Added the user guides and troubleshooting documents.
 ====
 
-.**October 28 2020** `Editorial changes`
+.**October 28, 2020** `Editorial changes`
 [%collapsible]
 ====
 **Applied a Beta label on any mention of API documentation**
@@ -65,7 +79,7 @@ To be transparent and set expectations right, we've applied a Beta label on any
 We are currently working to improve the Zettle Developer Platform, including the API documentation.
 ====
 
-.**September 21 2020** `Finance API` `Purchase API` `Product library API` `Image API`
+.**September 21, 2020** `Finance API` `Purchase API` `Product library API` `Image API`
 [%collapsible]
 ====
 Updated documentation for Finance, Purchase, Product Library, and Image APIs.

README.md

@@ -55,4 +55,4 @@ When contacting the Integrations team, please provide the following information:
 * Information about affected merchants. That includes:
     * Emails of affected merchants.
     * UUIDs and organisation UUIDs of the affected merchants.
-      To fetch UUIDs and organisation UUIDs, use the `GET users/me` endpoint of the OAuth API. For more information about using the endpoint, see [Get user info](authorization.md/#get-user-info).
+      To fetch UUIDs and organisation UUIDs, use the `GET users/self` endpoint of the OAuth API. For more information about using the endpoint, see [Get user info](authorization.md/#get-user-info).

faq.adoc

@@ -81,10 +81,18 @@ filter instead of `{organizationUuid}`
 [%collapsible]
 ====
 ****
-You can either use the `self` filter or call the following endpoint to fetch the organization UUID.
+You can use the `self` path parameter instead of specifying organization UUID in an endpoint.
+
+Example request
+[source]
+--
+GET /organizations/self/accounts/{accountTypeGroup}/balance
+--
+
+Or, you can fetch the organization UUID by calling the following endpoint.
 [source]
 --
-GET https://oauth.izettle.com/users/me
+GET https://oauth.zettle.com/users/self
 --
 Example response
 [source,json]
@@ -95,6 +103,13 @@ Example response
     "organizationUuid": "ab305d54-75b4-431b-adb2-eb6b9e546013"
 }
 
+--
+After fetching the organization UUID, you can specify it in an endpoint.
+
+Example request
+[source]
+--
+GET /organizations/ab305d54-75b4-431b-adb2-eb6b9e546013/accounts/{accountTypeGroup}/balance
 --
 
 For more information on the filter and the endpoint, see xref:/authorization.md[OAuth].

finance-api/api-reference.md

@@ -48,7 +48,7 @@ See example [Fetch current balance for a liquid account](#fetch-current-balance-
 
 |Name |Type |In |Required/Optional |Description
 |:---- |:---- |:---- |:---- |:----
-|organizationUuid |string |path |required |Unique identifier for your organisation. You can specify the value with one of the following: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
+|organizationUuid |string |path |required |Unique identifier for your organisation. You can specify the value with one of the following: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
 |accountTypeGroup |string |path |required |The type of a merchant's Zettle account. You can use one of the following account types: <br/><ul><li> `PRELIMINARY` account where transactions are to be confirmed.</li><li> `LIQUID` account where transactions are to be paid out to the merchant.</li></ul>
 |at |string |query |optional |Used to fetch account balance that is available at a UTC time. If it's used, any transaction after that point will be ignored. If it's not used, the balance of all transactions at the current point of time is returned. <br/>You can specify a UTC time in one of the following formats: <br/><ul><li>`YYYY-MM` to specify a month. By default, it specifies the first second of the first day in the month. For example, for `2020-11`, the time will be `2020-11-01T00:00:00`.</li><li>`YYYY-MM-DD` to specify a date. For example, `2020-11-29`.</li><li>`YYYY-MM-DDThh:mm:ss` to specify a time. For example, `2020-11-29T03:10:02`.</li></ul>
 </details>
@@ -93,7 +93,7 @@ See example [Fetch transactions for a liquid account](#fetch-transactions-for-a-
 
 |Name |Type |In |Required/Optional |Description
 |:---- |:---- |:---- |:---- |:----
-|organizationUuid |string |path |required |Unique identifier for your organisation. You can specify the value with one of the following: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
+|organizationUuid |string |path |required |Unique identifier for your organisation. You can specify the value with one of the following: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
 |accountTypeGroup |string |path |required |The type of a merchant's Zettle account. You can use one of the following account types: <br/><ul><li> `PRELIMINARY` account where transactions are to be confirmed.</li><li> `LIQUID` account where transactions are to be paid out to the merchant.</li></ul>
 |start |string |query |required |A start time in UTC (inclusive) from when the transactions will be fetched. You can specify a UTC time in one of the following formats: <br/><ul><li>`YYYY-MM` to specify a month. By default, it specifies the first second of the first day in the month. For example, for `2020-11`, the time will be `2020-11-01T00:00:00`.</li><li>`YYYY-MM-DD` to specify a date. For example, `2020-11-29`.</li><li>`YYYY-MM-DDThh:mm:ss` to specify a time. For example, `2020-11-29T03:10:02`.</li></ul>
 |end |string |query |required |An end time in UTC (exclusive) before when the transactions will be fetched. You can specify a UTC time in one of the following formats: <br/><ul><li>`YYYY-MM` to specify a month. By default, it specifies the first second of the first day in the month. For example, for `2020-11`, the time will be `2020-11-01T00:00:00`.</li><li>`YYYY-MM-DD` to specify a date. For example, `2020-11-29`.</li><li>`YYYY-MM-DDThh:mm:ss` to specify a time. For example, `2020-11-29T03:10:02`.</li></ul>
@@ -177,7 +177,7 @@ See example [Fetch payout information on a specific period](#fetch-payout-inform
 
 |Name |Type |In |Required/Optional |Description
 |:---- |:---- |:---- |:---- |:----
-|organizationUuid |string |path |required |Unique identifier for your organisation. You can specify the value with one of the following: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
+|organizationUuid |string |path |required |Unique identifier for your organisation. You can specify the value with one of the following: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
 |at |string |query |optional |Used to fetch payouts at a certain point in UTC time. If it's used, any transaction after that time will be ignored. If it's not used, the balance of all transactions at the current point of time is returned. <br/>You can specify a UTC time in one of the following formats: <br/><ul><li>`YYYY-MM` to specify a month. For example, `2020-11`. By default, it specifies the first second of the first day in the month.</li><li>`YYYY-MM-DD` to specify a date. For example, `2020-11-29`.</li><li>`YYYY-MM-DDThh:mm:ss` to specify a time. For example, `2020-11-29T03:10:02`.</li></ul>
 </details>
 

pusher-api/api-reference.md

@@ -71,7 +71,7 @@ See example [Create a webhook subscription](#create-a-webhook-subscription).
 
 |Name |Type |In |Required/Optional |Description
 |---- |---- |---- |---- |----
-|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
+|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li>Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
 |uuid |string |query |required | Unique identifier for the subscription as UUID version 1.
 |transportName |string |query |required | The message option used by Pusher API. Currently only `WEBHOOK` is supported. 
 |eventNames |array |query |required | Event names for events that you want to create subscription for. The events are specified in an array. <br/>If you pass an empty array, you will subscribe to all events that the Pusher API supports. In this case, make sure that you have all the corresponding authorization scopes issued. See [the list of scopes](#supported-events).
@@ -127,7 +127,7 @@ See example [Get webhook subscriptions](#get-webhook-subscriptions).
 
 |Name |Type |In |Required/Optional |Description
 |---- |---- |---- |---- |----
-|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li> Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul>  
+|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li> Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul>  
 </details>
 
 
@@ -178,7 +178,7 @@ See example [Update a webhook subscription](#update-a-webhook-subscription).
 
 |Name |Type |In |Required/Optional |Description
 |---- |---- |---- |---- |----
-|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li> Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
+|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li> Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
 |subscriptionUuid |string |path |required |Unique identifier for an existing subscription as UUID version 1.
 |transportName |string |query |optional | The message option used by the Pusher API. E.g. `WEBHOOK`. You need to specify the same option that you used while creating the subscription.
 |eventNames |array |query |optional | Events that you want to update on the existing subscription. The events are specified in an array.
@@ -225,7 +225,7 @@ See example [Delete a webhook subscription](#delete-a-webhook-subscription).
 
 |Name |Type |In |Required/Optional |Description
 |---- |---- |---- |---- |----
-|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li> Get it by using the `users/me` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
+|organizationUuid |string |path |required |Unique identifier for your organization. You can use following options to fill in this value: <br/><ul><li>Use `self` as the value. This will retrieve your organizationUuid from the authentication token in the request.</li><li> Get it by using the `users/self` endpoint of OAuth2 API. For more information, see [OAuth2 API](../authorization.md).</li></ul> 
 |subscriptionUuid |string |path |required |Unique identifier for an existing subscription as UUID version 1.
 </details>