spec release

Adyen · Jan 6, 2025 · 832321c · 832321c
1 parent 6d9b334
commit 832321c
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 15 deletions.
diff --git a/json/TfmAPIService-v1.json b/json/TfmAPIService-v1.json
@@ -9,7 +9,7 @@
       "version" : "1",
       "x-publicVersion" : true,
       "title" : "POS Terminal Management API",
-      "description" : "This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.\n\nFor more information, refer to [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).\n\n>We will deprecate POS Terminal Management API on January 1, 2025 and stop support on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).\n\n## Authentication\nEach request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_API_key\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Roles and permissions\nTo use the POS Terminal Management API, you need the **POS Terminal Management API role** added to your API credential. Your Adyen contact will set up the roles for you.\n## Versioning\nTerminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount\n```\nWhen using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`.\nIf you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`.\n## Going live\nTo access the live endpoints, you need an API key from your live Customer Area.\nUse this API key to make requests to:\n\n```text\nhttps://postfmapi-live.adyen.com/postfmapi/terminal/v1\n```\n\n",
+      "description" : "This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store.\n\nFor more information, refer to [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).\n\n>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).\n\n## Authentication\nEach request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_API_key\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Roles and permissions\nTo use the POS Terminal Management API, you need the **POS Terminal Management API role** added to your API credential. Your Adyen contact will set up the roles for you.\n## Versioning\nTerminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount\n```\nWhen using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`.\nIf you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`.\n## Going live\nTo access the live endpoints, you need an API key from your live Customer Area.\nUse this API key to make requests to:\n\n```text\nhttps://postfmapi-live.adyen.com/postfmapi/terminal/v1\n```\n\n",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",
@@ -28,7 +28,10 @@
                "General"
             ],
             "summary" : "Assign terminals",
-            "description" : "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.",
+            "description" : "Assigns one or more payment terminals to a merchant account or a store. You can also use this endpoint to reassign terminals between merchant accounts or stores, and to unassign a terminal and return it to company inventory.\n\n>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
+            "deprecated" : true,
+            "x-deprecatedInVersion" : "1",
+            "x-deprecatedMessage" : "Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
             "operationId" : "post-assignTerminals",
             "x-sortIndex" : 1,
             "x-methodName" : "assignTerminals",
@@ -163,7 +166,10 @@
                "General"
             ],
             "summary" : "Get the account or store of a terminal",
-            "description" : "Returns the company account, merchant account, or store that a payment terminal is assigned to.",
+            "description" : "Returns the company account, merchant account, or store that a payment terminal is assigned to.\n\n>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
+            "deprecated" : true,
+            "x-deprecatedInVersion" : "1",
+            "x-deprecatedMessage" : "Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
             "operationId" : "post-findTerminal",
             "x-sortIndex" : 1,
             "x-methodName" : "findTerminal",
@@ -286,7 +292,10 @@
                "General"
             ],
             "summary" : "Get the stores of an account",
-            "description" : "Returns a list of stores associated with a company account or a merchant account, including the status of each store.",
+            "description" : "Returns a list of stores associated with a company account or a merchant account, including the status of each store.\n\n>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
+            "deprecated" : true,
+            "x-deprecatedInVersion" : "1",
+            "x-deprecatedMessage" : "Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
             "operationId" : "post-getStoresUnderAccount",
             "x-sortIndex" : 1,
             "x-methodName" : "getStoresUnderAccount",
@@ -415,7 +424,10 @@
                "General"
             ],
             "summary" : "Get the details of a terminal",
-            "description" : "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.",
+            "description" : "Returns the details of a payment terminal, including where the terminal is assigned to. The response returns the same details that are provided in the terminal list in your Customer Area and in the Terminal Fleet report.\n\n>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
+            "deprecated" : true,
+            "x-deprecatedInVersion" : "1",
+            "x-deprecatedMessage" : "Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
             "operationId" : "post-getTerminalDetails",
             "x-sortIndex" : 1,
             "x-methodName" : "getTerminalDetails",
@@ -538,7 +550,10 @@
                "General"
             ],
             "summary" : "Get the list of terminals",
-            "description" : "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).",
+            "description" : "Returns a list of payment terminals associated with a company account, merchant account, or store. The response shows whether the terminals are in the inventory, or in-store (ready for boarding or already boarded).\n\n>From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
+            "deprecated" : true,
+            "x-deprecatedInVersion" : "1",
+            "x-deprecatedMessage" : "Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).",
             "operationId" : "post-getTerminalsUnderAccount",
             "x-sortIndex" : 1,
             "x-methodName" : "getTerminalsUnderAccount",

