Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: sync SDK to OpenAPI doc v2.12.0 #118

Merged
merged 1 commit into from
Sep 23, 2024
+617 −3
Merged

feat: sync SDK to OpenAPI doc v2.12.0 #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion OPENAPI_VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.11.1
2.12.0
188 changes: 187 additions & 1 deletion sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
}
],
"info": {
"version": "2.11.1",
"version": "2.12.0",
"title": "All Circle APIs",
"description": "Circle's General, Core Functionality, Payments, Payouts, Accounts, and Crypto Payments APIs bundled into one OpenAPI Specification."
},
Expand Down Expand Up @@ -5882,6 +5882,108 @@
}
}
},
"/v1/fees/redemption/net/dailyReports": {
"get": {
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"name": "minimumFeeAmount",
"description": "Filters out NET burn daily fee calculations below minimumFeeAmount value.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"example": "3.14"
}
},
{
"$ref": "#/components/parameters/Currency"
},
{
"$ref": "#/components/parameters/From"
},
{
"$ref": "#/components/parameters/To"
},
{
"$ref": "#/components/parameters/PageBefore"
},
{
"$ref": "#/components/parameters/PageAfter"
},
{
"$ref": "#/components/parameters/PageSize"
}
],
"summary": "List all NET burn daily fee calculations",
"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.",
"operationId": "listNetBurnFeeDailyCalculations",
"tags": ["Payouts"],
"responses": {
"200": {
"description": "Successfully retrieved a list of NET burn fee calculations.",
"headers": {
"X-Request-Id": {
"$ref": "#/components/headers/XRequestId"
}
},
"content": {
"application/json": {
"schema": {
"title": "ListBurnFeeCalculationsResponse",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RedemptionFeeCalculation"
}
}
}
},
"examples": {
"response": {
"value": {
"data": [
{
"id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
"fee": {
"amount": "3.14",
"currency": "USD"
},
"cumulatedPayoutAmount": {
"amount": "64.54",
"currency": "USD"
},
"cumulatedPaymentAmount": {
"amount": "34.54",
"currency": "USD"
},
"cumulatedNetAmount": {
"amount": "30.00",
"currency": "USD"
},
"valueDate": "2023-05-23",
"status": "paid",
"thresholdResetTimestamp": "2023-05-23T23:59:59.999Z",
"createDate": "2024-04-10T02:13:30.000Z"
}
]
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/NotAuthorized"
}
}
}
},
"/v1/wallets": {
"post": {
"security": [
Expand Down Expand Up @@ -8876,6 +8978,7 @@
"name",
"accountNumber",
"ispb",
"branchCode",
"taxId",
"accountType"
],
Expand Down Expand Up @@ -11455,6 +11558,89 @@
}
}
},
"BurnFeePayoutAmount": {
"type": "object",
"required": ["amount", "currency"],
"properties": {
"amount": {
"description": "Sum of all initiated payouts, in units of the currency, with a `.`.",
"type": "string",
"example": "3.14"
},
"currency": {
"$ref": "#/components/schemas/FiatCurrency"
}
}
},
"BurnFeePaymentAmount": {
"type": "object",
"required": ["amount", "currency"],
"properties": {
"amount": {
"description": "Sum of all push payments received, in units of the currency, with a `.`.",
"type": "string",
"example": "3.14"
},
"currency": {
"$ref": "#/components/schemas/FiatCurrency"
}
}
},
"BurnFeeNetAmount": {
"type": "object",
"required": ["amount", "currency"],
"properties": {
"amount": {
"description": "Sum of all initiated payouts minus sum of all received push payments, in units of the currency, with a `.`.",
"type": "string",
"example": "3.14"
},
"currency": {
"$ref": "#/components/schemas/FiatCurrency"
}
}
},
"RedemptionFeeCalculation": {
"type": "object",
"description": "A NET burn fee calculation for a day.",
"properties": {
"id": {
"$ref": "#/components/schemas/Id"
},
"fee": {
"$ref": "#/components/schemas/FiatMoney"
},
"cumulatedPayoutAmount": {
"$ref": "#/components/schemas/BurnFeePayoutAmount"
},
"cumulatedPaymentAmount": {
"$ref": "#/components/schemas/BurnFeePaymentAmount"
},
"cumulatedNetAmount": {
"$ref": "#/components/schemas/BurnFeeNetAmount"
},
"valueDate": {
"description": "A date representing a day for which a fee is calculated.",
"type": "string",
"example": "2023-05-23"
},
"status": {
"description": "Fee collection status",
"type": "string",
"enum": ["scheduled", "pending", "paid"]
},
"thresholdResetTimestamp": {
"description": "Fee calculation reset timestamp.",
"type": "string",
"example": "2023-05-23T23:59:59.999Z"
},
"createDate": {
"description": "The create date of the NET burn daily fee calculation.",
"type": "string",
"format": "date-time"
}
}
},
"Wallet": {
"type": "object",
"properties": {
Expand Down
5 changes: 5 additions & 0 deletions src/generated/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ models/bank-destination.ts
models/basic-chargeback-history.ts
models/basic-chargeback.ts
models/billing-details.ts
models/burn-fee-net-amount.ts
models/burn-fee-payment-amount.ts
models/burn-fee-payout-amount.ts
models/business-account-payout-destination-type.ts
models/business-deposit.ts
models/business-destination-request.ts
Expand Down Expand Up @@ -180,6 +183,7 @@ models/limit-exceeded.ts
models/list-address-book-recipients-response.ts
models/list-addresses-response.ts
models/list-balances-response.ts
models/list-burn-fee-calculations-response.ts
models/list-business-balances-response.ts
models/list-business-cbit-account-instructions-response.ts
models/list-business-cbit-accounts-response.ts
Expand Down Expand Up @@ -245,6 +249,7 @@ models/presign-response-typed-data.ts
models/presign-response.ts
models/public-key.ts
models/rate.ts
models/redemption-fee-calculation.ts
models/refund-creation-request.ts
models/refund-payment-response.ts
models/required-action.ts
Expand Down
Loading