Update OpenAPI docs to v2.9.0

circlefin · Mar 28, 2024 · bd686d8 · bd686d8
1 parent c8360fe
commit bd686d8
Show file tree

Hide file tree

Showing 14 changed files with 76 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## [2.9.0](https://github.com/circlefin/openapi-internal/compare/v2.8.0...v2.9.0) (2024-03-28)
+
+
+### New Features
+
+* add status property to GET /recipient API endpoint 
+
 ## [2.8.0](https://github.com/circlefin/openapi-internal/compare/v2.7.1...v2.8.0) (2024-03-11)
 
 

diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.8.0
+2.9.0
diff --git a/openapi/json/account.json b/openapi/json/account.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.8.0",
+    "version": "2.9.0",
     "title": "Core Functionality",
     "description": "All of Circle's APIs share a common set of core functionality that lets you manage your Circle Account in a programmatic way.\n\nWith a Circle Account your business can deposit traditional money from 80+ countries and seamlessly convert them into \"digital currency dollars\": USDC. You can then use USDC for everyday payments and treasury flows.\n"
   },
@@ -1546,7 +1546,8 @@
                         "addressTag": "123456789",
                         "chain": "ALGO",
                         "currency": "USD",
-                        "description": "My USDC address at a cryptocurrency exchange"
+                        "description": "My USDC address at a cryptocurrency exchange",
+                        "status": "active"
                       }
                     }
                   }
@@ -1586,7 +1587,7 @@
           }
         ],
         "summary": "List all recipient addresses",
-        "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response.\n",
+        "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response.\n",
         "operationId": "listBusinessRecipientAddresses",
         "tags": [
           "Addresses"
@@ -1622,7 +1623,8 @@
                           "addressTag": "123456789",
                           "chain": "ALGO",
                           "currency": "USD",
-                          "description": "My USDC address at a cryptocurrency exchange"
+                          "description": "My USDC address at a cryptocurrency exchange",
+                          "status": "active"
                         }
                       ]
                     }
@@ -1650,6 +1652,7 @@
           }
         ],
         "summary": "Delete a recipient address",
+        "description": "Deletes an external blockchain address. The recipient address must be in an 'active' or 'pending' state in order to be deleted successfully.\n",
         "operationId": "deleteBusinessRecipientAddress",
         "tags": [
           "Addresses"
@@ -3150,6 +3153,14 @@
           },
           "description": {
             "$ref": "#/components/schemas/AddressDescription"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "pending_verification",
+              "verification_succeeded"
+            ]
           }
         }
       },

diff --git a/openapi/json/accounts.json b/openapi/json/accounts.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.8.0",
+    "version": "2.9.0",
     "title": "Accounts API",
     "description": "The Accounts API allows you to easily create and host digital wallets for your customers, and manage transfers of funds across accounts- whether they are within the Circle platform, or in / out of the platform via on-chain USDC, EUROC, BTC, and ETH connectivity."
   },

diff --git a/openapi/json/circle-apis.json b/openapi/json/circle-apis.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.8.0",
+    "version": "2.9.0",
     "title": "All Circle APIs",
     "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification."
   },
@@ -1783,7 +1783,8 @@
                         "addressTag": "123456789",
                         "chain": "ALGO",
                         "currency": "USD",
-                        "description": "My USDC address at a cryptocurrency exchange"
+                        "description": "My USDC address at a cryptocurrency exchange",
+                        "status": "active"
                       }
                     }
                   }
@@ -1823,7 +1824,7 @@
           }
         ],
         "summary": "List all recipient addresses",
-        "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response.\n",
+        "description": "Returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending administrator verification are not included in the response.\n",
         "operationId": "listBusinessRecipientAddresses",
         "tags": [
           "Addresses"
@@ -1859,7 +1860,8 @@
                           "addressTag": "123456789",
                           "chain": "ALGO",
                           "currency": "USD",
-                          "description": "My USDC address at a cryptocurrency exchange"
+                          "description": "My USDC address at a cryptocurrency exchange",
+                          "status": "active"
                         }
                       ]
                     }
@@ -1887,6 +1889,7 @@
           }
         ],
         "summary": "Delete a recipient address",
+        "description": "Deletes an external blockchain address. The recipient address must be in an 'active' or 'pending' state in order to be deleted successfully.\n",
         "operationId": "deleteBusinessRecipientAddress",
         "tags": [
           "Addresses"
@@ -8744,6 +8747,14 @@
           },
           "description": {
             "$ref": "#/components/schemas/AddressDescription"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "pending_verification",
+              "verification_succeeded"
+            ]
           }
         }
       },

diff --git a/openapi/json/general.json b/openapi/json/general.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.8.0",
+    "version": "2.9.0",
     "title": "API Overview",
     "description": "Common endpoints shared across all Circle APIs."
   },

diff --git a/openapi/json/payments.json b/openapi/json/payments.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.8.0",
+    "version": "2.9.0",
     "title": "Payments API",
     "description": "The Circle Payments API allows you to take payments from your end users via traditional methods such as debit & credit cards and receive settlement in USDC.\n\nThe Circle Payments API has been designed with any business or internet commerce in mind, not just crypto applications, and it's based on Circle's extensive experience processing millions of card payments since 2014.\n"
   },

diff --git a/openapi/json/payouts.json b/openapi/json/payouts.json
@@ -6,7 +6,7 @@
     }
   ],
   "info": {
-    "version": "2.8.0",
+    "version": "2.9.0",
     "title": "Payouts API",
     "description": "The Circle Payouts API allows you to programmatically make fast, global payouts to your customers, vendors, and suppliers. Make payouts on supported blockchains."
   },