diff --git a/yaml/TfmAPIService-v1.yaml b/yaml/TfmAPIService-v1.yaml
@@ -14,7 +14,7 @@ info:
     For more information, refer to [Classic assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api/classic-assign-terminals-api/).
 
 
-    >We will deprecate POS Terminal Management API on January 1, 2025 and stop support
+    >From January 1, 2025 POS Terminal Management API is deprecated and support stops
     on April 1, 2025. To automate the management of your terminal fleet, use our [Management
     API](https://docs.adyen.com/api-explorer/Management/latest/overview).
 
@@ -97,9 +97,17 @@ paths:
       tags:
       - General
       summary: Assign terminals
-      description: Assigns one or more payment terminals to a merchant account or
+      description: 'Assigns one or more payment terminals to a merchant account or
         a store. You can also use this endpoint to reassign terminals between merchant
         accounts or stores, and to unassign a terminal and return it to company inventory.
+
+
+        >From January 1, 2025 POS Terminal Management API is deprecated and support
+        stops on April 1, 2025. To automate the management of your terminal fleet,
+        use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).'
+      deprecated: true
+      x-deprecatedInVersion: '1'
+      x-deprecatedMessage: Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).
       operationId: post-assignTerminals
       x-sortIndex: 1
       x-methodName: assignTerminals
@@ -179,8 +187,16 @@ paths:
       tags:
       - General
       summary: Get the account or store of a terminal
-      description: Returns the company account, merchant account, or store that a
+      description: 'Returns the company account, merchant account, or store that a
         payment terminal is assigned to.
+
+
+        >From January 1, 2025 POS Terminal Management API is deprecated and support
+        stops on April 1, 2025. To automate the management of your terminal fleet,
+        use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).'
+      deprecated: true
+      x-deprecatedInVersion: '1'
+      x-deprecatedMessage: Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).
       operationId: post-findTerminal
       x-sortIndex: 1
       x-methodName: findTerminal
@@ -252,8 +268,16 @@ paths:
       tags:
       - General
       summary: Get the stores of an account
-      description: Returns a list of stores associated with a company account or a
-        merchant account, including the status of each store.
+      description: 'Returns a list of stores associated with a company account or
+        a merchant account, including the status of each store.
+
+
+        >From January 1, 2025 POS Terminal Management API is deprecated and support
+        stops on April 1, 2025. To automate the management of your terminal fleet,
+        use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).'
+      deprecated: true
+      x-deprecatedInVersion: '1'
+      x-deprecatedMessage: Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).
       operationId: post-getStoresUnderAccount
       x-sortIndex: 1
       x-methodName: getStoresUnderAccount
@@ -329,9 +353,17 @@ paths:
       tags:
       - General
       summary: Get the details of a terminal
-      description: Returns the details of a payment terminal, including where the
+      description: 'Returns the details of a payment terminal, including where the
         terminal is assigned to. The response returns the same details that are provided
         in the terminal list in your Customer Area and in the Terminal Fleet report.
+
+
+        >From January 1, 2025 POS Terminal Management API is deprecated and support
+        stops on April 1, 2025. To automate the management of your terminal fleet,
+        use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).'
+      deprecated: true
+      x-deprecatedInVersion: '1'
+      x-deprecatedMessage: Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).
       operationId: post-getTerminalDetails
       x-sortIndex: 1
       x-methodName: getTerminalDetails
@@ -403,9 +435,17 @@ paths:
       tags:
       - General
       summary: Get the list of terminals
-      description: Returns a list of payment terminals associated with a company account,
-        merchant account, or store. The response shows whether the terminals are in
-        the inventory, or in-store (ready for boarding or already boarded).
+      description: 'Returns a list of payment terminals associated with a company
+        account, merchant account, or store. The response shows whether the terminals
+        are in the inventory, or in-store (ready for boarding or already boarded).
+
+
+        >From January 1, 2025 POS Terminal Management API is deprecated and support
+        stops on April 1, 2025. To automate the management of your terminal fleet,
+        use our [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).'
+      deprecated: true
+      x-deprecatedInVersion: '1'
+      x-deprecatedMessage: Use [Management API](https://docs.adyen.com/api-explorer/Management/latest/overview).
       operationId: post-getTerminalsUnderAccount
       x-sortIndex: 1
       x-methodName: getTerminalsUnderAccount