From 1631819a6bba51f99b8c16ba8cf69da92cd3bbee Mon Sep 17 00:00:00 2001 From: circle-github-action-bot Date: Tue, 21 Mar 2023 16:58:02 +0000 Subject: [PATCH] Update OpenAPI docs to v1.7.2 --- CHANGELOG.md | 7 ++ VERSION | 2 +- openapi/json/account.json | 2 +- openapi/json/accounts.json | 2 +- openapi/json/circle-apis.json | 150 +++++++++++++++++----------------- openapi/json/general.json | 2 +- openapi/json/payments.json | 150 +++++++++++++++++----------------- openapi/json/payouts.json | 2 +- openapi/yaml/account.yaml | 2 +- openapi/yaml/accounts.yaml | 2 +- openapi/yaml/circle-apis.yaml | 24 +++--- openapi/yaml/general.yaml | 2 +- openapi/yaml/payments.yaml | 24 +++--- openapi/yaml/payouts.yaml | 2 +- 14 files changed, 188 insertions(+), 185 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 28f3936..2a990f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [1.7.2](https://github.com/circlefin/openapi-internal/compare/v1.7.1...v1.7.2) (2023-03-21) + + +### Fixes + +* payment intents endpoints schemas + ## [1.7.1](https://github.com/circlefin/openapi-internal/compare/v1.7.0...v1.7.1) (2023-03-07) diff --git a/VERSION b/VERSION index 943f9cb..f8a696c 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.7.1 +1.7.2 diff --git a/openapi/json/account.json b/openapi/json/account.json index 2d7fe20..8568094 100644 --- a/openapi/json/account.json +++ b/openapi/json/account.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "1.7.1", + "version": "1.7.2", "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" }, diff --git a/openapi/json/accounts.json b/openapi/json/accounts.json index 402f3b2..47f6073 100644 --- a/openapi/json/accounts.json +++ b/openapi/json/accounts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "1.7.1", + "version": "1.7.2", "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 7cdf691..1f2b4a6 100644 --- a/openapi/json/circle-apis.json +++ b/openapi/json/circle-apis.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "1.7.1", + "version": "1.7.2", "title": "All Circle APIs", "description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification." }, @@ -3103,61 +3103,65 @@ "examples": { "Transient Payment Intent": { "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "settlementCurrency": "USD", - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "paymentIds": [], - "timeline": [ - { - "status": "created", - "time": "2022-07-21T20:13:35.579331Z" - } - ], - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } + "data": [ + { + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "settlementCurrency": "USD", + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "paymentIds": [], + "timeline": [ + { + "status": "created", + "time": "2022-07-21T20:13:35.579331Z" + } + ], + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" + } + ] } }, "Continuous Payment Intent": { "value": { - "data": { - "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", - "currency": "USD", - "settlementCurrency": "USD", - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "timeline": [ - { - "status": "created", - "time": "2023-01-21T20:13:35.579331Z" - } - ], - "type": "continuous", - "createDate": "2023-01-21T20:13:35.578678Z", - "updateDate": "2023-01-21T20:13:35.578678Z" - } + "data": [ + { + "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", + "currency": "USD", + "settlementCurrency": "USD", + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "timeline": [ + { + "status": "created", + "time": "2023-01-21T20:13:35.579331Z" + } + ], + "type": "continuous", + "createDate": "2023-01-21T20:13:35.578678Z", + "updateDate": "2023-01-21T20:13:35.578678Z" + } + ] } } } @@ -3201,17 +3205,14 @@ "title": "GetPaymentIntentResponse", "properties": { "data": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, @@ -3328,17 +3329,14 @@ "title": "ExpirePaymentIntentResponse", "properties": { "data": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, @@ -10757,7 +10755,9 @@ "description": "Currency code.", "type": "string", "enum": [ - "USD" + "USD", + "BTC", + "ETH" ] } } diff --git a/openapi/json/general.json b/openapi/json/general.json index 3aefb4b..fc425a0 100644 --- a/openapi/json/general.json +++ b/openapi/json/general.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "1.7.1", + "version": "1.7.2", "title": "API Overview", "description": "Common endpoints shared across all Circle APIs." }, diff --git a/openapi/json/payments.json b/openapi/json/payments.json index ab75566..a83faa9 100644 --- a/openapi/json/payments.json +++ b/openapi/json/payments.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "1.7.1", + "version": "1.7.2", "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, bank accounts (wires and ACH), etc., 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" }, @@ -1886,61 +1886,65 @@ "examples": { "Transient Payment Intent": { "value": { - "data": { - "id": "8755d0ea-14f9-4259-b092-de23c14b6568", - "amount": { - "amount": "3.14", - "currency": "USD" - }, - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "settlementCurrency": "USD", - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "paymentIds": [], - "timeline": [ - { - "status": "created", - "time": "2022-07-21T20:13:35.579331Z" - } - ], - "createDate": "2022-07-21T20:13:35.578678Z", - "updateDate": "2022-07-21T20:19:24.859052Z" - } + "data": [ + { + "id": "8755d0ea-14f9-4259-b092-de23c14b6568", + "amount": { + "amount": "3.14", + "currency": "USD" + }, + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "settlementCurrency": "USD", + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "paymentIds": [], + "timeline": [ + { + "status": "created", + "time": "2022-07-21T20:13:35.579331Z" + } + ], + "createDate": "2022-07-21T20:13:35.578678Z", + "updateDate": "2022-07-21T20:19:24.859052Z" + } + ] } }, "Continuous Payment Intent": { "value": { - "data": { - "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", - "currency": "USD", - "settlementCurrency": "USD", - "amountPaid": { - "amount": "0.00", - "currency": "USD" - }, - "paymentMethods": [ - { - "type": "blockchain", - "chain": "ETH" - } - ], - "timeline": [ - { - "status": "created", - "time": "2023-01-21T20:13:35.579331Z" - } - ], - "type": "continuous", - "createDate": "2023-01-21T20:13:35.578678Z", - "updateDate": "2023-01-21T20:13:35.578678Z" - } + "data": [ + { + "id": "e2e90ba3-9d1f-490d-9460-24ac6eb55a1b", + "currency": "USD", + "settlementCurrency": "USD", + "amountPaid": { + "amount": "0.00", + "currency": "USD" + }, + "paymentMethods": [ + { + "type": "blockchain", + "chain": "ETH" + } + ], + "timeline": [ + { + "status": "created", + "time": "2023-01-21T20:13:35.579331Z" + } + ], + "type": "continuous", + "createDate": "2023-01-21T20:13:35.578678Z", + "updateDate": "2023-01-21T20:13:35.578678Z" + } + ] } } } @@ -1984,17 +1988,14 @@ "title": "GetPaymentIntentResponse", "properties": { "data": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, @@ -2111,17 +2112,14 @@ "title": "ExpirePaymentIntentResponse", "properties": { "data": { - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/PaymentIntent" - }, - { - "$ref": "#/components/schemas/ContinuousPaymentIntent" - } - ] - } + "anyOf": [ + { + "$ref": "#/components/schemas/PaymentIntent" + }, + { + "$ref": "#/components/schemas/ContinuousPaymentIntent" + } + ] } } }, @@ -6291,7 +6289,9 @@ "description": "Currency code.", "type": "string", "enum": [ - "USD" + "USD", + "BTC", + "ETH" ] } } diff --git a/openapi/json/payouts.json b/openapi/json/payouts.json index 4147390..36bbccd 100644 --- a/openapi/json/payouts.json +++ b/openapi/json/payouts.json @@ -6,7 +6,7 @@ } ], "info": { - "version": "1.7.1", + "version": "1.7.2", "title": "Payouts API", "description": "The Circle Payouts API allows you to programmatically make fast, global payouts to your customers, vendors, and suppliers. Use traditional methods like bank wires and ACH, or make payouts on supported blockchains." }, diff --git a/openapi/yaml/account.yaml b/openapi/yaml/account.yaml index 2d9bbd9..2533636 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: 1.7.1 + version: 1.7.2 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. diff --git a/openapi/yaml/accounts.yaml b/openapi/yaml/accounts.yaml index 1e24795..c30ebb9 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: 1.7.1 + version: 1.7.2 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 3148a61..0b554dc 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: 1.7.1 + version: 1.7.2 title: All Circle APIs description: Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification. @@ -1984,7 +1984,7 @@ paths: Transient Payment Intent: value: data: - id: 8755d0ea-14f9-4259-b092-de23c14b6568 + - id: 8755d0ea-14f9-4259-b092-de23c14b6568 amount: amount: '3.14' currency: USD @@ -2004,7 +2004,7 @@ paths: Continuous Payment Intent: value: data: - id: e2e90ba3-9d1f-490d-9460-24ac6eb55a1b + - id: e2e90ba3-9d1f-490d-9460-24ac6eb55a1b currency: USD settlementCurrency: USD amountPaid: @@ -2043,11 +2043,9 @@ paths: title: GetPaymentIntentResponse properties: data: - type: array - items: - anyOf: - - $ref: '#/components/schemas/PaymentIntent' - - $ref: '#/components/schemas/ContinuousPaymentIntent' + anyOf: + - $ref: '#/components/schemas/PaymentIntent' + - $ref: '#/components/schemas/ContinuousPaymentIntent' examples: Transient Payment Intent: value: @@ -2118,11 +2116,9 @@ paths: title: ExpirePaymentIntentResponse properties: data: - type: array - items: - anyOf: - - $ref: '#/components/schemas/PaymentIntent' - - $ref: '#/components/schemas/ContinuousPaymentIntent' + anyOf: + - $ref: '#/components/schemas/PaymentIntent' + - $ref: '#/components/schemas/ContinuousPaymentIntent' examples: Transient Payment Intent: value: @@ -7340,6 +7336,8 @@ components: type: string enum: - USD + - BTC + - ETH Timeline: type: object required: diff --git a/openapi/yaml/general.yaml b/openapi/yaml/general.yaml index c020517..7220186 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: 1.7.1 + version: 1.7.2 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 b32f7f0..16b8e3f 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: 1.7.1 + version: 1.7.2 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, bank accounts (wires @@ -1316,7 +1316,7 @@ paths: Transient Payment Intent: value: data: - id: 8755d0ea-14f9-4259-b092-de23c14b6568 + - id: 8755d0ea-14f9-4259-b092-de23c14b6568 amount: amount: '3.14' currency: USD @@ -1336,7 +1336,7 @@ paths: Continuous Payment Intent: value: data: - id: e2e90ba3-9d1f-490d-9460-24ac6eb55a1b + - id: e2e90ba3-9d1f-490d-9460-24ac6eb55a1b currency: USD settlementCurrency: USD amountPaid: @@ -1375,11 +1375,9 @@ paths: title: GetPaymentIntentResponse properties: data: - type: array - items: - anyOf: - - $ref: '#/components/schemas/PaymentIntent' - - $ref: '#/components/schemas/ContinuousPaymentIntent' + anyOf: + - $ref: '#/components/schemas/PaymentIntent' + - $ref: '#/components/schemas/ContinuousPaymentIntent' examples: Transient Payment Intent: value: @@ -1450,11 +1448,9 @@ paths: title: ExpirePaymentIntentResponse properties: data: - type: array - items: - anyOf: - - $ref: '#/components/schemas/PaymentIntent' - - $ref: '#/components/schemas/ContinuousPaymentIntent' + anyOf: + - $ref: '#/components/schemas/PaymentIntent' + - $ref: '#/components/schemas/ContinuousPaymentIntent' examples: Transient Payment Intent: value: @@ -4459,6 +4455,8 @@ components: type: string enum: - USD + - BTC + - ETH Timeline: type: object required: diff --git a/openapi/yaml/payouts.yaml b/openapi/yaml/payouts.yaml index 466c512..f242e0f 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: 1.7.1 + version: 1.7.2 title: Payouts API description: The Circle Payouts API allows you to programmatically make fast, global payouts to your customers, vendors, and suppliers. Use traditional methods like