diff --git a/openapi/yaml/account.yaml b/openapi/yaml/account.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.8.0
+  version: 2.9.0
   title: Core Functionality
   description: 'All of Circle''s APIs share a common set of core functionality that
     lets you manage your Circle Account in a programmatic way.
@@ -1013,6 +1013,7 @@ paths:
                       chain: ALGO
                       currency: USD
                       description: My USDC address at a cryptocurrency exchange
+                      status: active
         '400':
           $ref: '#/components/responses/BadRequest'
         '401':
@@ -1028,8 +1029,8 @@ paths:
       - $ref: '#/components/parameters/PageSize'
       summary: List all recipient addresses
       description: 'Returns a list of recipient addresses that have each been verified
-        and are eligible for transfers. Any recipient addresses pending verification
-        are not included in the response.
+        and are eligible for transfers. Any recipient addresses pending administrator
+        verification are not included in the response.
 
         '
       operationId: listBusinessRecipientAddresses
@@ -1060,6 +1061,7 @@ paths:
                       chain: ALGO
                       currency: USD
                       description: My USDC address at a cryptocurrency exchange
+                      status: active
         '401':
           $ref: '#/components/responses/NotAuthorized'
   /v1/businessAccount/wallets/addresses/recipient/{id}:
@@ -1069,6 +1071,10 @@ paths:
       parameters:
       - $ref: '#/components/parameters/IdPath'
       summary: Delete a recipient address
+      description: 'Deletes an external blockchain address. The recipient address
+        must be in an ''active'' or ''pending'' state in order to be deleted successfully.
+
+        '
       operationId: deleteBusinessRecipientAddress
       tags:
       - Addresses
@@ -2250,6 +2256,12 @@ components:
           $ref: '#/components/schemas/Currency'
         description:
           $ref: '#/components/schemas/AddressDescription'
+        status:
+          type: string
+          enum:
+          - active
+          - pending_verification
+          - verification_succeeded
     BusinessRecipientAddressCreationRequest:
       type: object
       description: Adds a recipient address. The currency parameter will default to

diff --git a/openapi/yaml/accounts.yaml b/openapi/yaml/accounts.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.8.0
+  version: 2.9.0
   title: Accounts API
   description: The Accounts API allows you to easily create and host digital wallets
     for your customers, and manage transfers of funds across accounts- whether they

diff --git a/openapi/yaml/circle-apis.yaml b/openapi/yaml/circle-apis.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.8.0
+  version: 2.9.0
   title: All Circle APIs
   description: Circle's General, Core Functionality, Payments, Payouts, Accounts,
     and Crypto Payments APIs bundled into one OpenAPI Specification.
@@ -1146,6 +1146,7 @@ paths:
                       chain: ALGO
                       currency: USD
                       description: My USDC address at a cryptocurrency exchange
+                      status: active
         '400':
           $ref: '#/components/responses/BadRequest'
         '401':
@@ -1161,8 +1162,8 @@ paths:
       - $ref: '#/components/parameters/PageSize'
       summary: List all recipient addresses
       description: 'Returns a list of recipient addresses that have each been verified
-        and are eligible for transfers. Any recipient addresses pending verification
-        are not included in the response.
+        and are eligible for transfers. Any recipient addresses pending administrator
+        verification are not included in the response.
 
         '
       operationId: listBusinessRecipientAddresses
@@ -1193,6 +1194,7 @@ paths:
                       chain: ALGO
                       currency: USD
                       description: My USDC address at a cryptocurrency exchange
+                      status: active
         '401':
           $ref: '#/components/responses/NotAuthorized'
   /v1/businessAccount/wallets/addresses/recipient/{id}:
@@ -1202,6 +1204,10 @@ paths:
       parameters:
       - $ref: '#/components/parameters/IdPath'
       summary: Delete a recipient address
+      description: 'Deletes an external blockchain address. The recipient address
+        must be in an ''active'' or ''pending'' state in order to be deleted successfully.
+
+        '
       operationId: deleteBusinessRecipientAddress
       tags:
       - Addresses
@@ -5969,6 +5975,12 @@ components:
           $ref: '#/components/schemas/Currency'
         description:
           $ref: '#/components/schemas/AddressDescription'
+        status:
+          type: string
+          enum:
+          - active
+          - pending_verification
+          - verification_succeeded
     BusinessRecipientAddressCreationRequest:
       type: object
       description: Adds a recipient address. The currency parameter will default to

diff --git a/openapi/yaml/general.yaml b/openapi/yaml/general.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.8.0
+  version: 2.9.0
   title: API Overview
   description: Common endpoints shared across all Circle APIs.
 tags:

diff --git a/openapi/yaml/payments.yaml b/openapi/yaml/payments.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.8.0
+  version: 2.9.0
   title: Payments API
   description: 'The Circle Payments API allows you to take payments from your end
     users via traditional methods such as debit & credit cards and receive settlement

diff --git a/openapi/yaml/payouts.yaml b/openapi/yaml/payouts.yaml
@@ -2,7 +2,7 @@ openapi: 3.0.2
 servers:
 - url: https://api-sandbox.circle.com
 info:
-  version: 2.8.0
+  version: 2.9.0
   title: Payouts API
   description: The Circle Payouts API allows you to programmatically make fast, global
     payouts to your customers, vendors, and suppliers. Make payouts on supported blockchains.