Skip to content

Commit d2dd9c1

Browse files
circle-github-action-botcircle-github-action-bot
authored
feat: sync SDK to OpenAPI doc v2.12.0 (#118)
Automated pull request triggered by OpenAPI document update. SDK Code generated using [OpenAPI generator](https://openapi-generator.tech/)
1 parent d56319f commit d2dd9c1

11 files changed

+617
-3
lines changed

‎OPENAPI_VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.11.1
1+
2.12.0

‎sdk.json‎

Lines changed: 187 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
}
77
],
88
"info": {
9-
"version": "2.11.1",
9+
"version": "2.12.0",
1010
"title": "All Circle APIs",
1111
"description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification."
1212
},
@@ -5882,6 +5882,108 @@
58825882
}
58835883
}
58845884
},
5885+
"/v1/fees/redemption/net/dailyReports": {
5886+
"get": {
5887+
"security": [
5888+
{
5889+
"bearerAuth": []
5890+
}
5891+
],
5892+
"parameters": [
5893+
{
5894+
"name": "minimumFeeAmount",
5895+
"description": "Filters out NET burn daily fee calculations below minimumFeeAmount value.",
5896+
"in": "query",
5897+
"required": false,
5898+
"schema": {
5899+
"type": "string",
5900+
"example": "3.14"
5901+
}
5902+
},
5903+
{
5904+
"$ref": "#/components/parameters/Currency"
5905+
},
5906+
{
5907+
"$ref": "#/components/parameters/From"
5908+
},
5909+
{
5910+
"$ref": "#/components/parameters/To"
5911+
},
5912+
{
5913+
"$ref": "#/components/parameters/PageBefore"
5914+
},
5915+
{
5916+
"$ref": "#/components/parameters/PageAfter"
5917+
},
5918+
{
5919+
"$ref": "#/components/parameters/PageSize"
5920+
}
5921+
],
5922+
"summary": "List all NET burn daily fee calculations",
5923+
"description": "Searches for NET burn fee daily calculations. This endpoint returns up to 50 daily fee amount calculations in descending chronological order or pageSize, if provided.",
5924+
"operationId": "listNetBurnFeeDailyCalculations",
5925+
"tags": ["Payouts"],
5926+
"responses": {
5927+
"200": {
5928+
"description": "Successfully retrieved a list of NET burn fee calculations.",
5929+
"headers": {
5930+
"X-Request-Id": {
5931+
"$ref": "#/components/headers/XRequestId"
5932+
}
5933+
},
5934+
"content": {
5935+
"application/json": {
5936+
"schema": {
5937+
"title": "ListBurnFeeCalculationsResponse",
5938+
"properties": {
5939+
"data": {
5940+
"type": "array",
5941+
"items": {
5942+
"$ref": "#/components/schemas/RedemptionFeeCalculation"
5943+
}
5944+
}
5945+
}
5946+
},
5947+
"examples": {
5948+
"response": {
5949+
"value": {
5950+
"data": [
5951+
{
5952+
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
5953+
"fee": {
5954+
"amount": "3.14",
5955+
"currency": "USD"
5956+
},
5957+
"cumulatedPayoutAmount": {
5958+
"amount": "64.54",
5959+
"currency": "USD"
5960+
},
5961+
"cumulatedPaymentAmount": {
5962+
"amount": "34.54",
5963+
"currency": "USD"
5964+
},
5965+
"cumulatedNetAmount": {
5966+
"amount": "30.00",
5967+
"currency": "USD"
5968+
},
5969+
"valueDate": "2023-05-23",
5970+
"status": "paid",
5971+
"thresholdResetTimestamp": "2023-05-23T23:59:59.999Z",
5972+
"createDate": "2024-04-10T02:13:30.000Z"
5973+
}
5974+
]
5975+
}
5976+
}
5977+
}
5978+
}
5979+
}
5980+
},
5981+
"401": {
5982+
"$ref": "#/components/responses/NotAuthorized"
5983+
}
5984+
}
5985+
}
5986+
},
58855987
"/v1/wallets": {
58865988
"post": {
58875989
"security": [
@@ -8876,6 +8978,7 @@
88768978
"name",
88778979
"accountNumber",
88788980
"ispb",
8981+
"branchCode",
88798982
"taxId",
88808983
"accountType"
88818984
],
@@ -11455,6 +11558,89 @@
1145511558
}
1145611559
}
1145711560
},
11561+
"BurnFeePayoutAmount": {
11562+
"type": "object",
11563+
"required": ["amount", "currency"],
11564+
"properties": {
11565+
"amount": {
11566+
"description": "Sum of all initiated payouts, in units of the currency, with a `.`.",
11567+
"type": "string",
11568+
"example": "3.14"
11569+
},
11570+
"currency": {
11571+
"$ref": "#/components/schemas/FiatCurrency"
11572+
}
11573+
}
11574+
},
11575+
"BurnFeePaymentAmount": {
11576+
"type": "object",
11577+
"required": ["amount", "currency"],
11578+
"properties": {
11579+
"amount": {
11580+
"description": "Sum of all push payments received, in units of the currency, with a `.`.",
11581+
"type": "string",
11582+
"example": "3.14"
11583+
},
11584+
"currency": {
11585+
"$ref": "#/components/schemas/FiatCurrency"
11586+
}
11587+
}
11588+
},
11589+
"BurnFeeNetAmount": {
11590+
"type": "object",
11591+
"required": ["amount", "currency"],
11592+
"properties": {
11593+
"amount": {
11594+
"description": "Sum of all initiated payouts minus sum of all received push payments, in units of the currency, with a `.`.",
11595+
"type": "string",
11596+
"example": "3.14"
11597+
},
11598+
"currency": {
11599+
"$ref": "#/components/schemas/FiatCurrency"
11600+
}
11601+
}
11602+
},
11603+
"RedemptionFeeCalculation": {
11604+
"type": "object",
11605+
"description": "A NET burn fee calculation for a day.",
11606+
"properties": {
11607+
"id": {
11608+
"$ref": "#/components/schemas/Id"
11609+
},
11610+
"fee": {
11611+
"$ref": "#/components/schemas/FiatMoney"
11612+
},
11613+
"cumulatedPayoutAmount": {
11614+
"$ref": "#/components/schemas/BurnFeePayoutAmount"
11615+
},
11616+
"cumulatedPaymentAmount": {
11617+
"$ref": "#/components/schemas/BurnFeePaymentAmount"
11618+
},
11619+
"cumulatedNetAmount": {
11620+
"$ref": "#/components/schemas/BurnFeeNetAmount"
11621+
},
11622+
"valueDate": {
11623+
"description": "A date representing a day for which a fee is calculated.",
11624+
"type": "string",
11625+
"example": "2023-05-23"
11626+
},
11627+
"status": {
11628+
"description": "Fee collection status",
11629+
"type": "string",
11630+
"enum": ["scheduled", "pending", "paid"]
11631+
},
11632+
"thresholdResetTimestamp": {
11633+
"description": "Fee calculation reset timestamp.",
11634+
"type": "string",
11635+
"example": "2023-05-23T23:59:59.999Z"
11636+
},
11637+
"createDate": {
11638+
"description": "The create date of the NET burn daily fee calculation.",
11639+
"type": "string",
11640+
"format": "date-time"
11641+
}
11642+
}
11643+
},
1145811644
"Wallet": {
1145911645
"type": "object",
1146011646
"properties": {

‎src/generated/.openapi-generator/FILES‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ models/bank-destination.ts
4747
models/basic-chargeback-history.ts
4848
models/basic-chargeback.ts
4949
models/billing-details.ts
50+
models/burn-fee-net-amount.ts
51+
models/burn-fee-payment-amount.ts
52+
models/burn-fee-payout-amount.ts
5053
models/business-account-payout-destination-type.ts
5154
models/business-deposit.ts
5255
models/business-destination-request.ts
@@ -180,6 +183,7 @@ models/limit-exceeded.ts
180183
models/list-address-book-recipients-response.ts
181184
models/list-addresses-response.ts
182185
models/list-balances-response.ts
186+
models/list-burn-fee-calculations-response.ts
183187
models/list-business-balances-response.ts
184188
models/list-business-cbit-account-instructions-response.ts
185189
models/list-business-cbit-accounts-response.ts
@@ -245,6 +249,7 @@ models/presign-response-typed-data.ts
245249
models/presign-response.ts
246250
models/public-key.ts
247251
models/rate.ts
252+
models/redemption-fee-calculation.ts
248253
models/refund-creation-request.ts
249254
models/refund-payment-response.ts
250255
models/required-action.ts

0 commit comments

Comments
 (0)