From c8360fe4388fd9746b3d321dfe30cfb4359594d4 Mon Sep 17 00:00:00 2001 From: circle-github-action-bot Date: Mon, 11 Mar 2024 17:10:03 +0000 Subject: [PATCH] Update OpenAPI docs to v2.8.0 --- CHANGELOG.md | 7 ++++++ VERSION | 2 +- openapi/json/account.json | 40 ++++++++++++++++++++++++++++++++++- openapi/json/accounts.json | 2 +- openapi/json/circle-apis.json | 40 ++++++++++++++++++++++++++++++++++- openapi/json/general.json | 2 +- openapi/json/payments.json | 2 +- openapi/json/payouts.json | 2 +- openapi/yaml/account.yaml | 24 ++++++++++++++++++++- openapi/yaml/accounts.yaml | 2 +- openapi/yaml/circle-apis.yaml | 24 ++++++++++++++++++++- openapi/yaml/general.yaml | 2 +- openapi/yaml/payments.yaml | 2 +- openapi/yaml/payouts.yaml | 2 +- 14 files changed, 140 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d4c7150..ca38780 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [2.8.0](https://github.com/circlefin/openapi-internal/compare/v2.7.1...v2.8.0) (2024-03-11) + + +### New Features + +* add business address recipient delete API + ## [2.7.1](https://github.com/circlefin/openapi-internal/compare/v2.7.0...v2.7.1) (2024-02-22) diff --git a/VERSION b/VERSION index 860487c..834f262 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.7.1 +2.8.0 diff --git a/openapi/json/account.json b/openapi/json/account.json index bd875af..47a4adc 100644 --- a/openapi/json/account.json +++ b/openapi/json/account.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.7.1", + "version": "2.8.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" }, @@ -1637,6 +1637,44 @@ } } }, + "/v1/businessAccount/wallets/addresses/recipient/{id}": { + "delete": { + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" + } + ], + "summary": "Delete a recipient address", + "operationId": "deleteBusinessRecipientAddress", + "tags": [ + "Addresses" + ], + "responses": { + "200": { + "headers": { + "X-Request-Id": { + "$ref": "#/components/headers/XRequestId" + } + }, + "description": "Successfully removed the recipient address." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + } + }, "/v1/businessAccount/deposits": { "get": { "security": [ diff --git a/openapi/json/accounts.json b/openapi/json/accounts.json index 5481592..479e644 100644 --- a/openapi/json/accounts.json +++ b/openapi/json/accounts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.7.1", + "version": "2.8.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 index 8dd5ecc..b4f91ea 100644 --- a/openapi/json/circle-apis.json +++ b/openapi/json/circle-apis.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.7.1", + "version": "2.8.0", "title": "All Circle APIs", "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, @@ -1874,6 +1874,44 @@ } } }, + "/v1/businessAccount/wallets/addresses/recipient/{id}": { + "delete": { + "security": [ + { + "bearerAuth": [] + } + ], + "parameters": [ + { + "$ref": "#/components/parameters/IdPath" + } + ], + "summary": "Delete a recipient address", + "operationId": "deleteBusinessRecipientAddress", + "tags": [ + "Addresses" + ], + "responses": { + "200": { + "headers": { + "X-Request-Id": { + "$ref": "#/components/headers/XRequestId" + } + }, + "description": "Successfully removed the recipient address." + }, + "400": { + "$ref": "#/components/responses/BadRequest" + }, + "401": { + "$ref": "#/components/responses/NotAuthorized" + }, + "404": { + "$ref": "#/components/responses/NotFound" + } + } + } + }, "/v1/businessAccount/deposits": { "get": { "security": [ diff --git a/openapi/json/general.json b/openapi/json/general.json index 2d5b181..55e28f7 100644 --- a/openapi/json/general.json +++ b/openapi/json/general.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.7.1", + "version": "2.8.0", "title": "API Overview", "description": "Common endpoints shared across all Circle APIs." }, diff --git a/openapi/json/payments.json b/openapi/json/payments.json index 2021e78..0935c46 100644 --- a/openapi/json/payments.json +++ b/openapi/json/payments.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.7.1", + "version": "2.8.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 index 36dd47f..35c361e 100644 --- a/openapi/json/payouts.json +++ b/openapi/json/payouts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "2.7.1", + "version": "2.8.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 index 56429e0..3f85425 100644 --- 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.7.1 + version: 2.8.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. @@ -1062,6 +1062,28 @@ paths: description: My USDC address at a cryptocurrency exchange '401': $ref: '#/components/responses/NotAuthorized' + /v1/businessAccount/wallets/addresses/recipient/{id}: + delete: + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/IdPath' + summary: Delete a recipient address + operationId: deleteBusinessRecipientAddress + tags: + - Addresses + responses: + '200': + headers: + X-Request-Id: + $ref: '#/components/headers/XRequestId' + description: Successfully removed the recipient address. + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthorized' + '404': + $ref: '#/components/responses/NotFound' /v1/businessAccount/deposits: get: security: diff --git a/openapi/yaml/accounts.yaml b/openapi/yaml/accounts.yaml index 7e1e9e7..a623d7b 100644 --- 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.7.1 + version: 2.8.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 index ed5fba0..516c087 100644 --- 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.7.1 + version: 2.8.0 title: All Circle APIs description: Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification. @@ -1195,6 +1195,28 @@ paths: description: My USDC address at a cryptocurrency exchange '401': $ref: '#/components/responses/NotAuthorized' + /v1/businessAccount/wallets/addresses/recipient/{id}: + delete: + security: + - bearerAuth: [] + parameters: + - $ref: '#/components/parameters/IdPath' + summary: Delete a recipient address + operationId: deleteBusinessRecipientAddress + tags: + - Addresses + responses: + '200': + headers: + X-Request-Id: + $ref: '#/components/headers/XRequestId' + description: Successfully removed the recipient address. + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/NotAuthorized' + '404': + $ref: '#/components/responses/NotFound' /v1/businessAccount/deposits: get: security: diff --git a/openapi/yaml/general.yaml b/openapi/yaml/general.yaml index 8f43f85..d351085 100644 --- 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.7.1 + version: 2.8.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 index 400b773..3efc3ef 100644 --- 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.7.1 + version: 2.8.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 index 99d55a1..de4c388 100644 --- 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.7.1 + version: 2.8.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.