From e96d30dfa7bc23ad2ebd1dbd65372e859773c80c Mon Sep 17 00:00:00 2001 From: Github Actions Bot Date: Mon, 23 Sep 2024 15:51:11 +0000 Subject: [PATCH] feat: sync SDK to OpenAPI doc v2.12.0 --- OPENAPI_VERSION | 2 +- sdk.json | 188 +++++++++++++++- src/generated/.openapi-generator/FILES | 5 + src/generated/apis/payouts-api.ts | 209 ++++++++++++++++++ src/generated/models/burn-fee-net-amount.ts | 31 +++ .../models/burn-fee-payment-amount.ts | 31 +++ .../models/burn-fee-payout-amount.ts | 31 +++ src/generated/models/index.ts | 5 + .../list-burn-fee-calculations-response.ts | 25 +++ .../pix-fiat-account-creation-request.ts | 2 +- .../models/redemption-fee-calculation.ts | 91 ++++++++ 11 files changed, 617 insertions(+), 3 deletions(-) create mode 100644 src/generated/models/burn-fee-net-amount.ts create mode 100644 src/generated/models/burn-fee-payment-amount.ts create mode 100644 src/generated/models/burn-fee-payout-amount.ts create mode 100644 src/generated/models/list-burn-fee-calculations-response.ts create mode 100644 src/generated/models/redemption-fee-calculation.ts diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION index 6ceb272..d8b6989 100644 --- a/OPENAPI_VERSION +++ b/OPENAPI_VERSION @@ -1 +1 @@ -2.11.1 +2.12.0 diff --git a/sdk.json b/sdk.json index d66111c..b8c276b 100644 --- a/sdk.json +++ b/sdk.json @@ -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." }, @@ -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": [ @@ -8876,6 +8978,7 @@ "name", "accountNumber", "ispb", + "branchCode", "taxId", "accountType" ], @@ -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": { diff --git a/src/generated/.openapi-generator/FILES b/src/generated/.openapi-generator/FILES index 89bdde4..931dd4f 100644 --- a/src/generated/.openapi-generator/FILES +++ b/src/generated/.openapi-generator/FILES @@ -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 @@ -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 @@ -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 diff --git a/src/generated/apis/payouts-api.ts b/src/generated/apis/payouts-api.ts index f1b017d..304bc43 100644 --- a/src/generated/apis/payouts-api.ts +++ b/src/generated/apis/payouts-api.ts @@ -46,6 +46,8 @@ import { GetBusinessPayoutResponse } from "../models"; // @ts-ignore import { GetPayoutResponse } from "../models"; // @ts-ignore +import { ListBurnFeeCalculationsResponse } from "../models"; +// @ts-ignore import { ListBusinessPayoutsResponse } from "../models"; // @ts-ignore import { ListPayoutsResponse } from "../models"; @@ -362,6 +364,93 @@ export const PayoutsApiAxiosParamCreator = function ( options: localVarRequestOptions }; }, + /** + * 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. + * @summary List all NET burn daily fee calculations + * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [from] Queries items created since the specified date-time (inclusive). + * @param {string} [to] Queries items created before the specified date-time (inclusive). + * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. + * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. + * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listNetBurnFeeDailyCalculations: async ( + minimumFeeAmount?: string, + currency?: "USD" | "EUR", + from?: string, + to?: string, + pageBefore?: string, + pageAfter?: string, + pageSize?: number, + options: AxiosRequestConfig = {} + ): Promise => { + const localVarPath = `/v1/fees/redemption/net/dailyReports`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + + const localVarRequestOptions = { + method: "GET", + ...baseOptions, + ...options + }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication bearerAuth required + // http bearer authentication required + await setBearerAuthToObject(localVarHeaderParameter, configuration); + + if (minimumFeeAmount !== undefined) { + localVarQueryParameter["minimumFeeAmount"] = minimumFeeAmount; + } + + if (currency !== undefined) { + localVarQueryParameter["currency"] = currency; + } + + if (from !== undefined) { + localVarQueryParameter["from"] = + (from as any) instanceof Date ? (from as any).toISOString() : from; + } + + if (to !== undefined) { + localVarQueryParameter["to"] = + (to as any) instanceof Date ? (to as any).toISOString() : to; + } + + if (pageBefore !== undefined) { + localVarQueryParameter["pageBefore"] = pageBefore; + } + + if (pageAfter !== undefined) { + localVarQueryParameter["pageAfter"] = pageAfter; + } + + if (pageSize !== undefined) { + localVarQueryParameter["pageSize"] = pageSize; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = + baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions + }; + }, /** * * @summary List all payouts @@ -669,6 +758,52 @@ export const PayoutsApiFp = function (configuration?: Configuration) { configuration ); }, + /** + * 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. + * @summary List all NET burn daily fee calculations + * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [from] Queries items created since the specified date-time (inclusive). + * @param {string} [to] Queries items created before the specified date-time (inclusive). + * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. + * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. + * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listNetBurnFeeDailyCalculations( + minimumFeeAmount?: string, + currency?: "USD" | "EUR", + from?: string, + to?: string, + pageBefore?: string, + pageAfter?: string, + pageSize?: number, + options?: AxiosRequestConfig + ): Promise< + ( + axios?: AxiosInstance, + basePath?: string + ) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.listNetBurnFeeDailyCalculations( + minimumFeeAmount, + currency, + from, + to, + pageBefore, + pageAfter, + pageSize, + options + ); + return createRequestFunction( + localVarAxiosArgs, + globalAxios, + BASE_PATH, + configuration + ); + }, /** * * @summary List all payouts @@ -863,6 +998,42 @@ export const PayoutsApiFactory = function ( ) .then((request) => request(axios, basePath)); }, + /** + * 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. + * @summary List all NET burn daily fee calculations + * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [from] Queries items created since the specified date-time (inclusive). + * @param {string} [to] Queries items created before the specified date-time (inclusive). + * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. + * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. + * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listNetBurnFeeDailyCalculations( + minimumFeeAmount?: string, + currency?: "USD" | "EUR", + from?: string, + to?: string, + pageBefore?: string, + pageAfter?: string, + pageSize?: number, + options?: any + ): AxiosPromise { + return localVarFp + .listNetBurnFeeDailyCalculations( + minimumFeeAmount, + currency, + from, + to, + pageBefore, + pageAfter, + pageSize, + options + ) + .then((request) => request(axios, basePath)); + }, /** * * @summary List all payouts @@ -1051,6 +1222,44 @@ export class PayoutsApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } + /** + * 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. + * @summary List all NET burn daily fee calculations + * @param {string} [minimumFeeAmount] Filters out NET burn daily fee calculations below minimumFeeAmount value. + * @param {'USD' | 'EUR'} [currency] Queries beneficiary bank account currency. Default is USD. + * @param {string} [from] Queries items created since the specified date-time (inclusive). + * @param {string} [to] Queries items created before the specified date-time (inclusive). + * @param {string} [pageBefore] A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next `n` items before the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageAfter. + * @param {string} [pageAfter] A collection ID value used for pagination. It marks the exclusive begin of a page. When provided, the collection resource will return the next `n` items after the id, with `n` being specified by `pageSize`. The items will be returned in the natural order of the collection. The resource will return the first page if neither `pageAfter` nor `pageBefore` are specified. SHOULD NOT be used in conjuction with pageBefore. + * @param {number} [pageSize] Limits the number of items to be returned. Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If avoided, the collection will determine the page size itself. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof PayoutsApi + */ + public listNetBurnFeeDailyCalculations( + minimumFeeAmount?: string, + currency?: "USD" | "EUR", + from?: string, + to?: string, + pageBefore?: string, + pageAfter?: string, + pageSize?: number, + options?: AxiosRequestConfig + ) { + return PayoutsApiFp(this.configuration) + .listNetBurnFeeDailyCalculations( + minimumFeeAmount, + currency, + from, + to, + pageBefore, + pageAfter, + pageSize, + options + ) + .then((request) => request(this.axios, this.basePath)); + } + /** * * @summary List all payouts diff --git a/src/generated/models/burn-fee-net-amount.ts b/src/generated/models/burn-fee-net-amount.ts new file mode 100644 index 0000000..275d115 --- /dev/null +++ b/src/generated/models/burn-fee-net-amount.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +// May contain unused imports in some cases +// @ts-ignore +import { FiatCurrency } from "./fiat-currency"; + +/** + * + * @export + * @interface BurnFeeNetAmount + */ +export interface BurnFeeNetAmount { + /** + * Sum of all initiated payouts minus sum of all received push payments, in units of the currency, with a `.`. + * @type {string} + * @memberof BurnFeeNetAmount + */ + amount: string; + /** + * + * @type {FiatCurrency} + * @memberof BurnFeeNetAmount + */ + currency: FiatCurrency; +} diff --git a/src/generated/models/burn-fee-payment-amount.ts b/src/generated/models/burn-fee-payment-amount.ts new file mode 100644 index 0000000..f43356f --- /dev/null +++ b/src/generated/models/burn-fee-payment-amount.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +// May contain unused imports in some cases +// @ts-ignore +import { FiatCurrency } from "./fiat-currency"; + +/** + * + * @export + * @interface BurnFeePaymentAmount + */ +export interface BurnFeePaymentAmount { + /** + * Sum of all push payments received, in units of the currency, with a `.`. + * @type {string} + * @memberof BurnFeePaymentAmount + */ + amount: string; + /** + * + * @type {FiatCurrency} + * @memberof BurnFeePaymentAmount + */ + currency: FiatCurrency; +} diff --git a/src/generated/models/burn-fee-payout-amount.ts b/src/generated/models/burn-fee-payout-amount.ts new file mode 100644 index 0000000..8eb97a5 --- /dev/null +++ b/src/generated/models/burn-fee-payout-amount.ts @@ -0,0 +1,31 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +// May contain unused imports in some cases +// @ts-ignore +import { FiatCurrency } from "./fiat-currency"; + +/** + * + * @export + * @interface BurnFeePayoutAmount + */ +export interface BurnFeePayoutAmount { + /** + * Sum of all initiated payouts, in units of the currency, with a `.`. + * @type {string} + * @memberof BurnFeePayoutAmount + */ + amount: string; + /** + * + * @type {FiatCurrency} + * @memberof BurnFeePayoutAmount + */ + currency: FiatCurrency; +} diff --git a/src/generated/models/index.ts b/src/generated/models/index.ts index 5c62714..4a52b91 100644 --- a/src/generated/models/index.ts +++ b/src/generated/models/index.ts @@ -17,6 +17,9 @@ export * from "./bank-destination"; export * from "./basic-chargeback"; export * from "./basic-chargeback-history"; export * from "./billing-details"; +export * from "./burn-fee-net-amount"; +export * from "./burn-fee-payment-amount"; +export * from "./burn-fee-payout-amount"; export * from "./business-account-payout-destination-type"; export * from "./business-deposit"; export * from "./business-destination-request"; @@ -149,6 +152,7 @@ export * from "./limit-exceeded"; export * from "./list-address-book-recipients-response"; export * from "./list-addresses-response"; export * from "./list-balances-response"; +export * from "./list-burn-fee-calculations-response"; export * from "./list-business-balances-response"; export * from "./list-business-cbit-account-instructions-response"; export * from "./list-business-cbit-accounts-response"; @@ -214,6 +218,7 @@ export * from "./presign-response"; export * from "./presign-response-typed-data"; export * from "./public-key"; export * from "./rate"; +export * from "./redemption-fee-calculation"; export * from "./refund-creation-request"; export * from "./refund-payment-response"; export * from "./required-action"; diff --git a/src/generated/models/list-burn-fee-calculations-response.ts b/src/generated/models/list-burn-fee-calculations-response.ts new file mode 100644 index 0000000..aee23b8 --- /dev/null +++ b/src/generated/models/list-burn-fee-calculations-response.ts @@ -0,0 +1,25 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +// May contain unused imports in some cases +// @ts-ignore +import { RedemptionFeeCalculation } from "./redemption-fee-calculation"; + +/** + * + * @export + * @interface ListBurnFeeCalculationsResponse + */ +export interface ListBurnFeeCalculationsResponse { + /** + * + * @type {Array} + * @memberof ListBurnFeeCalculationsResponse + */ + data?: Array; +} diff --git a/src/generated/models/pix-fiat-account-creation-request.ts b/src/generated/models/pix-fiat-account-creation-request.ts index 5f6d086..1b3aecc 100644 --- a/src/generated/models/pix-fiat-account-creation-request.ts +++ b/src/generated/models/pix-fiat-account-creation-request.ts @@ -45,7 +45,7 @@ export interface PixFiatAccountCreationRequest { * @type {string} * @memberof PixFiatAccountCreationRequest */ - branchCode?: string; + branchCode: string; /** * Beneficiary Tax ID. * @type {string} diff --git a/src/generated/models/redemption-fee-calculation.ts b/src/generated/models/redemption-fee-calculation.ts new file mode 100644 index 0000000..222e6cb --- /dev/null +++ b/src/generated/models/redemption-fee-calculation.ts @@ -0,0 +1,91 @@ +/* tslint:disable */ +/* eslint-disable */ +/** + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +// May contain unused imports in some cases +// @ts-ignore +import { BurnFeeNetAmount } from "./burn-fee-net-amount"; +// May contain unused imports in some cases +// @ts-ignore +import { BurnFeePaymentAmount } from "./burn-fee-payment-amount"; +// May contain unused imports in some cases +// @ts-ignore +import { BurnFeePayoutAmount } from "./burn-fee-payout-amount"; +// May contain unused imports in some cases +// @ts-ignore +import { FiatMoney } from "./fiat-money"; + +/** + * A NET burn fee calculation for a day. + * @export + * @interface RedemptionFeeCalculation + */ +export interface RedemptionFeeCalculation { + /** + * Unique system generated identifier for the entity. + * @type {string} + * @memberof RedemptionFeeCalculation + */ + id?: string; + /** + * + * @type {FiatMoney} + * @memberof RedemptionFeeCalculation + */ + fee?: FiatMoney; + /** + * + * @type {BurnFeePayoutAmount} + * @memberof RedemptionFeeCalculation + */ + cumulatedPayoutAmount?: BurnFeePayoutAmount; + /** + * + * @type {BurnFeePaymentAmount} + * @memberof RedemptionFeeCalculation + */ + cumulatedPaymentAmount?: BurnFeePaymentAmount; + /** + * + * @type {BurnFeeNetAmount} + * @memberof RedemptionFeeCalculation + */ + cumulatedNetAmount?: BurnFeeNetAmount; + /** + * A date representing a day for which a fee is calculated. + * @type {string} + * @memberof RedemptionFeeCalculation + */ + valueDate?: string; + /** + * Fee collection status + * @type {string} + * @memberof RedemptionFeeCalculation + */ + status?: RedemptionFeeCalculationStatusEnum; + /** + * Fee calculation reset timestamp. + * @type {string} + * @memberof RedemptionFeeCalculation + */ + thresholdResetTimestamp?: string; + /** + * The create date of the NET burn daily fee calculation. + * @type {string} + * @memberof RedemptionFeeCalculation + */ + createDate?: string; +} + +export const RedemptionFeeCalculationStatusEnum = { + Scheduled: "scheduled", + Pending: "pending", + Paid: "paid" +} as const; + +export type RedemptionFeeCalculationStatusEnum = + typeof RedemptionFeeCalculationStatusEnum[keyof typeof RedemptionFeeCalculationStatusEnum];