From aeb991edb9e446b8db12b837cb337d5ac963f4c5 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 6 Oct 2025 11:39:44 +0000 Subject: [PATCH 1/2] ## Typescript SDK Changes Detected: * `sdk.ledger.v1.countAccounts()`: `response` **Changed** **Breaking** :warning: * `sdk.ledger.v2.getVolumesWithBalances()`: * `request.sort` **Added** * `sdk.ledger.v2.listLedgers()`: * `request.sort` **Added** * `response.cursor.data.[]` **Changed** * `sdk.ledger.v2.listLogs()`: * `request.sort` **Added** * `sdk.ledger.v2.deleteExporter()`: **Added** * `sdk.ledger.v2.deletePipeline()`: **Added** * `sdk.ledger.v2.getExporterState()`: **Added** * `sdk.ledger.v2.getPipelineState()`: **Added** * `sdk.ledger.v2.listExporters()`: **Added** * `sdk.ledger.v2.listPipelines()`: **Added** * `sdk.ledger.v2.resetPipeline()`: **Added** * `sdk.ledger.v2.startPipeline()`: **Added** * `sdk.ledger.v2.stopPipeline()`: **Added** * `sdk.ledger.v2.getInfo()`: **Deleted** **Breaking** :warning: * `sdk.ledger.v2.getMetrics()`: **Deleted** **Breaking** :warning: * `sdk.ledger.v2.createBulk()`: * `request.requestBody.[].[addMetadata].data` **Changed** * `response.data.[].[addMetadata].data.updatedAt` **Added** * `sdk.ledger.v2.createTransaction()`: * `request.v2PostTransaction` **Changed** * `response.data.updatedAt` **Added** * `sdk.ledger.v2.getAccount()`: `response.data` **Changed** * `sdk.ledger.v2.getLedger()`: `response.data` **Changed** * `sdk.ledger.v2.getTransaction()`: `response.data.updatedAt` **Added** * `sdk.ledger.getInfo()`: **Added** * `sdk.ledger.v2.createExporter()`: **Added** * `sdk.ledger.v2.listAccounts()`: * `request.sort` **Added** * `response.cursor.data.[]` **Changed** * `sdk.ledger.v2.createPipeline()`: **Added** * `sdk.ledger.v2.listTransactions()`: * `request.sort` **Added** * `response.cursor.data.[].updatedAt` **Added** * `sdk.ledger.v2.revertTransaction()`: * `request.v2RevertTransactionRequest` **Added** * `response.data.updatedAt` **Added** * `sdk.ledger.getMetrics()`: **Added** * `sdk.orchestration.v1.createTrigger()`: * `request.version` **Added** * `response.data.version` **Added** * `sdk.orchestration.v1.getInstance()`: `response.data.workflow` **Added** * `sdk.orchestration.v1.listInstances()`: `response.data.[].workflow` **Added** * `sdk.orchestration.v1.listTriggers()`: `response.data.[].version` **Added** * `sdk.orchestration.v1.listTriggersOccurrences()`: `response.data.[].workflowInstance.workflow` **Added** * `sdk.orchestration.v1.readTrigger()`: `response.data.version` **Added** * `sdk.orchestration.v1.runWorkflow()`: `response.data.workflow` **Added** * `sdk.orchestration.v2.createTrigger()`: * `request.version` **Added** * `response.data.version` **Added** * `sdk.orchestration.v2.getInstance()`: `response.data.workflow` **Added** * `sdk.orchestration.v2.listInstances()`: `response.cursor.data.[].workflow` **Added** * `sdk.orchestration.v2.listTriggers()`: `response.cursor.data.[].version` **Added** * `sdk.orchestration.v2.listTriggersOccurrences()`: `response.cursor.data.[].workflowInstance.workflow` **Added** * `sdk.orchestration.v2.readTrigger()`: `response.data.version` **Added** * `sdk.orchestration.v2.runWorkflow()`: `response.data.workflow` **Added** * `sdk.reconciliation.v1.listPolicies()`: * `request.query` **Added** * `sdk.reconciliation.v1.listReconciliations()`: * `request.query` **Added** --- .speakeasy/gen.lock | 198 ++- .speakeasy/workflow.lock | 14 +- README.md | 75 +- RELEASES.md | 12 +- .../operations/installconnectorrequest.md | 6 +- .../models/operations/listpoliciesrequest.md | 3 +- .../operations/listreconciliationsrequest.md | 3 +- docs/sdk/models/operations/order.md | 2 + .../models/operations/runscriptresponse.md | 12 +- .../updateconnectorconfigv1request.md | 11 +- .../operations/v2createexporterresponse.md | 21 + .../v2createexporterresponsebody.md | 26 + .../operations/v2createpipelinerequest.md | 18 + .../operations/v2createpipelineresponse.md | 21 + .../v2createpipelineresponsebody.md | 24 + .../operations/v2createtransactionrequest.md | 11 +- .../operations/v2deleteexporterrequest.md | 17 + .../operations/v2deleteexporterresponse.md | 20 + .../operations/v2deletepipelinerequest.md | 19 + .../operations/v2deletepipelineresponse.md | 20 + .../operations/v2getexporterstaterequest.md | 17 + .../operations/v2getexporterstateresponse.md | 21 + .../v2getexporterstateresponsebody.md | 26 + .../operations/v2getpipelinestaterequest.md | 19 + .../operations/v2getpipelinestateresponse.md | 21 + .../v2getpipelinestateresponsebody.md | 24 + .../v2getvolumeswithbalancesrequest.md | 2 + .../operations/v2listaccountsrequest.md | 4 +- .../operations/v2listexporterscursor1.md | 34 + .../operations/v2listexporterscursor2.md | 35 + .../operations/v2listexportersresponse.md | 21 + .../operations/v2listexportersresponsebody.md | 37 + .../models/operations/v2listledgersrequest.md | 4 +- .../models/operations/v2listlogsrequest.md | 4 +- .../operations/v2listpipelinescursor1.md | 31 + .../operations/v2listpipelinescursor2.md | 25 + .../operations/v2listpipelinesrequest.md | 17 + .../operations/v2listpipelinesresponse.md | 21 + .../operations/v2listpipelinesresponsebody.md | 34 + .../operations/v2listtransactionsrequest.md | 6 +- .../operations/v2resetpipelinerequest.md | 19 + .../operations/v2resetpipelineresponse.md | 20 + .../operations/v2reverttransactionrequest.md | 1 + .../operations/v2startpipelinerequest.md | 19 + .../operations/v2startpipelineresponse.md | 20 + .../operations/v2stoppipelinerequest.md | 19 + .../operations/v2stoppipelineresponse.md | 20 + docs/sdk/models/shared/connectorconfig.md | 88 +- .../models/shared/connectorconfigresponse.md | 12 +- .../models/shared/orchestrationv2account.md | 47 + docs/sdk/models/shared/runtime.md | 18 + docs/sdk/models/shared/trigger.md | 1 + docs/sdk/models/shared/triggerdata.md | 1 + docs/sdk/models/shared/v2account.md | 6 + docs/sdk/models/shared/v2accountresponse.md | 3 + .../models/shared/v2accountscursorresponse.md | 3 + .../shared/v2activitygetaccountoutput.md | 46 + docs/sdk/models/shared/v2bulkelement.md | 5 + .../shared/v2bulkelementcreatetransaction.md | 5 + docs/sdk/models/shared/v2bulkelementresult.md | 46 +- .../models/shared/v2createpipelinerequest.md | 17 + docs/sdk/models/shared/v2exporter.md | 26 + .../models/shared/v2exporterconfiguration.md | 23 + docs/sdk/models/shared/v2ledger.md | 2 + .../sdk/models/shared/v2migrationinfostate.md | 11 +- docs/sdk/models/shared/v2pipeline.md | 25 + docs/sdk/models/shared/v2posttransaction.md | 22 +- .../shared/v2reverttransactionrequest.md | 15 + docs/sdk/models/shared/v2transaction.md | 3 +- docs/sdk/models/shared/v2trigger.md | 1 + docs/sdk/models/shared/v2triggerdata.md | 1 + docs/sdk/models/shared/v2workflowinstance.md | 1 + .../v2workflowinstancehistorystageoutput.md | 2 +- docs/sdk/models/shared/workflowinstance.md | 1 + docs/sdks/ledger/README.md | 153 +++ docs/sdks/ledgerv2/README.md | 1154 ++++++++++++++--- examples/package-lock.json | 2 +- gen.yaml | 4 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- .../{ledgerV2GetInfo.ts => ledgerGetInfo.ts} | 2 +- ...gerV2GetMetrics.ts => ledgerGetMetrics.ts} | 2 +- src/funcs/ledgerV1CountAccounts.ts | 2 +- src/funcs/ledgerV2CreateExporter.ts | 170 +++ src/funcs/ledgerV2CreatePipeline.ts | 178 +++ src/funcs/ledgerV2DeleteExporter.ts | 175 +++ src/funcs/ledgerV2DeletePipeline.ts | 179 +++ src/funcs/ledgerV2GetExporterState.ts | 177 +++ src/funcs/ledgerV2GetPipelineState.ts | 181 +++ src/funcs/ledgerV2GetVolumesWithBalances.ts | 1 + src/funcs/ledgerV2ListAccounts.ts | 1 + src/funcs/ledgerV2ListExporters.ts | 151 +++ src/funcs/ledgerV2ListLedgers.ts | 1 + src/funcs/ledgerV2ListLogs.ts | 1 + src/funcs/ledgerV2ListPipelines.ts | 175 +++ src/funcs/ledgerV2ListTransactions.ts | 1 + src/funcs/ledgerV2ResetPipeline.ts | 179 +++ src/funcs/ledgerV2RevertTransaction.ts | 7 +- src/funcs/ledgerV2StartPipeline.ts | 179 +++ src/funcs/ledgerV2StopPipeline.ts | 179 +++ src/funcs/reconciliationV1ListPolicies.ts | 19 +- .../reconciliationV1ListReconciliations.ts | 19 +- src/lib/config.ts | 11 +- src/lib/url.ts | 2 +- src/sdk/ledger.ts | 36 +- src/sdk/ledgerv2.ts | 158 ++- src/sdk/models/errors/index.ts | 1 + src/sdk/models/operations/index.ts | 11 + src/sdk/models/operations/listpolicies.ts | 4 + .../models/operations/listreconciliations.ts | 4 + src/sdk/models/operations/runscript.ts | 1 + src/sdk/models/operations/v2createexporter.ts | 169 +++ src/sdk/models/operations/v2createpipeline.ts | 244 ++++ .../models/operations/v2createtransaction.ts | 2 + src/sdk/models/operations/v2deleteexporter.ts | 159 +++ src/sdk/models/operations/v2deletepipeline.ts | 166 +++ .../models/operations/v2getexporterstate.ts | 231 ++++ .../models/operations/v2getpipelinestate.ts | 238 ++++ .../operations/v2getvolumeswithbalances.ts | 10 + src/sdk/models/operations/v2listaccounts.ts | 10 + src/sdk/models/operations/v2listexporters.ts | 305 +++++ src/sdk/models/operations/v2listledgers.ts | 10 + src/sdk/models/operations/v2listlogs.ts | 10 + src/sdk/models/operations/v2listpipelines.ts | 366 ++++++ .../models/operations/v2listtransactions.ts | 18 + src/sdk/models/operations/v2resetpipeline.ts | 166 +++ .../models/operations/v2reverttransaction.ts | 16 + src/sdk/models/operations/v2startpipeline.ts | 166 +++ src/sdk/models/operations/v2stoppipeline.ts | 166 +++ src/sdk/models/shared/index.ts | 7 + .../models/shared/orchestrationv2account.ts | 84 ++ src/sdk/models/shared/trigger.ts | 4 + src/sdk/models/shared/triggerdata.ts | 4 + src/sdk/models/shared/v2account.ts | 16 + .../shared/v2activitygetaccountoutput.ts | 72 + .../models/shared/v2createpipelinerequest.ts | 66 + src/sdk/models/shared/v2exporter.ts | 74 ++ .../models/shared/v2exporterconfiguration.ts | 70 + src/sdk/models/shared/v2ledger.ts | 8 + src/sdk/models/shared/v2migrationinfo.ts | 1 + src/sdk/models/shared/v2pipeline.ts | 82 ++ src/sdk/models/shared/v2posttransaction.ts | 42 + .../shared/v2reverttransactionrequest.ts | 66 + src/sdk/models/shared/v2transaction.ts | 5 + src/sdk/models/shared/v2trigger.ts | 4 + src/sdk/models/shared/v2triggerdata.ts | 4 + src/sdk/models/shared/v2workflowinstance.ts | 10 + .../v2workflowinstancehistorystageoutput.ts | 20 +- src/sdk/models/shared/workflowinstance.ts | 10 + 150 files changed, 7713 insertions(+), 401 deletions(-) create mode 100644 docs/sdk/models/operations/v2createexporterresponse.md create mode 100644 docs/sdk/models/operations/v2createexporterresponsebody.md create mode 100644 docs/sdk/models/operations/v2createpipelinerequest.md create mode 100644 docs/sdk/models/operations/v2createpipelineresponse.md create mode 100644 docs/sdk/models/operations/v2createpipelineresponsebody.md create mode 100644 docs/sdk/models/operations/v2deleteexporterrequest.md create mode 100644 docs/sdk/models/operations/v2deleteexporterresponse.md create mode 100644 docs/sdk/models/operations/v2deletepipelinerequest.md create mode 100644 docs/sdk/models/operations/v2deletepipelineresponse.md create mode 100644 docs/sdk/models/operations/v2getexporterstaterequest.md create mode 100644 docs/sdk/models/operations/v2getexporterstateresponse.md create mode 100644 docs/sdk/models/operations/v2getexporterstateresponsebody.md create mode 100644 docs/sdk/models/operations/v2getpipelinestaterequest.md create mode 100644 docs/sdk/models/operations/v2getpipelinestateresponse.md create mode 100644 docs/sdk/models/operations/v2getpipelinestateresponsebody.md create mode 100644 docs/sdk/models/operations/v2listexporterscursor1.md create mode 100644 docs/sdk/models/operations/v2listexporterscursor2.md create mode 100644 docs/sdk/models/operations/v2listexportersresponse.md create mode 100644 docs/sdk/models/operations/v2listexportersresponsebody.md create mode 100644 docs/sdk/models/operations/v2listpipelinescursor1.md create mode 100644 docs/sdk/models/operations/v2listpipelinescursor2.md create mode 100644 docs/sdk/models/operations/v2listpipelinesrequest.md create mode 100644 docs/sdk/models/operations/v2listpipelinesresponse.md create mode 100644 docs/sdk/models/operations/v2listpipelinesresponsebody.md create mode 100644 docs/sdk/models/operations/v2resetpipelinerequest.md create mode 100644 docs/sdk/models/operations/v2resetpipelineresponse.md create mode 100644 docs/sdk/models/operations/v2startpipelinerequest.md create mode 100644 docs/sdk/models/operations/v2startpipelineresponse.md create mode 100644 docs/sdk/models/operations/v2stoppipelinerequest.md create mode 100644 docs/sdk/models/operations/v2stoppipelineresponse.md create mode 100644 docs/sdk/models/shared/orchestrationv2account.md create mode 100644 docs/sdk/models/shared/runtime.md create mode 100644 docs/sdk/models/shared/v2activitygetaccountoutput.md create mode 100644 docs/sdk/models/shared/v2createpipelinerequest.md create mode 100644 docs/sdk/models/shared/v2exporter.md create mode 100644 docs/sdk/models/shared/v2exporterconfiguration.md create mode 100644 docs/sdk/models/shared/v2pipeline.md create mode 100644 docs/sdk/models/shared/v2reverttransactionrequest.md rename src/funcs/{ledgerV2GetInfo.ts => ledgerGetInfo.ts} (99%) rename src/funcs/{ledgerV2GetMetrics.ts => ledgerGetMetrics.ts} (99%) create mode 100644 src/funcs/ledgerV2CreateExporter.ts create mode 100644 src/funcs/ledgerV2CreatePipeline.ts create mode 100644 src/funcs/ledgerV2DeleteExporter.ts create mode 100644 src/funcs/ledgerV2DeletePipeline.ts create mode 100644 src/funcs/ledgerV2GetExporterState.ts create mode 100644 src/funcs/ledgerV2GetPipelineState.ts create mode 100644 src/funcs/ledgerV2ListExporters.ts create mode 100644 src/funcs/ledgerV2ListPipelines.ts create mode 100644 src/funcs/ledgerV2ResetPipeline.ts create mode 100644 src/funcs/ledgerV2StartPipeline.ts create mode 100644 src/funcs/ledgerV2StopPipeline.ts create mode 100644 src/sdk/models/operations/v2createexporter.ts create mode 100644 src/sdk/models/operations/v2createpipeline.ts create mode 100644 src/sdk/models/operations/v2deleteexporter.ts create mode 100644 src/sdk/models/operations/v2deletepipeline.ts create mode 100644 src/sdk/models/operations/v2getexporterstate.ts create mode 100644 src/sdk/models/operations/v2getpipelinestate.ts create mode 100644 src/sdk/models/operations/v2listexporters.ts create mode 100644 src/sdk/models/operations/v2listpipelines.ts create mode 100644 src/sdk/models/operations/v2resetpipeline.ts create mode 100644 src/sdk/models/operations/v2startpipeline.ts create mode 100644 src/sdk/models/operations/v2stoppipeline.ts create mode 100644 src/sdk/models/shared/orchestrationv2account.ts create mode 100644 src/sdk/models/shared/v2activitygetaccountoutput.ts create mode 100644 src/sdk/models/shared/v2createpipelinerequest.ts create mode 100644 src/sdk/models/shared/v2exporter.ts create mode 100644 src/sdk/models/shared/v2exporterconfiguration.ts create mode 100644 src/sdk/models/shared/v2pipeline.ts create mode 100644 src/sdk/models/shared/v2reverttransactionrequest.ts diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 3bf20978..cc6c3b1f 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 2bb10af9-e48a-4bd7-ae46-a35fa809dc29 management: - docChecksum: c079046e05a1d80ad361ab1f38ccee14 + docChecksum: 4aaed26e7fbddbaeef20c93ae50f5aed docVersion: v3.1.0 - speakeasyVersion: 1.617.1 - generationVersion: 2.701.8 - releaseVersion: 4.5.0 - configChecksum: 9b2b427789d5db4a6ebdfd88ce64526e + speakeasyVersion: 1.634.2 + generationVersion: 2.721.3 + releaseVersion: 4.6.0 + configChecksum: ed3e9340c017cf78527dbaba07d5cb0d repoURL: https://github.com/formancehq/formance-sdk-typescript.git repoSubDirectory: . installationURL: https://github.com/formancehq/formance-sdk-typescript @@ -16,13 +16,13 @@ features: additionalDependencies: 0.1.0 bigint: 0.0.2 constsAndDefaults: 0.1.12 - core: 3.21.22 + core: 3.21.26 defaultEnabledRetries: 0.1.0 deprecations: 2.81.1 downloadStreams: 0.1.1 enumUnions: 0.1.0 envVarSecurityUsage: 0.1.2 - errors: 2.86.0 + errors: 2.86.1 globalSecurity: 2.82.14 globalSecurityCallbacks: 0.1.0 globalServerURLs: 2.82.5 @@ -33,7 +33,7 @@ features: responseFormat: 0.2.3 retries: 2.83.0 sdkHooks: 0.3.0 - unions: 2.85.11 + unions: 2.86.0 uploadStreams: 0.1.0 generatedFiles: - .gitattributes @@ -299,16 +299,25 @@ generatedFiles: - docs/sdk/models/operations/v2counttransactionsresponse.md - docs/sdk/models/operations/v2createbulkrequest.md - docs/sdk/models/operations/v2createbulkresponse.md + - docs/sdk/models/operations/v2createexporterresponse.md + - docs/sdk/models/operations/v2createexporterresponsebody.md - docs/sdk/models/operations/v2createledgerrequest.md - docs/sdk/models/operations/v2createledgerresponse.md + - docs/sdk/models/operations/v2createpipelinerequest.md + - docs/sdk/models/operations/v2createpipelineresponse.md + - docs/sdk/models/operations/v2createpipelineresponsebody.md - docs/sdk/models/operations/v2createtransactionrequest.md - docs/sdk/models/operations/v2createtransactionresponse.md - docs/sdk/models/operations/v2createtriggerresponse.md - docs/sdk/models/operations/v2createworkflowresponse.md - docs/sdk/models/operations/v2deleteaccountmetadatarequest.md - docs/sdk/models/operations/v2deleteaccountmetadataresponse.md + - docs/sdk/models/operations/v2deleteexporterrequest.md + - docs/sdk/models/operations/v2deleteexporterresponse.md - docs/sdk/models/operations/v2deleteledgermetadatarequest.md - docs/sdk/models/operations/v2deleteledgermetadataresponse.md + - docs/sdk/models/operations/v2deletepipelinerequest.md + - docs/sdk/models/operations/v2deletepipelineresponse.md - docs/sdk/models/operations/v2deletetransactionmetadatarequest.md - docs/sdk/models/operations/v2deletetransactionmetadataresponse.md - docs/sdk/models/operations/v2deletetriggerrequest.md @@ -321,6 +330,9 @@ generatedFiles: - docs/sdk/models/operations/v2getaccountresponse.md - docs/sdk/models/operations/v2getbalancesaggregatedrequest.md - docs/sdk/models/operations/v2getbalancesaggregatedresponse.md + - docs/sdk/models/operations/v2getexporterstaterequest.md + - docs/sdk/models/operations/v2getexporterstateresponse.md + - docs/sdk/models/operations/v2getexporterstateresponsebody.md - docs/sdk/models/operations/v2getinforesponse.md - docs/sdk/models/operations/v2getinstancehistoryrequest.md - docs/sdk/models/operations/v2getinstancehistoryresponse.md @@ -332,6 +344,9 @@ generatedFiles: - docs/sdk/models/operations/v2getledgerinforesponse.md - docs/sdk/models/operations/v2getledgerrequest.md - docs/sdk/models/operations/v2getledgerresponse.md + - docs/sdk/models/operations/v2getpipelinestaterequest.md + - docs/sdk/models/operations/v2getpipelinestateresponse.md + - docs/sdk/models/operations/v2getpipelinestateresponsebody.md - docs/sdk/models/operations/v2getserverinforesponse.md - docs/sdk/models/operations/v2gettransactionrequest.md - docs/sdk/models/operations/v2gettransactionresponse.md @@ -343,12 +358,21 @@ generatedFiles: - docs/sdk/models/operations/v2importlogsresponse.md - docs/sdk/models/operations/v2listaccountsrequest.md - docs/sdk/models/operations/v2listaccountsresponse.md + - docs/sdk/models/operations/v2listexporterscursor1.md + - docs/sdk/models/operations/v2listexporterscursor2.md + - docs/sdk/models/operations/v2listexportersresponse.md + - docs/sdk/models/operations/v2listexportersresponsebody.md - docs/sdk/models/operations/v2listinstancesrequest.md - docs/sdk/models/operations/v2listinstancesresponse.md - docs/sdk/models/operations/v2listledgersrequest.md - docs/sdk/models/operations/v2listledgersresponse.md - docs/sdk/models/operations/v2listlogsrequest.md - docs/sdk/models/operations/v2listlogsresponse.md + - docs/sdk/models/operations/v2listpipelinescursor1.md + - docs/sdk/models/operations/v2listpipelinescursor2.md + - docs/sdk/models/operations/v2listpipelinesrequest.md + - docs/sdk/models/operations/v2listpipelinesresponse.md + - docs/sdk/models/operations/v2listpipelinesresponsebody.md - docs/sdk/models/operations/v2listtransactionsrequest.md - docs/sdk/models/operations/v2listtransactionsresponse.md - docs/sdk/models/operations/v2listtriggersoccurrencesrequest.md @@ -361,6 +385,8 @@ generatedFiles: - docs/sdk/models/operations/v2readstatsresponse.md - docs/sdk/models/operations/v2readtriggerrequest.md - docs/sdk/models/operations/v2readtriggerresponse.md + - docs/sdk/models/operations/v2resetpipelinerequest.md + - docs/sdk/models/operations/v2resetpipelineresponse.md - docs/sdk/models/operations/v2reverttransactionrequest.md - docs/sdk/models/operations/v2reverttransactionresponse.md - docs/sdk/models/operations/v2runworkflowrequest.md @@ -368,6 +394,10 @@ generatedFiles: - docs/sdk/models/operations/v2sendeventrequest.md - docs/sdk/models/operations/v2sendeventrequestbody.md - docs/sdk/models/operations/v2sendeventresponse.md + - docs/sdk/models/operations/v2startpipelinerequest.md + - docs/sdk/models/operations/v2startpipelineresponse.md + - docs/sdk/models/operations/v2stoppipelinerequest.md + - docs/sdk/models/operations/v2stoppipelineresponse.md - docs/sdk/models/operations/v2updateledgermetadatarequest.md - docs/sdk/models/operations/v2updateledgermetadataresponse.md - docs/sdk/models/operations/v3addaccounttopoolrequest.md @@ -609,6 +639,7 @@ generatedFiles: - docs/sdk/models/shared/orchestrationposttransaction.md - docs/sdk/models/shared/orchestrationposttransactionscript.md - docs/sdk/models/shared/orchestrationtransaction.md + - docs/sdk/models/shared/orchestrationv2account.md - docs/sdk/models/shared/orchestrationv2posttransaction.md - docs/sdk/models/shared/orchestrationv2posttransactionscript.md - docs/sdk/models/shared/orchestrationv2transaction.md @@ -658,6 +689,7 @@ generatedFiles: - docs/sdk/models/shared/responsecursor.md - docs/sdk/models/shared/responset.md - docs/sdk/models/shared/reversetransferinitiationrequest.md + - docs/sdk/models/shared/runtime.md - docs/sdk/models/shared/runworkflowresponse.md - docs/sdk/models/shared/script.md - docs/sdk/models/shared/scriptresponse.md @@ -750,6 +782,7 @@ generatedFiles: - docs/sdk/models/shared/v2activitydebitwallet.md - docs/sdk/models/shared/v2activitydebitwalletoutput.md - docs/sdk/models/shared/v2activitygetaccount.md + - docs/sdk/models/shared/v2activitygetaccountoutput.md - docs/sdk/models/shared/v2activitygetpayment.md - docs/sdk/models/shared/v2activitygetpaymentoutput.md - docs/sdk/models/shared/v2activitygetwallet.md @@ -778,6 +811,7 @@ generatedFiles: - docs/sdk/models/shared/v2configinforesponse.md - docs/sdk/models/shared/v2connector.md - docs/sdk/models/shared/v2createledgerrequest.md + - docs/sdk/models/shared/v2createpipelinerequest.md - docs/sdk/models/shared/v2createtransactionresponse.md - docs/sdk/models/shared/v2createtriggerresponse.md - docs/sdk/models/shared/v2createworkflowresponse.md @@ -785,6 +819,8 @@ generatedFiles: - docs/sdk/models/shared/v2debitwalletrequest.md - docs/sdk/models/shared/v2errorresponse.md - docs/sdk/models/shared/v2errorsenum.md + - docs/sdk/models/shared/v2exporter.md + - docs/sdk/models/shared/v2exporterconfiguration.md - docs/sdk/models/shared/v2getledgerresponse.md - docs/sdk/models/shared/v2gettransactionresponse.md - docs/sdk/models/shared/v2getworkflowinstancehistoryresponse.md @@ -824,10 +860,12 @@ generatedFiles: - docs/sdk/models/shared/v2paymentscheme.md - docs/sdk/models/shared/v2paymentstatus.md - docs/sdk/models/shared/v2paymenttype.md + - docs/sdk/models/shared/v2pipeline.md - docs/sdk/models/shared/v2posting.md - docs/sdk/models/shared/v2posttransaction.md - docs/sdk/models/shared/v2posttransactionscript.md - docs/sdk/models/shared/v2readtriggerresponse.md + - docs/sdk/models/shared/v2reverttransactionrequest.md - docs/sdk/models/shared/v2runworkflowresponse.md - docs/sdk/models/shared/v2serverinfo.md - docs/sdk/models/shared/v2stage.md @@ -1044,6 +1082,8 @@ generatedFiles: - src/funcs/authV1ReadUser.ts - src/funcs/authV1UpdateClient.ts - src/funcs/getVersions.ts + - src/funcs/ledgerGetInfo.ts + - src/funcs/ledgerGetMetrics.ts - src/funcs/ledgerV1AddMetadataOnTransaction.ts - src/funcs/ledgerV1AddMetadataToAccount.ts - src/funcs/ledgerV1CountAccounts.ts @@ -1069,27 +1109,36 @@ generatedFiles: - src/funcs/ledgerV2CountAccounts.ts - src/funcs/ledgerV2CountTransactions.ts - src/funcs/ledgerV2CreateBulk.ts + - src/funcs/ledgerV2CreateExporter.ts - src/funcs/ledgerV2CreateLedger.ts + - src/funcs/ledgerV2CreatePipeline.ts - src/funcs/ledgerV2CreateTransaction.ts - src/funcs/ledgerV2DeleteAccountMetadata.ts + - src/funcs/ledgerV2DeleteExporter.ts - src/funcs/ledgerV2DeleteLedgerMetadata.ts + - src/funcs/ledgerV2DeletePipeline.ts - src/funcs/ledgerV2DeleteTransactionMetadata.ts - src/funcs/ledgerV2ExportLogs.ts - src/funcs/ledgerV2GetAccount.ts - src/funcs/ledgerV2GetBalancesAggregated.ts - - src/funcs/ledgerV2GetInfo.ts + - src/funcs/ledgerV2GetExporterState.ts - src/funcs/ledgerV2GetLedger.ts - src/funcs/ledgerV2GetLedgerInfo.ts - - src/funcs/ledgerV2GetMetrics.ts + - src/funcs/ledgerV2GetPipelineState.ts - src/funcs/ledgerV2GetTransaction.ts - src/funcs/ledgerV2GetVolumesWithBalances.ts - src/funcs/ledgerV2ImportLogs.ts - src/funcs/ledgerV2ListAccounts.ts + - src/funcs/ledgerV2ListExporters.ts - src/funcs/ledgerV2ListLedgers.ts - src/funcs/ledgerV2ListLogs.ts + - src/funcs/ledgerV2ListPipelines.ts - src/funcs/ledgerV2ListTransactions.ts - src/funcs/ledgerV2ReadStats.ts + - src/funcs/ledgerV2ResetPipeline.ts - src/funcs/ledgerV2RevertTransaction.ts + - src/funcs/ledgerV2StartPipeline.ts + - src/funcs/ledgerV2StopPipeline.ts - src/funcs/ledgerV2UpdateLedgerMetadata.ts - src/funcs/orchestrationV1CancelEvent.ts - src/funcs/orchestrationV1CreateTrigger.ts @@ -1426,42 +1475,53 @@ generatedFiles: - src/sdk/models/operations/v2countaccounts.ts - src/sdk/models/operations/v2counttransactions.ts - src/sdk/models/operations/v2createbulk.ts + - src/sdk/models/operations/v2createexporter.ts - src/sdk/models/operations/v2createledger.ts + - src/sdk/models/operations/v2createpipeline.ts - src/sdk/models/operations/v2createtransaction.ts - src/sdk/models/operations/v2createtrigger.ts - src/sdk/models/operations/v2createworkflow.ts - src/sdk/models/operations/v2deleteaccountmetadata.ts + - src/sdk/models/operations/v2deleteexporter.ts - src/sdk/models/operations/v2deleteledgermetadata.ts + - src/sdk/models/operations/v2deletepipeline.ts - src/sdk/models/operations/v2deletetransactionmetadata.ts - src/sdk/models/operations/v2deletetrigger.ts - src/sdk/models/operations/v2deleteworkflow.ts - src/sdk/models/operations/v2exportlogs.ts - src/sdk/models/operations/v2getaccount.ts - src/sdk/models/operations/v2getbalancesaggregated.ts + - src/sdk/models/operations/v2getexporterstate.ts - src/sdk/models/operations/v2getinfo.ts - src/sdk/models/operations/v2getinstance.ts - src/sdk/models/operations/v2getinstancehistory.ts - src/sdk/models/operations/v2getinstancestagehistory.ts - src/sdk/models/operations/v2getledger.ts - src/sdk/models/operations/v2getledgerinfo.ts + - src/sdk/models/operations/v2getpipelinestate.ts - src/sdk/models/operations/v2getserverinfo.ts - src/sdk/models/operations/v2gettransaction.ts - src/sdk/models/operations/v2getvolumeswithbalances.ts - src/sdk/models/operations/v2getworkflow.ts - src/sdk/models/operations/v2importlogs.ts - src/sdk/models/operations/v2listaccounts.ts + - src/sdk/models/operations/v2listexporters.ts - src/sdk/models/operations/v2listinstances.ts - src/sdk/models/operations/v2listledgers.ts - src/sdk/models/operations/v2listlogs.ts + - src/sdk/models/operations/v2listpipelines.ts - src/sdk/models/operations/v2listtransactions.ts - src/sdk/models/operations/v2listtriggers.ts - src/sdk/models/operations/v2listtriggersoccurrences.ts - src/sdk/models/operations/v2listworkflows.ts - src/sdk/models/operations/v2readstats.ts - src/sdk/models/operations/v2readtrigger.ts + - src/sdk/models/operations/v2resetpipeline.ts - src/sdk/models/operations/v2reverttransaction.ts - src/sdk/models/operations/v2runworkflow.ts - src/sdk/models/operations/v2sendevent.ts + - src/sdk/models/operations/v2startpipeline.ts + - src/sdk/models/operations/v2stoppipeline.ts - src/sdk/models/operations/v2updateledgermetadata.ts - src/sdk/models/operations/v3addaccounttopool.ts - src/sdk/models/operations/v3addbankaccounttopaymentserviceuser.ts @@ -1635,6 +1695,7 @@ generatedFiles: - src/sdk/models/shared/orchestrationpaymentstatus.ts - src/sdk/models/shared/orchestrationposttransaction.ts - src/sdk/models/shared/orchestrationtransaction.ts + - src/sdk/models/shared/orchestrationv2account.ts - src/sdk/models/shared/orchestrationv2posttransaction.ts - src/sdk/models/shared/orchestrationv2transaction.ts - src/sdk/models/shared/orchestrationwallet.ts @@ -1739,6 +1800,7 @@ generatedFiles: - src/sdk/models/shared/v2activitydebitwallet.ts - src/sdk/models/shared/v2activitydebitwalletoutput.ts - src/sdk/models/shared/v2activitygetaccount.ts + - src/sdk/models/shared/v2activitygetaccountoutput.ts - src/sdk/models/shared/v2activitygetpayment.ts - src/sdk/models/shared/v2activitygetpaymentoutput.ts - src/sdk/models/shared/v2activitygetwallet.ts @@ -1758,6 +1820,7 @@ generatedFiles: - src/sdk/models/shared/v2configinforesponse.ts - src/sdk/models/shared/v2connector.ts - src/sdk/models/shared/v2createledgerrequest.ts + - src/sdk/models/shared/v2createpipelinerequest.ts - src/sdk/models/shared/v2createtransactionresponse.ts - src/sdk/models/shared/v2createtriggerresponse.ts - src/sdk/models/shared/v2createworkflowresponse.ts @@ -1765,6 +1828,8 @@ generatedFiles: - src/sdk/models/shared/v2debitwalletrequest.ts - src/sdk/models/shared/v2errorresponse.ts - src/sdk/models/shared/v2errorsenum.ts + - src/sdk/models/shared/v2exporter.ts + - src/sdk/models/shared/v2exporterconfiguration.ts - src/sdk/models/shared/v2getledgerresponse.ts - src/sdk/models/shared/v2gettransactionresponse.ts - src/sdk/models/shared/v2getworkflowinstancehistoryresponse.ts @@ -1790,9 +1855,11 @@ generatedFiles: - src/sdk/models/shared/v2paymentadjustment.ts - src/sdk/models/shared/v2paymentmetadata.ts - src/sdk/models/shared/v2paymentstatus.ts + - src/sdk/models/shared/v2pipeline.ts - src/sdk/models/shared/v2posting.ts - src/sdk/models/shared/v2posttransaction.ts - src/sdk/models/shared/v2readtriggerresponse.ts + - src/sdk/models/shared/v2reverttransactionrequest.ts - src/sdk/models/shared/v2runworkflowresponse.ts - src/sdk/models/shared/v2serverinfo.ts - src/sdk/models/shared/v2stage.ts @@ -2114,7 +2181,7 @@ examples: dryRun: true force: true requestBody: - application/json: {"metadata": {"admin": "true"}, "postings": [{"amount": 100, "asset": "COIN", "destination": "users:002", "source": "users:001"}], "reference": "ref:001", "script": {"plain": "vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n", "vars": {"user": "users:042"}}} + application/json: {"accountMetadata": {"key": {"admin": "true"}, "key1": {"admin": "true"}, "key2": {"admin": "true"}}, "metadata": {"admin": "true"}, "postings": [{"amount": 100, "asset": "COIN", "destination": "users:002", "source": "users:001"}], "reference": "ref:001", "script": {"plain": "vars {\naccount $user\n}\nsend [COIN 10] (\n\tsource = @world\n\tdestination = $user\n)\n", "vars": {"user": "users:042"}}} responses: "200": application/json: {"data": {"id": 863659, "metadata": {"admin": "true"}, "postCommitEffectiveVolumes": {"orders:1": {"USD": {"balance": 90, "input": 100, "output": 10}}, "orders:2": {"USD": {"balance": 90, "input": 100, "output": 10}}}, "postCommitVolumes": {"orders:1": {"USD": {"balance": 90, "input": 100, "output": 10}}, "orders:2": {"USD": {"balance": 90, "input": 100, "output": 10}}}, "postings": [], "preCommitEffectiveVolumes": {"orders:1": {"USD": {"balance": 90, "input": 100, "output": 10}}, "orders:2": {"USD": {"balance": 90, "input": 100, "output": 10}}}, "preCommitVolumes": {"orders:1": {"USD": {"balance": 90, "input": 100, "output": 10}}, "orders:2": {"USD": {"balance": 90, "input": 100, "output": 10}}}, "reference": "ref:001", "reverted": false, "timestamp": "2024-01-08T03:47:56.227Z"}} @@ -2162,7 +2229,7 @@ examples: address: "users:001" responses: "200": - application/json: {"data": {"address": "users:001", "effectiveVolumes": {"USD": {"balance": 90, "input": 100, "output": 10}, "EUR": {"balance": 90, "input": 100, "output": 10}}, "metadata": {"admin": "true"}, "volumes": {"USD": {"balance": 90, "input": 100, "output": 10}, "EUR": {"balance": 90, "input": 100, "output": 10}}}} + application/json: {"data": {"address": "users:001", "effectiveVolumes": {"USD": {"balance": 90, "input": 100, "output": 10}, "EUR": {"balance": 90, "input": 100, "output": 10}}, "firstUsage": "2023-01-01T00:00:00Z", "insertionDate": "2023-01-01T00:00:00Z", "metadata": {"admin": "true"}, "updatedAt": "2023-01-01T00:00:00Z", "volumes": {"USD": {"balance": 90, "input": 100, "output": 10}, "EUR": {"balance": 90, "input": 100, "output": 10}}}} default: application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} v2GetBalancesAggregated: @@ -2231,6 +2298,7 @@ examples: pageSize: 100 cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==" groupBy: 3 + sort: "id:desc" responses: "200": application/json: {"cursor": {"data": [], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}} @@ -2254,6 +2322,7 @@ examples: query: pageSize: 100 cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==" + sort: "id:desc" responses: "200": application/json: {"cursor": {"data": [], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}} @@ -2265,6 +2334,7 @@ examples: query: pageSize: 100 cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==" + sort: "id:desc" responses: "200": application/json: {"cursor": {"data": [{"addedAt": "2024-03-14T02:30:05.506Z", "bucket": "", "metadata": {"admin": "true"}, "name": ""}], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}} @@ -2278,6 +2348,7 @@ examples: query: pageSize: 100 cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==" + sort: "id:desc" responses: "200": application/json: {"cursor": {"data": [], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}} @@ -2291,6 +2362,7 @@ examples: query: pageSize: 100 cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==" + sort: "id:desc" responses: "200": application/json: {"cursor": {"data": [], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}} @@ -4135,6 +4207,107 @@ examples: responses: default: application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2CreateExporter: + speakeasy-default-v2-create-exporter: + requestBody: + application/json: {"config": {"key": ""}, "driver": ""} + responses: + "201": + application/json: {"data": {"config": {"key": "", "key1": "", "key2": ""}, "createdAt": "2023-09-20T22:58:09.492Z", "driver": "", "id": ""}} + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2CreatePipeline: + speakeasy-default-v2-create-pipeline: + parameters: + path: + ledger: "ledger001" + responses: + "201": + application/json: {"data": {"createdAt": "2023-10-13T04:07:21.184Z", "exporterID": "", "id": "", "ledger": ""}} + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2DeleteExporter: + speakeasy-default-v2-delete-exporter: + parameters: + path: + exporterID: "" + responses: + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2DeletePipeline: + speakeasy-default-v2-delete-pipeline: + parameters: + path: + ledger: "ledger001" + pipelineID: "" + responses: + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2GetExporterState: + speakeasy-default-v2-get-exporter-state: + parameters: + path: + exporterID: "" + responses: + "200": + application/json: {"data": {"config": {"key": "", "key1": "", "key2": ""}, "createdAt": "2025-12-16T02:14:09.876Z", "driver": "", "id": ""}} + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2GetPipelineState: + speakeasy-default-v2-get-pipeline-state: + parameters: + path: + ledger: "ledger001" + pipelineID: "" + responses: + "200": + application/json: {"data": {"createdAt": "2024-06-04T21:05:32.605Z", "exporterID": "", "id": "", "ledger": ""}} + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2ListExporters: + speakeasy-default-v2-list-exporters: + responses: + "200": + application/json: {"cursor": {"cursor": {"data": [], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}}} + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2ListPipelines: + speakeasy-default-v2-list-pipelines: + parameters: + path: + ledger: "ledger001" + responses: + "200": + application/json: {"cursor": {"cursor": {"data": [{"createdAt": "2023-07-10T16:30:37.234Z", "exporterID": "", "id": "", "ledger": ""}], "hasMore": false, "next": "", "pageSize": 15, "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="}}} + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2ResetPipeline: + speakeasy-default-v2-reset-pipeline: + parameters: + path: + ledger: "ledger001" + pipelineID: "" + responses: + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2StartPipeline: + speakeasy-default-v2-start-pipeline: + parameters: + path: + ledger: "ledger001" + pipelineID: "" + responses: + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} + v2StopPipeline: + speakeasy-default-v2-stop-pipeline: + parameters: + path: + ledger: "ledger001" + pipelineID: "" + responses: + default: + application/json: {"details": "https://play.numscript.org/?payload=eyJlcnJvciI6ImFjY291bnQgaGFkIGluc3VmZmljaWVudCBmdW5kcyJ9", "errorCode": "VALIDATION", "errorMessage": "[VALIDATION] invalid 'cursor' query param"} examplesVersion: 1.0.2 generatedTests: getVersions: "2025-03-04T15:22:19+01:00" @@ -4348,3 +4521,4 @@ generatedTests: insertConfig: "2025-03-04T15:22:19+01:00" testConfig: "2025-03-04T15:22:19+01:00" updateConfig: "2025-03-04T15:22:19+01:00" +releaseNotes: "## Typescript SDK Changes Detected:\n* `sdk.ledger.v1.countAccounts()`: `response` **Changed** **Breaking** :warning:\n* `sdk.ledger.v2.getVolumesWithBalances()`: \n * `request.sort` **Added**\n* `sdk.ledger.v2.listLedgers()`: \n * `request.sort` **Added**\n * `response.cursor.data.[]` **Changed**\n* `sdk.ledger.v2.listLogs()`: \n * `request.sort` **Added**\n* `sdk.ledger.v2.deleteExporter()`: **Added**\n* `sdk.ledger.v2.deletePipeline()`: **Added**\n* `sdk.ledger.v2.getExporterState()`: **Added**\n* `sdk.ledger.v2.getPipelineState()`: **Added**\n* `sdk.ledger.v2.listExporters()`: **Added**\n* `sdk.ledger.v2.listPipelines()`: **Added**\n* `sdk.ledger.v2.resetPipeline()`: **Added**\n* `sdk.ledger.v2.startPipeline()`: **Added**\n* `sdk.ledger.v2.stopPipeline()`: **Added**\n* `sdk.ledger.v2.getInfo()`: **Deleted** **Breaking** :warning:\n* `sdk.ledger.v2.getMetrics()`: **Deleted** **Breaking** :warning:\n* `sdk.ledger.v2.createBulk()`: \n * `request.requestBody.[].[addMetadata].data` **Changed**\n * `response.data.[].[addMetadata].data.updatedAt` **Added**\n* `sdk.ledger.v2.createTransaction()`: \n * `request.v2PostTransaction` **Changed**\n * `response.data.updatedAt` **Added**\n* `sdk.ledger.v2.getAccount()`: `response.data` **Changed**\n* `sdk.ledger.v2.getLedger()`: `response.data` **Changed**\n* `sdk.ledger.v2.getTransaction()`: `response.data.updatedAt` **Added**\n* `sdk.ledger.getInfo()`: **Added**\n* `sdk.ledger.v2.createExporter()`: **Added**\n* `sdk.ledger.v2.listAccounts()`: \n * `request.sort` **Added**\n * `response.cursor.data.[]` **Changed**\n* `sdk.ledger.v2.createPipeline()`: **Added**\n* `sdk.ledger.v2.listTransactions()`: \n * `request.sort` **Added**\n * `response.cursor.data.[].updatedAt` **Added**\n* `sdk.ledger.v2.revertTransaction()`: \n * `request.v2RevertTransactionRequest` **Added**\n * `response.data.updatedAt` **Added**\n* `sdk.ledger.getMetrics()`: **Added**\n* `sdk.orchestration.v1.createTrigger()`: \n * `request.version` **Added**\n * `response.data.version` **Added**\n* `sdk.orchestration.v1.getInstance()`: `response.data.workflow` **Added**\n* `sdk.orchestration.v1.listInstances()`: `response.data.[].workflow` **Added**\n* `sdk.orchestration.v1.listTriggers()`: `response.data.[].version` **Added**\n* `sdk.orchestration.v1.listTriggersOccurrences()`: `response.data.[].workflowInstance.workflow` **Added**\n* `sdk.orchestration.v1.readTrigger()`: `response.data.version` **Added**\n* `sdk.orchestration.v1.runWorkflow()`: `response.data.workflow` **Added**\n* `sdk.orchestration.v2.createTrigger()`: \n * `request.version` **Added**\n * `response.data.version` **Added**\n* `sdk.orchestration.v2.getInstance()`: `response.data.workflow` **Added**\n* `sdk.orchestration.v2.listInstances()`: `response.cursor.data.[].workflow` **Added**\n* `sdk.orchestration.v2.listTriggers()`: `response.cursor.data.[].version` **Added**\n* `sdk.orchestration.v2.listTriggersOccurrences()`: `response.cursor.data.[].workflowInstance.workflow` **Added**\n* `sdk.orchestration.v2.readTrigger()`: `response.data.version` **Added**\n* `sdk.orchestration.v2.runWorkflow()`: `response.data.workflow` **Added**\n* `sdk.reconciliation.v1.listPolicies()`: \n * `request.query` **Added**\n* `sdk.reconciliation.v1.listReconciliations()`: \n * `request.query` **Added**\n" diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 665ebac2..faab3493 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.617.1 +speakeasyVersion: 1.634.2 sources: stacks-source: sourceNamespace: stacks-source - sourceRevisionDigest: sha256:c2e0908b4ec7fd97c23be1d1b139a6cddbf2c76af32c8f563a6335b6f42aa299 - sourceBlobDigest: sha256:5825b1df8d67cfd921782e30aee3af32e31344f9030fd4db2c042a9d188e640f + sourceRevisionDigest: sha256:12ddec7c369ca6544786c4d28f1bae255f3378b6f3fb52f8979152c570c4200e + sourceBlobDigest: sha256:3e93d94c02942a5b3b9f0610ff8d01e82347f6ea68a1eaebedfdf39f629f439b tags: - latest - - speakeasy-sdk-regen-1754440192 + - speakeasy-sdk-regen-1759364674 - v3.1.0 targets: formance-sdk-typescript: source: stacks-source sourceNamespace: stacks-source - sourceRevisionDigest: sha256:c2e0908b4ec7fd97c23be1d1b139a6cddbf2c76af32c8f563a6335b6f42aa299 - sourceBlobDigest: sha256:5825b1df8d67cfd921782e30aee3af32e31344f9030fd4db2c042a9d188e640f + sourceRevisionDigest: sha256:12ddec7c369ca6544786c4d28f1bae255f3378b6f3fb52f8979152c570c4200e + sourceBlobDigest: sha256:3e93d94c02942a5b3b9f0610ff8d01e82347f6ea68a1eaebedfdf39f629f439b codeSamplesNamespace: stacks-source-typescript-code-samples - codeSamplesRevisionDigest: sha256:da2fafa8476c6eafbf141367833f33228493aed9339ec55c5ec2f0ab118c8e91 + codeSamplesRevisionDigest: sha256:a5522263b0fc125d75ce8cf89a43b02959b85de1e737cacb357f6340b3947e54 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 05399114..4424b344 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,6 @@ and standard method from web, mobile and desktop applications. ## Table of Contents * [@formance/formance-sdk](#formanceformance-sdk) - * [🏗 **Welcome to your new SDK!** 🏗](#welcome-to-your-new-sdk) * [Introduction](#introduction) * [Authentication](#authentication) * [SDK Installation](#sdk-installation) @@ -74,10 +73,7 @@ bun add @formance/formance-sdk ### Yarn ```bash -yarn add @formance/formance-sdk zod - -# Note that Yarn does not install peer dependencies automatically. You will need -# to install zod as shown above. +yarn add @formance/formance-sdk ``` @@ -138,6 +134,8 @@ run(); ### [ledger](docs/sdks/ledger/README.md) +* [getInfo](docs/sdks/ledger/README.md#getinfo) - Show server information +* [getMetrics](docs/sdks/ledger/README.md#getmetrics) - Read in memory metrics #### [ledger.v1](docs/sdks/ledgerv1/README.md) @@ -169,27 +167,36 @@ run(); * [countAccounts](docs/sdks/ledgerv2/README.md#countaccounts) - Count the accounts from a ledger * [countTransactions](docs/sdks/ledgerv2/README.md#counttransactions) - Count the transactions from a ledger * [createBulk](docs/sdks/ledgerv2/README.md#createbulk) - Bulk request +* [createExporter](docs/sdks/ledgerv2/README.md#createexporter) - Create exporter * [createLedger](docs/sdks/ledgerv2/README.md#createledger) - Create a ledger +* [createPipeline](docs/sdks/ledgerv2/README.md#createpipeline) - Create pipeline * [createTransaction](docs/sdks/ledgerv2/README.md#createtransaction) - Create a new transaction to a ledger * [deleteAccountMetadata](docs/sdks/ledgerv2/README.md#deleteaccountmetadata) - Delete metadata by key +* [deleteExporter](docs/sdks/ledgerv2/README.md#deleteexporter) - Delete exporter * [deleteLedgerMetadata](docs/sdks/ledgerv2/README.md#deleteledgermetadata) - Delete ledger metadata by key +* [deletePipeline](docs/sdks/ledgerv2/README.md#deletepipeline) - Delete pipeline * [deleteTransactionMetadata](docs/sdks/ledgerv2/README.md#deletetransactionmetadata) - Delete metadata by key * [exportLogs](docs/sdks/ledgerv2/README.md#exportlogs) - Export logs * [getAccount](docs/sdks/ledgerv2/README.md#getaccount) - Get account by its address * [getBalancesAggregated](docs/sdks/ledgerv2/README.md#getbalancesaggregated) - Get the aggregated balances from selected accounts -* [getInfo](docs/sdks/ledgerv2/README.md#getinfo) - Show server information +* [getExporterState](docs/sdks/ledgerv2/README.md#getexporterstate) - Get exporter state * [getLedger](docs/sdks/ledgerv2/README.md#getledger) - Get a ledger * [getLedgerInfo](docs/sdks/ledgerv2/README.md#getledgerinfo) - Get information about a ledger -* [getMetrics](docs/sdks/ledgerv2/README.md#getmetrics) - Read in memory metrics +* [getPipelineState](docs/sdks/ledgerv2/README.md#getpipelinestate) - Get pipeline state * [getTransaction](docs/sdks/ledgerv2/README.md#gettransaction) - Get transaction from a ledger by its ID * [getVolumesWithBalances](docs/sdks/ledgerv2/README.md#getvolumeswithbalances) - Get list of volumes with balances for (account/asset) * [importLogs](docs/sdks/ledgerv2/README.md#importlogs) * [listAccounts](docs/sdks/ledgerv2/README.md#listaccounts) - List accounts from a ledger +* [listExporters](docs/sdks/ledgerv2/README.md#listexporters) - List exporters * [listLedgers](docs/sdks/ledgerv2/README.md#listledgers) - List ledgers * [listLogs](docs/sdks/ledgerv2/README.md#listlogs) - List the logs from a ledger +* [listPipelines](docs/sdks/ledgerv2/README.md#listpipelines) - List pipelines * [listTransactions](docs/sdks/ledgerv2/README.md#listtransactions) - List transactions from a ledger * [readStats](docs/sdks/ledgerv2/README.md#readstats) - Get statistics from a ledger +* [resetPipeline](docs/sdks/ledgerv2/README.md#resetpipeline) - Reset pipeline * [revertTransaction](docs/sdks/ledgerv2/README.md#reverttransaction) - Revert a ledger transaction by its ID +* [startPipeline](docs/sdks/ledgerv2/README.md#startpipeline) - Start pipeline +* [stopPipeline](docs/sdks/ledgerv2/README.md#stoppipeline) - Stop pipeline * [updateLedgerMetadata](docs/sdks/ledgerv2/README.md#updateledgermetadata) - Update ledger metadata ### [orchestration](docs/sdks/orchestration/README.md) @@ -432,14 +439,7 @@ const sdk = new SDK({ async function run() { try { - const result = await sdk.ledger.v2.addMetadataOnTransaction({ - requestBody: { - "admin": "true", - }, - dryRun: true, - id: 1234n, - ledger: "ledger001", - }); + const result = await sdk.ledger.getInfo(); console.log(result); } catch (error) { @@ -481,15 +481,15 @@ run(); **Inherit from [`SDKBaseError`](./src/sdk/models/errors/sdkbaseerror.ts)**: -* [`V3ErrorResponse`](./src/sdk/models/errors/v3errorresponse.ts): Error. Applicable to 46 of 219 methods.* -* [`PaymentsErrorResponse`](./src/sdk/models/errors/paymentserrorresponse.ts): Error. Applicable to 45 of 219 methods.* -* [`V2ErrorResponse`](./src/sdk/models/errors/v2errorresponse.ts): Error. Applicable to 26 of 219 methods.* -* [`ErrorResponse`](./src/sdk/models/errors/errorresponse.ts): Applicable to 19 of 219 methods.* -* [`V2Error`](./src/sdk/models/errors/v2error.ts): General error. Applicable to 18 of 219 methods.* -* [`ErrorT`](./src/sdk/models/errors/errort.ts): General error. Applicable to 17 of 219 methods.* -* [`WalletsErrorResponse`](./src/sdk/models/errors/walletserrorresponse.ts): Applicable to 15 of 219 methods.* -* [`ReconciliationErrorResponse`](./src/sdk/models/errors/reconciliationerrorresponse.ts): Error response. Applicable to 8 of 219 methods.* -* [`WebhooksErrorResponse`](./src/sdk/models/errors/webhookserrorresponse.ts): Error. Applicable to 8 of 219 methods.* +* [`V3ErrorResponse`](./src/sdk/models/errors/v3errorresponse.ts): Error. Applicable to 46 of 230 methods.* +* [`PaymentsErrorResponse`](./src/sdk/models/errors/paymentserrorresponse.ts): Error. Applicable to 45 of 230 methods.* +* [`V2ErrorResponse`](./src/sdk/models/errors/v2errorresponse.ts): Error. Applicable to 37 of 230 methods.* +* [`ErrorResponse`](./src/sdk/models/errors/errorresponse.ts): Applicable to 19 of 230 methods.* +* [`V2Error`](./src/sdk/models/errors/v2error.ts): General error. Applicable to 18 of 230 methods.* +* [`ErrorT`](./src/sdk/models/errors/errort.ts): General error. Applicable to 17 of 230 methods.* +* [`WalletsErrorResponse`](./src/sdk/models/errors/walletserrorresponse.ts): Applicable to 15 of 230 methods.* +* [`ReconciliationErrorResponse`](./src/sdk/models/errors/reconciliationerrorresponse.ts): Error response. Applicable to 8 of 230 methods.* +* [`WebhooksErrorResponse`](./src/sdk/models/errors/webhookserrorresponse.ts): Error. Applicable to 8 of 230 methods.* * [`ResponseValidationError`](./src/sdk/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string. @@ -511,10 +511,10 @@ You can override the default server globally by passing a server index to the `s If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor: -| Variable | Parameter | Supported Values | Default | Description | -| -------------- | --------------------------------------- | -------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------- | -| `environment` | `environment: models.ServerEnvironment` | - `"eu.sandbox"`
- `"sandbox"`
- `"eu-west-1"`
- `"us-east-1"` | `"eu.sandbox"` | The environment name. Defaults to the production environment. | -| `organization` | `organization: string` | string | `"orgID-stackID"` | The organization name. Defaults to a generic organization. | +| Variable | Parameter | Supported Values | Default | Description | +| -------------- | --------------------------------------- | ----------------------------------------------------- | ----------------- | ------------------------------------------------------------- | +| `environment` | `environment: models.ServerEnvironment` | - `"sandbox"`
- `"eu-west-1"`
- `"us-east-1"` | `"sandbox"` | The environment name. Defaults to the production environment. | +| `organization` | `organization: string` | string | `"orgID-stackID"` | The organization name. Defaults to a generic organization. | #### Example @@ -548,7 +548,7 @@ The default server can also be overridden globally by passing a URL to the `serv import { SDK } from "@formance/formance-sdk"; const sdk = new SDK({ - serverURL: "https://orgID-stackID.eu.sandbox.formance.cloud", + serverURL: "https://orgID-stackID.sandbox.formance.cloud", security: { clientID: "", clientSecret: "", @@ -611,7 +611,7 @@ httpClient.addHook("requestError", (error, request) => { console.groupEnd(); }); -const sdk = new SDK({ httpClient }); +const sdk = new SDK({ httpClient: httpClient }); ``` @@ -675,6 +675,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`authV1ReadUser`](docs/sdks/authv1/README.md#readuser) - Read user - [`authV1UpdateClient`](docs/sdks/authv1/README.md#updateclient) - Update client - [`getVersions`](docs/sdks/sdk/README.md#getversions) - Show stack version information +- [`ledgerGetInfo`](docs/sdks/ledger/README.md#getinfo) - Show server information +- [`ledgerGetMetrics`](docs/sdks/ledger/README.md#getmetrics) - Read in memory metrics - [`ledgerV1AddMetadataOnTransaction`](docs/sdks/ledgerv1/README.md#addmetadataontransaction) - Set the metadata of a transaction by its ID - [`ledgerV1AddMetadataToAccount`](docs/sdks/ledgerv1/README.md#addmetadatatoaccount) - Add metadata to an account - [`ledgerV1CountAccounts`](docs/sdks/ledgerv1/README.md#countaccounts) - Count the accounts from a ledger @@ -699,27 +701,36 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`ledgerV2CountAccounts`](docs/sdks/ledgerv2/README.md#countaccounts) - Count the accounts from a ledger - [`ledgerV2CountTransactions`](docs/sdks/ledgerv2/README.md#counttransactions) - Count the transactions from a ledger - [`ledgerV2CreateBulk`](docs/sdks/ledgerv2/README.md#createbulk) - Bulk request +- [`ledgerV2CreateExporter`](docs/sdks/ledgerv2/README.md#createexporter) - Create exporter - [`ledgerV2CreateLedger`](docs/sdks/ledgerv2/README.md#createledger) - Create a ledger +- [`ledgerV2CreatePipeline`](docs/sdks/ledgerv2/README.md#createpipeline) - Create pipeline - [`ledgerV2CreateTransaction`](docs/sdks/ledgerv2/README.md#createtransaction) - Create a new transaction to a ledger - [`ledgerV2DeleteAccountMetadata`](docs/sdks/ledgerv2/README.md#deleteaccountmetadata) - Delete metadata by key +- [`ledgerV2DeleteExporter`](docs/sdks/ledgerv2/README.md#deleteexporter) - Delete exporter - [`ledgerV2DeleteLedgerMetadata`](docs/sdks/ledgerv2/README.md#deleteledgermetadata) - Delete ledger metadata by key +- [`ledgerV2DeletePipeline`](docs/sdks/ledgerv2/README.md#deletepipeline) - Delete pipeline - [`ledgerV2DeleteTransactionMetadata`](docs/sdks/ledgerv2/README.md#deletetransactionmetadata) - Delete metadata by key - [`ledgerV2ExportLogs`](docs/sdks/ledgerv2/README.md#exportlogs) - Export logs - [`ledgerV2GetAccount`](docs/sdks/ledgerv2/README.md#getaccount) - Get account by its address - [`ledgerV2GetBalancesAggregated`](docs/sdks/ledgerv2/README.md#getbalancesaggregated) - Get the aggregated balances from selected accounts -- [`ledgerV2GetInfo`](docs/sdks/ledgerv2/README.md#getinfo) - Show server information +- [`ledgerV2GetExporterState`](docs/sdks/ledgerv2/README.md#getexporterstate) - Get exporter state - [`ledgerV2GetLedger`](docs/sdks/ledgerv2/README.md#getledger) - Get a ledger - [`ledgerV2GetLedgerInfo`](docs/sdks/ledgerv2/README.md#getledgerinfo) - Get information about a ledger -- [`ledgerV2GetMetrics`](docs/sdks/ledgerv2/README.md#getmetrics) - Read in memory metrics +- [`ledgerV2GetPipelineState`](docs/sdks/ledgerv2/README.md#getpipelinestate) - Get pipeline state - [`ledgerV2GetTransaction`](docs/sdks/ledgerv2/README.md#gettransaction) - Get transaction from a ledger by its ID - [`ledgerV2GetVolumesWithBalances`](docs/sdks/ledgerv2/README.md#getvolumeswithbalances) - Get list of volumes with balances for (account/asset) - [`ledgerV2ImportLogs`](docs/sdks/ledgerv2/README.md#importlogs) - [`ledgerV2ListAccounts`](docs/sdks/ledgerv2/README.md#listaccounts) - List accounts from a ledger +- [`ledgerV2ListExporters`](docs/sdks/ledgerv2/README.md#listexporters) - List exporters - [`ledgerV2ListLedgers`](docs/sdks/ledgerv2/README.md#listledgers) - List ledgers - [`ledgerV2ListLogs`](docs/sdks/ledgerv2/README.md#listlogs) - List the logs from a ledger +- [`ledgerV2ListPipelines`](docs/sdks/ledgerv2/README.md#listpipelines) - List pipelines - [`ledgerV2ListTransactions`](docs/sdks/ledgerv2/README.md#listtransactions) - List transactions from a ledger - [`ledgerV2ReadStats`](docs/sdks/ledgerv2/README.md#readstats) - Get statistics from a ledger +- [`ledgerV2ResetPipeline`](docs/sdks/ledgerv2/README.md#resetpipeline) - Reset pipeline - [`ledgerV2RevertTransaction`](docs/sdks/ledgerv2/README.md#reverttransaction) - Revert a ledger transaction by its ID +- [`ledgerV2StartPipeline`](docs/sdks/ledgerv2/README.md#startpipeline) - Start pipeline +- [`ledgerV2StopPipeline`](docs/sdks/ledgerv2/README.md#stoppipeline) - Stop pipeline - [`ledgerV2UpdateLedgerMetadata`](docs/sdks/ledgerv2/README.md#updateledgermetadata) - Update ledger metadata - [`orchestrationV1CancelEvent`](docs/sdks/orchestrationv1/README.md#cancelevent) - Cancel a running workflow - [`orchestrationV1CreateTrigger`](docs/sdks/orchestrationv1/README.md#createtrigger) - Create trigger diff --git a/RELEASES.md b/RELEASES.md index 11d9276c..3ca13374 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -306,4 +306,14 @@ Based on: ### Generated - [typescript v4.5.0] . ### Releases -- [NPM v4.5.0] https://www.npmjs.com/package/@formance/formance-sdk/v/4.5.0 - . \ No newline at end of file +- [NPM v4.5.0] https://www.npmjs.com/package/@formance/formance-sdk/v/4.5.0 - . + +## 2025-10-06 11:37:44 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.634.2 (2.721.3) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v4.6.0] . +### Releases +- [NPM v4.6.0] https://www.npmjs.com/package/@formance/formance-sdk/v/4.6.0 - . \ No newline at end of file diff --git a/docs/sdk/models/operations/installconnectorrequest.md b/docs/sdk/models/operations/installconnectorrequest.md index 61df4a2f..c8cf0222 100644 --- a/docs/sdk/models/operations/installconnectorrequest.md +++ b/docs/sdk/models/operations/installconnectorrequest.md @@ -9,10 +9,10 @@ import { Connector } from "@formance/formance-sdk/sdk/models/shared"; let value: InstallConnectorRequest = { connectorConfig: { apiKey: "XXX", - loginID: "XXX", - name: "My CurrencyCloud Account", + endpoint: "XXX", + name: "My Generic Account", pollingPeriod: "60s", - provider: "Currencycloud", + provider: "Generic", }, connector: Connector.Wise, }; diff --git a/docs/sdk/models/operations/listpoliciesrequest.md b/docs/sdk/models/operations/listpoliciesrequest.md index 76fe1ae0..f5a51c91 100644 --- a/docs/sdk/models/operations/listpoliciesrequest.md +++ b/docs/sdk/models/operations/listpoliciesrequest.md @@ -16,4 +16,5 @@ let value: ListPoliciesRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | *string* | :heavy_minus_sign: | Parameter used in pagination requests. Maximum page size is set to 15.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
| aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ== | -| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | \ No newline at end of file +| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | +| `query` | Record | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdk/models/operations/listreconciliationsrequest.md b/docs/sdk/models/operations/listreconciliationsrequest.md index 69830b2b..7b77e08d 100644 --- a/docs/sdk/models/operations/listreconciliationsrequest.md +++ b/docs/sdk/models/operations/listreconciliationsrequest.md @@ -16,4 +16,5 @@ let value: ListReconciliationsRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | *string* | :heavy_minus_sign: | Parameter used in pagination requests. Maximum page size is set to 15.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
| aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ== | -| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | \ No newline at end of file +| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | +| `query` | Record | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdk/models/operations/order.md b/docs/sdk/models/operations/order.md index a9aaca92..768ccebb 100644 --- a/docs/sdk/models/operations/order.md +++ b/docs/sdk/models/operations/order.md @@ -1,5 +1,7 @@ # Order +Deprecated: Use sort param + ## Example Usage ```typescript diff --git a/docs/sdk/models/operations/runscriptresponse.md b/docs/sdk/models/operations/runscriptresponse.md index 219b149e..f2d84551 100644 --- a/docs/sdk/models/operations/runscriptresponse.md +++ b/docs/sdk/models/operations/runscriptresponse.md @@ -13,9 +13,9 @@ let value: RunScriptResponse = { ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | -| `scriptResponse` | [shared.ScriptResponse](../../../sdk/models/shared/scriptresponse.md) | :heavy_minus_sign: | On success, it will return a 200 status code, and the resulting transaction under the `transaction` field.

On failure, it will also return a 200 status code, and the following fields:
- `details`: contains a URL. When there is an error parsing Numscript, the result can be difficult to read—the provided URL will render the error in an easy-to-read format.
- `errorCode` and `error_code` (deprecated): contains the string code of the error
- `errorMessage` and `error_message` (deprecated): contains a human-readable indication of what went wrong, for example that an account had insufficient funds, or that there was an error in the provided Numscript.
| -| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `scriptResponse` | [shared.ScriptResponse](../../../sdk/models/shared/scriptresponse.md) | :heavy_minus_sign: | On success, it will return a 200 status code, and the resulting transaction under the `transaction` field.

On failure, it will also return a 200 status code, and the following fields:

- `details`: contains a URL. When there is an error parsing Numscript, the result can be difficult to read—the provided URL will render the error in an easy-to-read format.
- `errorCode` and `error_code` (deprecated): contains the string code of the error
- `errorMessage` and `error_message` (deprecated): contains a human-readable indication of what went wrong, for example that an account had insufficient funds, or that there was an error in the provided Numscript.
| +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/sdk/models/operations/updateconnectorconfigv1request.md b/docs/sdk/models/operations/updateconnectorconfigv1request.md index 8a362e98..7aeef621 100644 --- a/docs/sdk/models/operations/updateconnectorconfigv1request.md +++ b/docs/sdk/models/operations/updateconnectorconfigv1request.md @@ -8,12 +8,15 @@ import { Connector } from "@formance/formance-sdk/sdk/models/shared"; let value: UpdateConnectorConfigV1Request = { connectorConfig: { - apiKey: "XXX", - clientID: "XXX", + authorizationEndpoint: "XXX", endpoint: "XXX", - name: "My Moneycorp Account", + name: "My Banking Circle Account", + password: "XXX", pollingPeriod: "60s", - provider: "Moneycorp", + provider: "Bankingcircle", + userCertificate: "XXX", + userCertificateKey: "XXX", + username: "XXX", }, connector: Connector.Modulr, connectorId: "XXX", diff --git a/docs/sdk/models/operations/v2createexporterresponse.md b/docs/sdk/models/operations/v2createexporterresponse.md new file mode 100644 index 00000000..93c9d590 --- /dev/null +++ b/docs/sdk/models/operations/v2createexporterresponse.md @@ -0,0 +1,21 @@ +# V2CreateExporterResponse + +## Example Usage + +```typescript +import { V2CreateExporterResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2CreateExporterResponse = { + contentType: "", + statusCode: 384466, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [operations.V2CreateExporterResponseBody](../../../sdk/models/operations/v2createexporterresponsebody.md) | :heavy_minus_sign: | Created exporter | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2createexporterresponsebody.md b/docs/sdk/models/operations/v2createexporterresponsebody.md new file mode 100644 index 00000000..17971540 --- /dev/null +++ b/docs/sdk/models/operations/v2createexporterresponsebody.md @@ -0,0 +1,26 @@ +# V2CreateExporterResponseBody + +Created exporter + +## Example Usage + +```typescript +import { V2CreateExporterResponseBody } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2CreateExporterResponseBody = { + data: { + config: { + "key": "", + }, + createdAt: new Date("2025-10-02T06:10:34.752Z"), + driver: "", + id: "", + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `data` | [shared.V2Exporter](../../../sdk/models/shared/v2exporter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2createpipelinerequest.md b/docs/sdk/models/operations/v2createpipelinerequest.md new file mode 100644 index 00000000..9b222a8c --- /dev/null +++ b/docs/sdk/models/operations/v2createpipelinerequest.md @@ -0,0 +1,18 @@ +# V2CreatePipelineRequest + +## Example Usage + +```typescript +import { V2CreatePipelineRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2CreatePipelineRequest = { + ledger: "ledger001", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `v2CreatePipelineRequest` | [shared.V2CreatePipelineRequest](../../../sdk/models/shared/v2createpipelinerequest.md) | :heavy_minus_sign: | N/A | | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2createpipelineresponse.md b/docs/sdk/models/operations/v2createpipelineresponse.md new file mode 100644 index 00000000..994f1da1 --- /dev/null +++ b/docs/sdk/models/operations/v2createpipelineresponse.md @@ -0,0 +1,21 @@ +# V2CreatePipelineResponse + +## Example Usage + +```typescript +import { V2CreatePipelineResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2CreatePipelineResponse = { + contentType: "", + statusCode: 34820, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [operations.V2CreatePipelineResponseBody](../../../sdk/models/operations/v2createpipelineresponsebody.md) | :heavy_minus_sign: | Created ipeline | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2createpipelineresponsebody.md b/docs/sdk/models/operations/v2createpipelineresponsebody.md new file mode 100644 index 00000000..b9189f71 --- /dev/null +++ b/docs/sdk/models/operations/v2createpipelineresponsebody.md @@ -0,0 +1,24 @@ +# V2CreatePipelineResponseBody + +Created ipeline + +## Example Usage + +```typescript +import { V2CreatePipelineResponseBody } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2CreatePipelineResponseBody = { + data: { + createdAt: new Date("2025-11-17T09:32:55.209Z"), + exporterID: "", + id: "", + ledger: "", + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `data` | [shared.V2Pipeline](../../../sdk/models/shared/v2pipeline.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2createtransactionrequest.md b/docs/sdk/models/operations/v2createtransactionrequest.md index fca71a29..3825fc77 100644 --- a/docs/sdk/models/operations/v2createtransactionrequest.md +++ b/docs/sdk/models/operations/v2createtransactionrequest.md @@ -7,6 +7,14 @@ import { V2CreateTransactionRequest } from "@formance/formance-sdk/sdk/models/op let value: V2CreateTransactionRequest = { v2PostTransaction: { + accountMetadata: { + "key": { + "admin": "true", + }, + "key1": { + "admin": "true", + }, + }, metadata: { "admin": "true", }, @@ -34,7 +42,6 @@ let value: V2CreateTransactionRequest = { }, }, dryRun: true, - force: true, ledger: "ledger001", }; ``` @@ -46,5 +53,5 @@ let value: V2CreateTransactionRequest = { | `idempotencyKey` | *string* | :heavy_minus_sign: | Use an idempotency key | | | `v2PostTransaction` | [shared.V2PostTransaction](../../../sdk/models/shared/v2posttransaction.md) | :heavy_check_mark: | The request body must contain at least one of the following objects:
- `postings`: suitable for simple transactions
- `script`: enabling more complex transactions with Numscript
| | | `dryRun` | *boolean* | :heavy_minus_sign: | Set the dryRun mode. dry run mode doesn't add the logs to the database or publish a message to the message broker. | true | -| `force` | *boolean* | :heavy_minus_sign: | Disable balance checks when passing postings | true | +| ~~`force`~~ | *boolean* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Disable balance checks when passing postings | true | | `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2deleteexporterrequest.md b/docs/sdk/models/operations/v2deleteexporterrequest.md new file mode 100644 index 00000000..70cbee13 --- /dev/null +++ b/docs/sdk/models/operations/v2deleteexporterrequest.md @@ -0,0 +1,17 @@ +# V2DeleteExporterRequest + +## Example Usage + +```typescript +import { V2DeleteExporterRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2DeleteExporterRequest = { + exporterID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `exporterID` | *string* | :heavy_check_mark: | The exporter id | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2deleteexporterresponse.md b/docs/sdk/models/operations/v2deleteexporterresponse.md new file mode 100644 index 00000000..9c250049 --- /dev/null +++ b/docs/sdk/models/operations/v2deleteexporterresponse.md @@ -0,0 +1,20 @@ +# V2DeleteExporterResponse + +## Example Usage + +```typescript +import { V2DeleteExporterResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2DeleteExporterResponse = { + contentType: "", + statusCode: 470343, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2deletepipelinerequest.md b/docs/sdk/models/operations/v2deletepipelinerequest.md new file mode 100644 index 00000000..fc712305 --- /dev/null +++ b/docs/sdk/models/operations/v2deletepipelinerequest.md @@ -0,0 +1,19 @@ +# V2DeletePipelineRequest + +## Example Usage + +```typescript +import { V2DeletePipelineRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2DeletePipelineRequest = { + ledger: "ledger001", + pipelineID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | +| `pipelineID` | *string* | :heavy_check_mark: | The pipeline id | | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2deletepipelineresponse.md b/docs/sdk/models/operations/v2deletepipelineresponse.md new file mode 100644 index 00000000..4bbd80c9 --- /dev/null +++ b/docs/sdk/models/operations/v2deletepipelineresponse.md @@ -0,0 +1,20 @@ +# V2DeletePipelineResponse + +## Example Usage + +```typescript +import { V2DeletePipelineResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2DeletePipelineResponse = { + contentType: "", + statusCode: 694668, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getexporterstaterequest.md b/docs/sdk/models/operations/v2getexporterstaterequest.md new file mode 100644 index 00000000..32e34475 --- /dev/null +++ b/docs/sdk/models/operations/v2getexporterstaterequest.md @@ -0,0 +1,17 @@ +# V2GetExporterStateRequest + +## Example Usage + +```typescript +import { V2GetExporterStateRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2GetExporterStateRequest = { + exporterID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `exporterID` | *string* | :heavy_check_mark: | The exporter id | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getexporterstateresponse.md b/docs/sdk/models/operations/v2getexporterstateresponse.md new file mode 100644 index 00000000..80179176 --- /dev/null +++ b/docs/sdk/models/operations/v2getexporterstateresponse.md @@ -0,0 +1,21 @@ +# V2GetExporterStateResponse + +## Example Usage + +```typescript +import { V2GetExporterStateResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2GetExporterStateResponse = { + contentType: "", + statusCode: 405026, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [operations.V2GetExporterStateResponseBody](../../../sdk/models/operations/v2getexporterstateresponsebody.md) | :heavy_minus_sign: | Exporter information | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getexporterstateresponsebody.md b/docs/sdk/models/operations/v2getexporterstateresponsebody.md new file mode 100644 index 00000000..4e0c200a --- /dev/null +++ b/docs/sdk/models/operations/v2getexporterstateresponsebody.md @@ -0,0 +1,26 @@ +# V2GetExporterStateResponseBody + +Exporter information + +## Example Usage + +```typescript +import { V2GetExporterStateResponseBody } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2GetExporterStateResponseBody = { + data: { + config: { + "key": "", + }, + createdAt: new Date("2025-10-02T06:10:34.752Z"), + driver: "", + id: "", + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `data` | [shared.V2Exporter](../../../sdk/models/shared/v2exporter.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getpipelinestaterequest.md b/docs/sdk/models/operations/v2getpipelinestaterequest.md new file mode 100644 index 00000000..73bac478 --- /dev/null +++ b/docs/sdk/models/operations/v2getpipelinestaterequest.md @@ -0,0 +1,19 @@ +# V2GetPipelineStateRequest + +## Example Usage + +```typescript +import { V2GetPipelineStateRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2GetPipelineStateRequest = { + ledger: "ledger001", + pipelineID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | +| `pipelineID` | *string* | :heavy_check_mark: | The pipeline id | | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getpipelinestateresponse.md b/docs/sdk/models/operations/v2getpipelinestateresponse.md new file mode 100644 index 00000000..4faed0f6 --- /dev/null +++ b/docs/sdk/models/operations/v2getpipelinestateresponse.md @@ -0,0 +1,21 @@ +# V2GetPipelineStateResponse + +## Example Usage + +```typescript +import { V2GetPipelineStateResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2GetPipelineStateResponse = { + contentType: "", + statusCode: 150498, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [operations.V2GetPipelineStateResponseBody](../../../sdk/models/operations/v2getpipelinestateresponsebody.md) | :heavy_minus_sign: | Pipeline information | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getpipelinestateresponsebody.md b/docs/sdk/models/operations/v2getpipelinestateresponsebody.md new file mode 100644 index 00000000..3ec6f16c --- /dev/null +++ b/docs/sdk/models/operations/v2getpipelinestateresponsebody.md @@ -0,0 +1,24 @@ +# V2GetPipelineStateResponseBody + +Pipeline information + +## Example Usage + +```typescript +import { V2GetPipelineStateResponseBody } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2GetPipelineStateResponseBody = { + data: { + createdAt: new Date("2025-11-17T09:32:55.209Z"), + exporterID: "", + id: "", + ledger: "", + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `data` | [shared.V2Pipeline](../../../sdk/models/shared/v2pipeline.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2getvolumeswithbalancesrequest.md b/docs/sdk/models/operations/v2getvolumeswithbalancesrequest.md index 766ab149..83fa0406 100644 --- a/docs/sdk/models/operations/v2getvolumeswithbalancesrequest.md +++ b/docs/sdk/models/operations/v2getvolumeswithbalancesrequest.md @@ -10,6 +10,7 @@ let value: V2GetVolumesWithBalancesRequest = { groupBy: 3, ledger: "ledger001", pageSize: 100, + sort: "id:desc", }; ``` @@ -24,4 +25,5 @@ let value: V2GetVolumesWithBalancesRequest = { | `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | | `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | | `query` | Record | :heavy_minus_sign: | N/A | | +| `sort` | *string* | :heavy_minus_sign: | Sort results using a field name and order (ascending or descending).
Format: `:`, where `` is the field name and `` is either `asc` or `desc`.
| id:desc | | `startTime` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listaccountsrequest.md b/docs/sdk/models/operations/v2listaccountsrequest.md index 4c613a90..178eaf06 100644 --- a/docs/sdk/models/operations/v2listaccountsrequest.md +++ b/docs/sdk/models/operations/v2listaccountsrequest.md @@ -9,6 +9,7 @@ let value: V2ListAccountsRequest = { cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", pageSize: 100, + sort: "id:desc", }; ``` @@ -21,4 +22,5 @@ let value: V2ListAccountsRequest = { | `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | | `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | | `pit` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | -| `query` | Record | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `query` | Record | :heavy_minus_sign: | N/A | | +| `sort` | *string* | :heavy_minus_sign: | Sort results using a field name and order (ascending or descending).
Format: `:`, where `` is the field name and `` is either `asc` or `desc`.
| id:desc | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listexporterscursor1.md b/docs/sdk/models/operations/v2listexporterscursor1.md new file mode 100644 index 00000000..9a97c01f --- /dev/null +++ b/docs/sdk/models/operations/v2listexporterscursor1.md @@ -0,0 +1,34 @@ +# V2ListExportersCursor1 + +## Example Usage + +```typescript +import { V2ListExportersCursor1 } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListExportersCursor1 = { + cursor: { + data: [ + { + config: { + "key": "", + "key1": "", + }, + createdAt: new Date("2023-06-13T00:54:54.124Z"), + driver: "", + id: "", + }, + ], + hasMore: false, + next: "", + pageSize: 15, + previous: "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=", + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `cursor` | [operations.V2ListExportersCursor2](../../../sdk/models/operations/v2listexporterscursor2.md) | :heavy_check_mark: | N/A | +| `data` | [shared.V2Exporter](../../../sdk/models/shared/v2exporter.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listexporterscursor2.md b/docs/sdk/models/operations/v2listexporterscursor2.md new file mode 100644 index 00000000..a4702aee --- /dev/null +++ b/docs/sdk/models/operations/v2listexporterscursor2.md @@ -0,0 +1,35 @@ +# V2ListExportersCursor2 + +## Example Usage + +```typescript +import { V2ListExportersCursor2 } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListExportersCursor2 = { + data: [ + { + config: { + "key": "", + "key1": "", + }, + createdAt: new Date("2023-06-13T00:54:54.124Z"), + driver: "", + id: "", + }, + ], + hasMore: false, + next: "", + pageSize: 15, + previous: "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `data` | [shared.V2Exporter](../../../sdk/models/shared/v2exporter.md)[] | :heavy_check_mark: | N/A | | +| `hasMore` | *boolean* | :heavy_check_mark: | N/A | false | +| `next` | *string* | :heavy_minus_sign: | N/A | | +| `pageSize` | *number* | :heavy_check_mark: | N/A | 15 | +| `previous` | *string* | :heavy_minus_sign: | N/A | YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol= | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listexportersresponse.md b/docs/sdk/models/operations/v2listexportersresponse.md new file mode 100644 index 00000000..8804970a --- /dev/null +++ b/docs/sdk/models/operations/v2listexportersresponse.md @@ -0,0 +1,21 @@ +# V2ListExportersResponse + +## Example Usage + +```typescript +import { V2ListExportersResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListExportersResponse = { + contentType: "", + statusCode: 22756, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [operations.V2ListExportersResponseBody](../../../sdk/models/operations/v2listexportersresponsebody.md) | :heavy_minus_sign: | Exporters list | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listexportersresponsebody.md b/docs/sdk/models/operations/v2listexportersresponsebody.md new file mode 100644 index 00000000..3b28d817 --- /dev/null +++ b/docs/sdk/models/operations/v2listexportersresponsebody.md @@ -0,0 +1,37 @@ +# V2ListExportersResponseBody + +Exporters list + +## Example Usage + +```typescript +import { V2ListExportersResponseBody } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListExportersResponseBody = { + cursor: { + cursor: { + data: [ + { + config: { + "key": "", + "key1": "", + }, + createdAt: new Date("2023-06-13T00:54:54.124Z"), + driver: "", + id: "", + }, + ], + hasMore: false, + next: "", + pageSize: 15, + previous: "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=", + }, + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `cursor` | [operations.V2ListExportersCursor1](../../../sdk/models/operations/v2listexporterscursor1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listledgersrequest.md b/docs/sdk/models/operations/v2listledgersrequest.md index 707bab27..c8bb66f2 100644 --- a/docs/sdk/models/operations/v2listledgersrequest.md +++ b/docs/sdk/models/operations/v2listledgersrequest.md @@ -8,6 +8,7 @@ import { V2ListLedgersRequest } from "@formance/formance-sdk/sdk/models/operatio let value: V2ListLedgersRequest = { cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", pageSize: 100, + sort: "id:desc", }; ``` @@ -16,4 +17,5 @@ let value: V2ListLedgersRequest = { | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | *string* | :heavy_minus_sign: | Parameter used in pagination requests. Maximum page size is set to 15.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
| aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ== | -| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | \ No newline at end of file +| `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | +| `sort` | *string* | :heavy_minus_sign: | Sort results using a field name and order (ascending or descending).
Format: `:`, where `` is the field name and `` is either `asc` or `desc`.
| id:desc | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listlogsrequest.md b/docs/sdk/models/operations/v2listlogsrequest.md index dc3a3607..1a2b26c7 100644 --- a/docs/sdk/models/operations/v2listlogsrequest.md +++ b/docs/sdk/models/operations/v2listlogsrequest.md @@ -9,6 +9,7 @@ let value: V2ListLogsRequest = { cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", pageSize: 100, + sort: "id:desc", }; ``` @@ -20,4 +21,5 @@ let value: V2ListLogsRequest = { | `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | | `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | | `pit` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | -| `query` | Record | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `query` | Record | :heavy_minus_sign: | N/A | | +| `sort` | *string* | :heavy_minus_sign: | Sort results using a field name and order (ascending or descending).
Format: `:`, where `` is the field name and `` is either `asc` or `desc`.
| id:desc | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listpipelinescursor1.md b/docs/sdk/models/operations/v2listpipelinescursor1.md new file mode 100644 index 00000000..5e6761ac --- /dev/null +++ b/docs/sdk/models/operations/v2listpipelinescursor1.md @@ -0,0 +1,31 @@ +# V2ListPipelinesCursor1 + +## Example Usage + +```typescript +import { V2ListPipelinesCursor1 } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListPipelinesCursor1 = { + cursor: { + data: [ + { + createdAt: new Date("2023-07-14T16:04:01.498Z"), + exporterID: "", + id: "", + ledger: "", + }, + ], + hasMore: false, + next: "", + pageSize: 15, + previous: "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=", + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `cursor` | [operations.V2ListPipelinesCursor2](../../../sdk/models/operations/v2listpipelinescursor2.md) | :heavy_check_mark: | N/A | +| `data` | [shared.V2Pipeline](../../../sdk/models/shared/v2pipeline.md)[] | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listpipelinescursor2.md b/docs/sdk/models/operations/v2listpipelinescursor2.md new file mode 100644 index 00000000..f5c4782a --- /dev/null +++ b/docs/sdk/models/operations/v2listpipelinescursor2.md @@ -0,0 +1,25 @@ +# V2ListPipelinesCursor2 + +## Example Usage + +```typescript +import { V2ListPipelinesCursor2 } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListPipelinesCursor2 = { + data: [], + hasMore: false, + next: "", + pageSize: 15, + previous: "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `data` | [shared.V2Pipeline](../../../sdk/models/shared/v2pipeline.md)[] | :heavy_check_mark: | N/A | | +| `hasMore` | *boolean* | :heavy_check_mark: | N/A | false | +| `next` | *string* | :heavy_minus_sign: | N/A | | +| `pageSize` | *number* | :heavy_check_mark: | N/A | 15 | +| `previous` | *string* | :heavy_minus_sign: | N/A | YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol= | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listpipelinesrequest.md b/docs/sdk/models/operations/v2listpipelinesrequest.md new file mode 100644 index 00000000..ed6e3176 --- /dev/null +++ b/docs/sdk/models/operations/v2listpipelinesrequest.md @@ -0,0 +1,17 @@ +# V2ListPipelinesRequest + +## Example Usage + +```typescript +import { V2ListPipelinesRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListPipelinesRequest = { + ledger: "ledger001", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listpipelinesresponse.md b/docs/sdk/models/operations/v2listpipelinesresponse.md new file mode 100644 index 00000000..ea4af9d3 --- /dev/null +++ b/docs/sdk/models/operations/v2listpipelinesresponse.md @@ -0,0 +1,21 @@ +# V2ListPipelinesResponse + +## Example Usage + +```typescript +import { V2ListPipelinesResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListPipelinesResponse = { + contentType: "", + statusCode: 518680, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [operations.V2ListPipelinesResponseBody](../../../sdk/models/operations/v2listpipelinesresponsebody.md) | :heavy_minus_sign: | Pipelines list | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listpipelinesresponsebody.md b/docs/sdk/models/operations/v2listpipelinesresponsebody.md new file mode 100644 index 00000000..f7197b9b --- /dev/null +++ b/docs/sdk/models/operations/v2listpipelinesresponsebody.md @@ -0,0 +1,34 @@ +# V2ListPipelinesResponseBody + +Pipelines list + +## Example Usage + +```typescript +import { V2ListPipelinesResponseBody } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ListPipelinesResponseBody = { + cursor: { + cursor: { + data: [ + { + createdAt: new Date("2023-07-14T16:04:01.498Z"), + exporterID: "", + id: "", + ledger: "", + }, + ], + hasMore: false, + next: "", + pageSize: 15, + previous: "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=", + }, + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `cursor` | [operations.V2ListPipelinesCursor1](../../../sdk/models/operations/v2listpipelinescursor1.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2listtransactionsrequest.md b/docs/sdk/models/operations/v2listtransactionsrequest.md index df8a65be..d856a5d3 100644 --- a/docs/sdk/models/operations/v2listtransactionsrequest.md +++ b/docs/sdk/models/operations/v2listtransactionsrequest.md @@ -9,6 +9,7 @@ let value: V2ListTransactionsRequest = { cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", pageSize: 100, + sort: "id:desc", }; ``` @@ -19,8 +20,9 @@ let value: V2ListTransactionsRequest = { | `cursor` | *string* | :heavy_minus_sign: | Parameter used in pagination requests. Maximum page size is set to 15.
Set to the value of next for the next page of results.
Set to the value of previous for the previous page of results.
No other parameters can be set when this parameter is set.
| aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ== | | `expand` | *string* | :heavy_minus_sign: | N/A | | | `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | -| `order` | [operations.Order](../../../sdk/models/operations/order.md) | :heavy_minus_sign: | N/A | | +| ~~`order`~~ | [operations.Order](../../../sdk/models/operations/order.md) | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated: Use sort param | | | `pageSize` | *number* | :heavy_minus_sign: | The maximum number of results to return per page.
| 100 | | `pit` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | | `query` | Record | :heavy_minus_sign: | N/A | | -| `reverse` | *boolean* | :heavy_minus_sign: | N/A | | \ No newline at end of file +| `reverse` | *boolean* | :heavy_minus_sign: | N/A | | +| `sort` | *string* | :heavy_minus_sign: | Sort results using a field name and order (ascending or descending).
Format: `:`, where `` is the field name and `` is either `asc` or `desc`.
| id:desc | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2resetpipelinerequest.md b/docs/sdk/models/operations/v2resetpipelinerequest.md new file mode 100644 index 00000000..64e62580 --- /dev/null +++ b/docs/sdk/models/operations/v2resetpipelinerequest.md @@ -0,0 +1,19 @@ +# V2ResetPipelineRequest + +## Example Usage + +```typescript +import { V2ResetPipelineRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ResetPipelineRequest = { + ledger: "ledger001", + pipelineID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | +| `pipelineID` | *string* | :heavy_check_mark: | The pipeline id | | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2resetpipelineresponse.md b/docs/sdk/models/operations/v2resetpipelineresponse.md new file mode 100644 index 00000000..87dac81f --- /dev/null +++ b/docs/sdk/models/operations/v2resetpipelineresponse.md @@ -0,0 +1,20 @@ +# V2ResetPipelineResponse + +## Example Usage + +```typescript +import { V2ResetPipelineResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2ResetPipelineResponse = { + contentType: "", + statusCode: 52395, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2reverttransactionrequest.md b/docs/sdk/models/operations/v2reverttransactionrequest.md index 55532d14..7459840a 100644 --- a/docs/sdk/models/operations/v2reverttransactionrequest.md +++ b/docs/sdk/models/operations/v2reverttransactionrequest.md @@ -16,6 +16,7 @@ let value: V2RevertTransactionRequest = { | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | +| `v2RevertTransactionRequest` | [shared.V2RevertTransactionRequest](../../../sdk/models/shared/v2reverttransactionrequest.md) | :heavy_minus_sign: | N/A | | | `atEffectiveDate` | *boolean* | :heavy_minus_sign: | Revert transaction at effective date of the original tx | | | `dryRun` | *boolean* | :heavy_minus_sign: | Set the dryRun mode. dry run mode doesn't add the logs to the database or publish a message to the message broker. | true | | `force` | *boolean* | :heavy_minus_sign: | Force revert | | diff --git a/docs/sdk/models/operations/v2startpipelinerequest.md b/docs/sdk/models/operations/v2startpipelinerequest.md new file mode 100644 index 00000000..aca4788d --- /dev/null +++ b/docs/sdk/models/operations/v2startpipelinerequest.md @@ -0,0 +1,19 @@ +# V2StartPipelineRequest + +## Example Usage + +```typescript +import { V2StartPipelineRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2StartPipelineRequest = { + ledger: "ledger001", + pipelineID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | +| `pipelineID` | *string* | :heavy_check_mark: | The pipeline id | | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2startpipelineresponse.md b/docs/sdk/models/operations/v2startpipelineresponse.md new file mode 100644 index 00000000..7fa7ed05 --- /dev/null +++ b/docs/sdk/models/operations/v2startpipelineresponse.md @@ -0,0 +1,20 @@ +# V2StartPipelineResponse + +## Example Usage + +```typescript +import { V2StartPipelineResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2StartPipelineResponse = { + contentType: "", + statusCode: 884193, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2stoppipelinerequest.md b/docs/sdk/models/operations/v2stoppipelinerequest.md new file mode 100644 index 00000000..6cdf6756 --- /dev/null +++ b/docs/sdk/models/operations/v2stoppipelinerequest.md @@ -0,0 +1,19 @@ +# V2StopPipelineRequest + +## Example Usage + +```typescript +import { V2StopPipelineRequest } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2StopPipelineRequest = { + ledger: "ledger001", + pipelineID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------- | ------------------- | ------------------- | ------------------- | ------------------- | +| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 | +| `pipelineID` | *string* | :heavy_check_mark: | The pipeline id | | \ No newline at end of file diff --git a/docs/sdk/models/operations/v2stoppipelineresponse.md b/docs/sdk/models/operations/v2stoppipelineresponse.md new file mode 100644 index 00000000..d53ae11f --- /dev/null +++ b/docs/sdk/models/operations/v2stoppipelineresponse.md @@ -0,0 +1,20 @@ +# V2StopPipelineResponse + +## Example Usage + +```typescript +import { V2StopPipelineResponse } from "@formance/formance-sdk/sdk/models/operations"; + +let value: V2StopPipelineResponse = { + contentType: "", + statusCode: 309928, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `contentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *number* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | \ No newline at end of file diff --git a/docs/sdk/models/shared/connectorconfig.md b/docs/sdk/models/shared/connectorconfig.md index 1ef319f4..dbe6d22c 100644 --- a/docs/sdk/models/shared/connectorconfig.md +++ b/docs/sdk/models/shared/connectorconfig.md @@ -3,45 +3,6 @@ ## Supported Types -### `shared.BankingCircleConfig` - -```typescript -const value: shared.BankingCircleConfig = { - authorizationEndpoint: "XXX", - endpoint: "XXX", - name: "My Banking Circle Account", - password: "XXX", - pollingPeriod: "60s", - userCertificate: "XXX", - userCertificateKey: "XXX", - username: "XXX", -}; -``` - -### `shared.MangoPayConfig` - -```typescript -const value: shared.MangoPayConfig = { - apiKey: "XXX", - clientID: "XXX", - endpoint: "XXX", - name: "My MangoPay Account", - pollingPeriod: "60s", -}; -``` - -### `shared.MoneycorpConfig` - -```typescript -const value: shared.MoneycorpConfig = { - apiKey: "XXX", - clientID: "XXX", - endpoint: "XXX", - name: "My Moneycorp Account", - pollingPeriod: "60s", -}; -``` - ### `shared.AdyenConfig` ```typescript @@ -68,6 +29,21 @@ const value: shared.AtlarConfig = { }; ``` +### `shared.BankingCircleConfig` + +```typescript +const value: shared.BankingCircleConfig = { + authorizationEndpoint: "XXX", + endpoint: "XXX", + name: "My Banking Circle Account", + password: "XXX", + pollingPeriod: "60s", + userCertificate: "XXX", + userCertificateKey: "XXX", + username: "XXX", +}; +``` + ### `shared.CurrencyCloudConfig` ```typescript @@ -80,6 +56,16 @@ const value: shared.CurrencyCloudConfig = { }; ``` +### `shared.DummyPayConfig` + +```typescript +const value: shared.DummyPayConfig = { + directory: "/tmp/dummypay", + filePollingPeriod: "60s", + name: "My DummyPay Account", +}; +``` + ### `shared.GenericConfig` ```typescript @@ -91,6 +77,18 @@ const value: shared.GenericConfig = { }; ``` +### `shared.MangoPayConfig` + +```typescript +const value: shared.MangoPayConfig = { + apiKey: "XXX", + clientID: "XXX", + endpoint: "XXX", + name: "My MangoPay Account", + pollingPeriod: "60s", +}; +``` + ### `shared.ModulrConfig` ```typescript @@ -103,13 +101,15 @@ const value: shared.ModulrConfig = { }; ``` -### `shared.DummyPayConfig` +### `shared.MoneycorpConfig` ```typescript -const value: shared.DummyPayConfig = { - directory: "/tmp/dummypay", - filePollingPeriod: "60s", - name: "My DummyPay Account", +const value: shared.MoneycorpConfig = { + apiKey: "XXX", + clientID: "XXX", + endpoint: "XXX", + name: "My Moneycorp Account", + pollingPeriod: "60s", }; ``` diff --git a/docs/sdk/models/shared/connectorconfigresponse.md b/docs/sdk/models/shared/connectorconfigresponse.md index a9c8981d..cc81e041 100644 --- a/docs/sdk/models/shared/connectorconfigresponse.md +++ b/docs/sdk/models/shared/connectorconfigresponse.md @@ -9,14 +9,10 @@ import { ConnectorConfigResponse } from "@formance/formance-sdk/sdk/models/share let value: ConnectorConfigResponse = { data: { - accessKey: "XXX", - baseUrl: "https://api.example.com", - name: "My Atlar Account", - pageSize: 50, - pollingPeriod: "60s", - provider: "Atlar", - secret: "XXX", - transferInitiationStatusPollingPeriod: "60s", + directory: "/tmp/dummypay", + filePollingPeriod: "60s", + name: "My DummyPay Account", + provider: "Dummypay", }, }; ``` diff --git a/docs/sdk/models/shared/orchestrationv2account.md b/docs/sdk/models/shared/orchestrationv2account.md new file mode 100644 index 00000000..3fb45f23 --- /dev/null +++ b/docs/sdk/models/shared/orchestrationv2account.md @@ -0,0 +1,47 @@ +# OrchestrationV2Account + +## Example Usage + +```typescript +import { OrchestrationV2Account } from "@formance/formance-sdk/sdk/models/shared"; + +let value: OrchestrationV2Account = { + address: "users:001", + effectiveVolumes: { + "USD": { + balance: 90n, + input: 100n, + output: 10n, + }, + "EUR": { + balance: 90n, + input: 100n, + output: 10n, + }, + }, + metadata: { + "admin": "true", + }, + volumes: { + "USD": { + balance: 90n, + input: 100n, + output: 10n, + }, + "EUR": { + balance: 90n, + input: 100n, + output: 10n, + }, + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `address` | *string* | :heavy_check_mark: | N/A | users:001 | +| `effectiveVolumes` | Record | :heavy_minus_sign: | N/A | {
"USD": {
"input": 100,
"output": 10,
"balance": 90
},
"EUR": {
"input": 100,
"output": 10,
"balance": 90
}
} | +| `metadata` | Record | :heavy_check_mark: | N/A | {
"admin": "true"
} | +| `volumes` | Record | :heavy_minus_sign: | N/A | {
"USD": {
"input": 100,
"output": 10,
"balance": 90
},
"EUR": {
"input": 100,
"output": 10,
"balance": 90
}
} | \ No newline at end of file diff --git a/docs/sdk/models/shared/runtime.md b/docs/sdk/models/shared/runtime.md new file mode 100644 index 00000000..bc4fcad8 --- /dev/null +++ b/docs/sdk/models/shared/runtime.md @@ -0,0 +1,18 @@ +# Runtime + +The numscript runtime used to execute the script. Uses "machine" by default, unless the "--experimental-numscript-interpreter" feature flag is passed. + +## Example Usage + +```typescript +import { Runtime } from "@formance/formance-sdk/sdk/models/shared"; + +let value: Runtime = Runtime.Machine; +``` + +## Values + +| Name | Value | +| ------------------------- | ------------------------- | +| `ExperimentalInterpreter` | experimental-interpreter | +| `Machine` | machine | \ No newline at end of file diff --git a/docs/sdk/models/shared/trigger.md b/docs/sdk/models/shared/trigger.md index 40d0bcfa..87a02c0c 100644 --- a/docs/sdk/models/shared/trigger.md +++ b/docs/sdk/models/shared/trigger.md @@ -23,4 +23,5 @@ let value: Trigger = { | `id` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | | `vars` | Record | :heavy_minus_sign: | N/A | +| `version` | *string* | :heavy_minus_sign: | N/A | | `workflowID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/triggerdata.md b/docs/sdk/models/shared/triggerdata.md index 98726d57..1d46082c 100644 --- a/docs/sdk/models/shared/triggerdata.md +++ b/docs/sdk/models/shared/triggerdata.md @@ -19,4 +19,5 @@ let value: TriggerData = { | `filter` | *string* | :heavy_minus_sign: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | | `vars` | Record | :heavy_minus_sign: | N/A | +| `version` | *string* | :heavy_minus_sign: | N/A | | `workflowID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2account.md b/docs/sdk/models/shared/v2account.md index 644b7f28..c5b577d6 100644 --- a/docs/sdk/models/shared/v2account.md +++ b/docs/sdk/models/shared/v2account.md @@ -19,9 +19,12 @@ let value: V2Account = { output: 10n, }, }, + firstUsage: new Date("2023-01-01T00:00:00Z"), + insertionDate: new Date("2023-01-01T00:00:00Z"), metadata: { "admin": "true", }, + updatedAt: new Date("2023-01-01T00:00:00Z"), volumes: { "USD": { balance: 90n, @@ -43,5 +46,8 @@ let value: V2Account = { | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | | `address` | *string* | :heavy_check_mark: | N/A | users:001 | | `effectiveVolumes` | Record | :heavy_minus_sign: | N/A | {
"USD": {
"input": 100,
"output": 10,
"balance": 90
},
"EUR": {
"input": 100,
"output": 10,
"balance": 90
}
} | +| `firstUsage` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2023-01-01T00:00:00Z | +| `insertionDate` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2023-01-01T00:00:00Z | | `metadata` | Record | :heavy_check_mark: | N/A | {
"admin": "true"
} | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | 2023-01-01T00:00:00Z | | `volumes` | Record | :heavy_minus_sign: | N/A | {
"USD": {
"input": 100,
"output": 10,
"balance": 90
},
"EUR": {
"input": 100,
"output": 10,
"balance": 90
}
} | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2accountresponse.md b/docs/sdk/models/shared/v2accountresponse.md index 2c330781..6c030c2d 100644 --- a/docs/sdk/models/shared/v2accountresponse.md +++ b/docs/sdk/models/shared/v2accountresponse.md @@ -20,9 +20,12 @@ let value: V2AccountResponse = { output: 10n, }, }, + firstUsage: new Date("2023-01-01T00:00:00Z"), + insertionDate: new Date("2023-01-01T00:00:00Z"), metadata: { "admin": "true", }, + updatedAt: new Date("2023-01-01T00:00:00Z"), volumes: { "USD": { balance: 90n, diff --git a/docs/sdk/models/shared/v2accountscursorresponse.md b/docs/sdk/models/shared/v2accountscursorresponse.md index a0870d4b..efd43d24 100644 --- a/docs/sdk/models/shared/v2accountscursorresponse.md +++ b/docs/sdk/models/shared/v2accountscursorresponse.md @@ -22,9 +22,12 @@ let value: V2AccountsCursorResponse = { output: 10n, }, }, + firstUsage: new Date("2023-01-01T00:00:00Z"), + insertionDate: new Date("2023-01-01T00:00:00Z"), metadata: { "admin": "true", }, + updatedAt: new Date("2023-01-01T00:00:00Z"), volumes: { "USD": { balance: 90n, diff --git a/docs/sdk/models/shared/v2activitygetaccountoutput.md b/docs/sdk/models/shared/v2activitygetaccountoutput.md new file mode 100644 index 00000000..480d361e --- /dev/null +++ b/docs/sdk/models/shared/v2activitygetaccountoutput.md @@ -0,0 +1,46 @@ +# V2ActivityGetAccountOutput + +## Example Usage + +```typescript +import { V2ActivityGetAccountOutput } from "@formance/formance-sdk/sdk/models/shared"; + +let value: V2ActivityGetAccountOutput = { + data: { + address: "users:001", + effectiveVolumes: { + "USD": { + balance: 90n, + input: 100n, + output: 10n, + }, + "EUR": { + balance: 90n, + input: 100n, + output: 10n, + }, + }, + metadata: { + "admin": "true", + }, + volumes: { + "USD": { + balance: 90n, + input: 100n, + output: 10n, + }, + "EUR": { + balance: 90n, + input: 100n, + output: 10n, + }, + }, + }, +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `data` | [shared.OrchestrationV2Account](../../../sdk/models/shared/orchestrationv2account.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2bulkelement.md b/docs/sdk/models/shared/v2bulkelement.md index c6abee17..c917b21a 100644 --- a/docs/sdk/models/shared/v2bulkelement.md +++ b/docs/sdk/models/shared/v2bulkelement.md @@ -17,6 +17,11 @@ const value: shared.V2BulkElementAddMetadata = { const value: shared.V2BulkElementCreateTransaction = { action: "", data: { + accountMetadata: { + "key": { + "admin": "true", + }, + }, metadata: { "admin": "true", }, diff --git a/docs/sdk/models/shared/v2bulkelementcreatetransaction.md b/docs/sdk/models/shared/v2bulkelementcreatetransaction.md index d6a6fe05..a30e7e3a 100644 --- a/docs/sdk/models/shared/v2bulkelementcreatetransaction.md +++ b/docs/sdk/models/shared/v2bulkelementcreatetransaction.md @@ -8,6 +8,11 @@ import { V2BulkElementCreateTransaction } from "@formance/formance-sdk/sdk/model let value: V2BulkElementCreateTransaction = { action: "", data: { + accountMetadata: { + "key": { + "admin": "true", + }, + }, metadata: { "admin": "true", }, diff --git a/docs/sdk/models/shared/v2bulkelementresult.md b/docs/sdk/models/shared/v2bulkelementresult.md index 97a8cdb1..2be78abe 100644 --- a/docs/sdk/models/shared/v2bulkelementresult.md +++ b/docs/sdk/models/shared/v2bulkelementresult.md @@ -3,13 +3,11 @@ ## Supported Types -### `shared.V2BulkElementResultError` +### `shared.V2BulkElementResultAddMetadata` ```typescript -const value: shared.V2BulkElementResultError = { - errorCode: "", - errorDescription: "", - logID: 332853, +const value: shared.V2BulkElementResultAddMetadata = { + logID: 934456, responseType: "", }; ``` @@ -104,6 +102,26 @@ const value: shared.V2BulkElementResultCreateTransaction = { }; ``` +### `shared.V2BulkElementResultDeleteMetadata` + +```typescript +const value: shared.V2BulkElementResultDeleteMetadata = { + logID: 699342, + responseType: "", +}; +``` + +### `shared.V2BulkElementResultError` + +```typescript +const value: shared.V2BulkElementResultError = { + errorCode: "", + errorDescription: "", + logID: 332853, + responseType: "", +}; +``` + ### `shared.V2BulkElementResultRevertTransaction` ```typescript @@ -194,21 +212,3 @@ const value: shared.V2BulkElementResultRevertTransaction = { }; ``` -### `shared.V2BulkElementResultAddMetadata` - -```typescript -const value: shared.V2BulkElementResultAddMetadata = { - logID: 934456, - responseType: "", -}; -``` - -### `shared.V2BulkElementResultDeleteMetadata` - -```typescript -const value: shared.V2BulkElementResultDeleteMetadata = { - logID: 699342, - responseType: "", -}; -``` - diff --git a/docs/sdk/models/shared/v2createpipelinerequest.md b/docs/sdk/models/shared/v2createpipelinerequest.md new file mode 100644 index 00000000..4603fc3e --- /dev/null +++ b/docs/sdk/models/shared/v2createpipelinerequest.md @@ -0,0 +1,17 @@ +# V2CreatePipelineRequest + +## Example Usage + +```typescript +import { V2CreatePipelineRequest } from "@formance/formance-sdk/sdk/models/shared"; + +let value: V2CreatePipelineRequest = { + exporterID: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `exporterID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2exporter.md b/docs/sdk/models/shared/v2exporter.md new file mode 100644 index 00000000..3a28cc98 --- /dev/null +++ b/docs/sdk/models/shared/v2exporter.md @@ -0,0 +1,26 @@ +# V2Exporter + +## Example Usage + +```typescript +import { V2Exporter } from "@formance/formance-sdk/sdk/models/shared"; + +let value: V2Exporter = { + config: { + "key": "", + "key1": "", + }, + createdAt: new Date("2024-01-12T12:26:44.794Z"), + driver: "", + id: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `config` | Record | :heavy_check_mark: | N/A | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | +| `driver` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2exporterconfiguration.md b/docs/sdk/models/shared/v2exporterconfiguration.md new file mode 100644 index 00000000..531592ba --- /dev/null +++ b/docs/sdk/models/shared/v2exporterconfiguration.md @@ -0,0 +1,23 @@ +# V2ExporterConfiguration + +## Example Usage + +```typescript +import { V2ExporterConfiguration } from "@formance/formance-sdk/sdk/models/shared"; + +let value: V2ExporterConfiguration = { + config: { + "key": "", + "key1": "", + "key2": "", + }, + driver: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `config` | Record | :heavy_check_mark: | N/A | +| `driver` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2ledger.md b/docs/sdk/models/shared/v2ledger.md index dac6a46f..5e178516 100644 --- a/docs/sdk/models/shared/v2ledger.md +++ b/docs/sdk/models/shared/v2ledger.md @@ -21,5 +21,7 @@ let value: V2Ledger = { | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | | `addedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | | | `bucket` | *string* | :heavy_check_mark: | N/A | | +| `features` | Record | :heavy_minus_sign: | N/A | | +| `id` | *number* | :heavy_minus_sign: | N/A | | | `metadata` | Record | :heavy_minus_sign: | N/A | {
"admin": "true"
} | | `name` | *string* | :heavy_check_mark: | N/A | | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2migrationinfostate.md b/docs/sdk/models/shared/v2migrationinfostate.md index b076e47f..97b2bfb1 100644 --- a/docs/sdk/models/shared/v2migrationinfostate.md +++ b/docs/sdk/models/shared/v2migrationinfostate.md @@ -5,12 +5,13 @@ ```typescript import { V2MigrationInfoState } from "@formance/formance-sdk/sdk/models/shared"; -let value: V2MigrationInfoState = V2MigrationInfoState.Done; +let value: V2MigrationInfoState = V2MigrationInfoState.Progress; ``` ## Values -| Name | Value | -| ------ | ------ | -| `ToDo` | TO DO | -| `Done` | DONE | \ No newline at end of file +| Name | Value | +| ---------- | ---------- | +| `ToDo` | TO DO | +| `Done` | DONE | +| `Progress` | PROGRESS | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2pipeline.md b/docs/sdk/models/shared/v2pipeline.md new file mode 100644 index 00000000..6ee9c3df --- /dev/null +++ b/docs/sdk/models/shared/v2pipeline.md @@ -0,0 +1,25 @@ +# V2Pipeline + +## Example Usage + +```typescript +import { V2Pipeline } from "@formance/formance-sdk/sdk/models/shared"; + +let value: V2Pipeline = { + createdAt: new Date("2025-09-19T16:02:33.789Z"), + exporterID: "", + id: "", + ledger: "", +}; +``` + +## Fields + +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `createdAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | +| `enabled` | *boolean* | :heavy_minus_sign: | N/A | +| `exporterID` | *string* | :heavy_check_mark: | N/A | +| `id` | *string* | :heavy_check_mark: | N/A | +| `lastLogID` | *number* | :heavy_minus_sign: | N/A | +| `ledger` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2posttransaction.md b/docs/sdk/models/shared/v2posttransaction.md index 75bca595..b345ba89 100644 --- a/docs/sdk/models/shared/v2posttransaction.md +++ b/docs/sdk/models/shared/v2posttransaction.md @@ -6,6 +6,11 @@ import { V2PostTransaction } from "@formance/formance-sdk/sdk/models/shared"; let value: V2PostTransaction = { + accountMetadata: { + "key": { + "admin": "true", + }, + }, metadata: { "admin": "true", }, @@ -36,10 +41,13 @@ let value: V2PostTransaction = { ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `metadata` | Record | :heavy_check_mark: | N/A | {
"admin": "true"
} | -| `postings` | [shared.V2Posting](../../../sdk/models/shared/v2posting.md)[] | :heavy_minus_sign: | N/A | | -| `reference` | *string* | :heavy_minus_sign: | N/A | ref:001 | -| `script` | [shared.V2PostTransactionScript](../../../sdk/models/shared/v2posttransactionscript.md) | :heavy_minus_sign: | N/A | | -| `timestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `accountMetadata` | Record> | :heavy_minus_sign: | N/A | | +| `force` | *boolean* | :heavy_minus_sign: | N/A | | +| `metadata` | Record | :heavy_check_mark: | N/A | {
"admin": "true"
} | +| `postings` | [shared.V2Posting](../../../sdk/models/shared/v2posting.md)[] | :heavy_minus_sign: | N/A | | +| `reference` | *string* | :heavy_minus_sign: | N/A | ref:001 | +| `runtime` | [shared.Runtime](../../../sdk/models/shared/runtime.md) | :heavy_minus_sign: | The numscript runtime used to execute the script. Uses "machine" by default, unless the "--experimental-numscript-interpreter" feature flag is passed. | | +| `script` | [shared.V2PostTransactionScript](../../../sdk/models/shared/v2posttransactionscript.md) | :heavy_minus_sign: | N/A | | +| `timestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2reverttransactionrequest.md b/docs/sdk/models/shared/v2reverttransactionrequest.md new file mode 100644 index 00000000..1a840812 --- /dev/null +++ b/docs/sdk/models/shared/v2reverttransactionrequest.md @@ -0,0 +1,15 @@ +# V2RevertTransactionRequest + +## Example Usage + +```typescript +import { V2RevertTransactionRequest } from "@formance/formance-sdk/sdk/models/shared"; + +let value: V2RevertTransactionRequest = {}; +``` + +## Fields + +| Field | Type | Required | Description | +| ------------------------ | ------------------------ | ------------------------ | ------------------------ | +| `metadata` | Record | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2transaction.md b/docs/sdk/models/shared/v2transaction.md index f6472115..0dd7456c 100644 --- a/docs/sdk/models/shared/v2transaction.md +++ b/docs/sdk/models/shared/v2transaction.md @@ -103,4 +103,5 @@ let value: V2Transaction = { | `reference` | *string* | :heavy_minus_sign: | N/A | ref:001 | | `reverted` | *boolean* | :heavy_check_mark: | N/A | | | `revertedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | -| `timestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | | \ No newline at end of file +| `timestamp` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | | +| `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2trigger.md b/docs/sdk/models/shared/v2trigger.md index ebb72023..11df020b 100644 --- a/docs/sdk/models/shared/v2trigger.md +++ b/docs/sdk/models/shared/v2trigger.md @@ -23,4 +23,5 @@ let value: V2Trigger = { | `id` | *string* | :heavy_check_mark: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | | `vars` | Record | :heavy_minus_sign: | N/A | +| `version` | *string* | :heavy_minus_sign: | N/A | | `workflowID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2triggerdata.md b/docs/sdk/models/shared/v2triggerdata.md index 589917e3..98f6c064 100644 --- a/docs/sdk/models/shared/v2triggerdata.md +++ b/docs/sdk/models/shared/v2triggerdata.md @@ -19,4 +19,5 @@ let value: V2TriggerData = { | `filter` | *string* | :heavy_minus_sign: | N/A | | `name` | *string* | :heavy_minus_sign: | N/A | | `vars` | Record | :heavy_minus_sign: | N/A | +| `version` | *string* | :heavy_minus_sign: | N/A | | `workflowID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2workflowinstance.md b/docs/sdk/models/shared/v2workflowinstance.md index f3957365..d8d1051b 100644 --- a/docs/sdk/models/shared/v2workflowinstance.md +++ b/docs/sdk/models/shared/v2workflowinstance.md @@ -25,4 +25,5 @@ let value: V2WorkflowInstance = { | `terminated` | *boolean* | :heavy_check_mark: | N/A | | `terminatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | +| `workflow` | [shared.V2Workflow](../../../sdk/models/shared/v2workflow.md) | :heavy_minus_sign: | N/A | | `workflowID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/v2workflowinstancehistorystageoutput.md b/docs/sdk/models/shared/v2workflowinstancehistorystageoutput.md index 2f6f7fe9..adb0ff73 100644 --- a/docs/sdk/models/shared/v2workflowinstancehistorystageoutput.md +++ b/docs/sdk/models/shared/v2workflowinstancehistorystageoutput.md @@ -92,7 +92,7 @@ let value: V2WorkflowInstanceHistoryStageOutput = { | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `createTransaction` | [shared.V2ActivityCreateTransactionOutput](../../../sdk/models/shared/v2activitycreatetransactionoutput.md) | :heavy_minus_sign: | N/A | | `debitWallet` | [shared.V2ActivityDebitWalletOutput](../../../sdk/models/shared/v2activitydebitwalletoutput.md) | :heavy_minus_sign: | N/A | -| `getAccount` | [shared.V2AccountResponse](../../../sdk/models/shared/v2accountresponse.md) | :heavy_minus_sign: | N/A | +| `getAccount` | [shared.V2ActivityGetAccountOutput](../../../sdk/models/shared/v2activitygetaccountoutput.md) | :heavy_minus_sign: | N/A | | `getPayment` | [shared.V2ActivityGetPaymentOutput](../../../sdk/models/shared/v2activitygetpaymentoutput.md) | :heavy_minus_sign: | N/A | | `getWallet` | [shared.V2ActivityGetWalletOutput](../../../sdk/models/shared/v2activitygetwalletoutput.md) | :heavy_minus_sign: | N/A | | `listWallets` | [shared.V2ListWalletsResponse](../../../sdk/models/shared/v2listwalletsresponse.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/sdk/models/shared/workflowinstance.md b/docs/sdk/models/shared/workflowinstance.md index f1399b62..ce7d98ed 100644 --- a/docs/sdk/models/shared/workflowinstance.md +++ b/docs/sdk/models/shared/workflowinstance.md @@ -25,4 +25,5 @@ let value: WorkflowInstance = { | `terminated` | *boolean* | :heavy_check_mark: | N/A | | `terminatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_minus_sign: | N/A | | `updatedAt` | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) | :heavy_check_mark: | N/A | +| `workflow` | [shared.Workflow](../../../sdk/models/shared/workflow.md) | :heavy_minus_sign: | N/A | | `workflowID` | *string* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/sdks/ledger/README.md b/docs/sdks/ledger/README.md index d012def5..1e7bb3fb 100644 --- a/docs/sdks/ledger/README.md +++ b/docs/sdks/ledger/README.md @@ -4,3 +4,156 @@ ## Overview ### Available Operations + +* [getInfo](#getinfo) - Show server information +* [getMetrics](#getmetrics) - Read in memory metrics + +## getInfo + +Show server information + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.getInfo(); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerGetInfo } from "@formance/formance-sdk/funcs/ledgerGetInfo.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerGetInfo(sdk); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerGetInfo failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2GetInfoResponse](../../sdk/models/operations/v2getinforesponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## getMetrics + +Read in memory metrics + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.getMetrics(); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerGetMetrics } from "@formance/formance-sdk/funcs/ledgerGetMetrics.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerGetMetrics(sdk); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerGetMetrics failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.GetMetricsResponse](../../sdk/models/operations/getmetricsresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | \ No newline at end of file diff --git a/docs/sdks/ledgerv2/README.md b/docs/sdks/ledgerv2/README.md index 395ea5e7..055dcbfd 100644 --- a/docs/sdks/ledgerv2/README.md +++ b/docs/sdks/ledgerv2/README.md @@ -10,27 +10,36 @@ * [countAccounts](#countaccounts) - Count the accounts from a ledger * [countTransactions](#counttransactions) - Count the transactions from a ledger * [createBulk](#createbulk) - Bulk request +* [createExporter](#createexporter) - Create exporter * [createLedger](#createledger) - Create a ledger +* [createPipeline](#createpipeline) - Create pipeline * [createTransaction](#createtransaction) - Create a new transaction to a ledger * [deleteAccountMetadata](#deleteaccountmetadata) - Delete metadata by key +* [deleteExporter](#deleteexporter) - Delete exporter * [deleteLedgerMetadata](#deleteledgermetadata) - Delete ledger metadata by key +* [deletePipeline](#deletepipeline) - Delete pipeline * [deleteTransactionMetadata](#deletetransactionmetadata) - Delete metadata by key * [exportLogs](#exportlogs) - Export logs * [getAccount](#getaccount) - Get account by its address * [getBalancesAggregated](#getbalancesaggregated) - Get the aggregated balances from selected accounts -* [getInfo](#getinfo) - Show server information +* [getExporterState](#getexporterstate) - Get exporter state * [getLedger](#getledger) - Get a ledger * [getLedgerInfo](#getledgerinfo) - Get information about a ledger -* [getMetrics](#getmetrics) - Read in memory metrics +* [getPipelineState](#getpipelinestate) - Get pipeline state * [getTransaction](#gettransaction) - Get transaction from a ledger by its ID * [getVolumesWithBalances](#getvolumeswithbalances) - Get list of volumes with balances for (account/asset) * [importLogs](#importlogs) * [listAccounts](#listaccounts) - List accounts from a ledger +* [listExporters](#listexporters) - List exporters * [listLedgers](#listledgers) - List ledgers * [listLogs](#listlogs) - List the logs from a ledger +* [listPipelines](#listpipelines) - List pipelines * [listTransactions](#listtransactions) - List transactions from a ledger * [readStats](#readstats) - Get statistics from a ledger +* [resetPipeline](#resetpipeline) - Reset pipeline * [revertTransaction](#reverttransaction) - Revert a ledger transaction by its ID +* [startPipeline](#startpipeline) - Start pipeline +* [stopPipeline](#stoppipeline) - Stop pipeline * [updateLedgerMetadata](#updateledgermetadata) - Update ledger metadata ## addMetadataOnTransaction @@ -469,6 +478,92 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | +## createExporter + +Create exporter + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.createExporter({ + config: { + "key": "", + }, + driver: "", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2CreateExporter } from "@formance/formance-sdk/funcs/ledgerV2CreateExporter.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2CreateExporter(sdk, { + config: { + "key": "", + }, + driver: "", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2CreateExporter failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [shared.V2ExporterConfiguration](../../sdk/models/shared/v2exporterconfiguration.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2CreateExporterResponse](../../sdk/models/operations/v2createexporterresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + ## createLedger Create a ledger @@ -559,6 +654,86 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | +## createPipeline + +Create pipeline + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.createPipeline({ + ledger: "ledger001", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2CreatePipeline } from "@formance/formance-sdk/funcs/ledgerV2CreatePipeline.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2CreatePipeline(sdk, { + ledger: "ledger001", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2CreatePipeline failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2CreatePipelineRequest](../../sdk/models/operations/v2createpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2CreatePipelineResponse](../../sdk/models/operations/v2createpipelineresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + ## createTransaction Create a new transaction to a ledger @@ -579,6 +754,17 @@ const sdk = new SDK({ async function run() { const result = await sdk.ledger.v2.createTransaction({ v2PostTransaction: { + accountMetadata: { + "key": { + "admin": "true", + }, + "key1": { + "admin": "true", + }, + "key2": { + "admin": "true", + }, + }, metadata: { "admin": "true", }, @@ -636,6 +822,17 @@ const sdk = new SDKCore({ async function run() { const res = await ledgerV2CreateTransaction(sdk, { v2PostTransaction: { + accountMetadata: { + "key": { + "admin": "true", + }, + "key1": { + "admin": "true", + }, + "key2": { + "admin": "true", + }, + }, metadata: { "admin": "true", }, @@ -781,6 +978,86 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | +## deleteExporter + +Delete exporter + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.deleteExporter({ + exporterID: "", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2DeleteExporter } from "@formance/formance-sdk/funcs/ledgerV2DeleteExporter.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2DeleteExporter(sdk, { + exporterID: "", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2DeleteExporter failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2DeleteExporterRequest](../../sdk/models/operations/v2deleteexporterrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2DeleteExporterResponse](../../sdk/models/operations/v2deleteexporterresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + ## deleteLedgerMetadata Delete ledger metadata by key @@ -863,13 +1140,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## deleteTransactionMetadata +## deletePipeline -Delete metadata by key +Delete pipeline ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -881,10 +1158,9 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.deleteTransactionMetadata({ - id: 1234n, - key: "foo", + const result = await sdk.ledger.v2.deletePipeline({ ledger: "ledger001", + pipelineID: "", }); console.log(result); @@ -899,7 +1175,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2DeleteTransactionMetadata } from "@formance/formance-sdk/funcs/ledgerV2DeleteTransactionMetadata.js"; +import { ledgerV2DeletePipeline } from "@formance/formance-sdk/funcs/ledgerV2DeletePipeline.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -911,16 +1187,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2DeleteTransactionMetadata(sdk, { - id: 1234n, - key: "foo", + const res = await ledgerV2DeletePipeline(sdk, { ledger: "ledger001", + pipelineID: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2DeleteTransactionMetadata failed:", res.error); + console.log("ledgerV2DeletePipeline failed:", res.error); } } @@ -931,14 +1206,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2DeleteTransactionMetadataRequest](../../sdk/models/operations/v2deletetransactionmetadatarequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2DeletePipelineRequest](../../sdk/models/operations/v2deletepipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2DeleteTransactionMetadataResponse](../../sdk/models/operations/v2deletetransactionmetadataresponse.md)\>** +**Promise\<[operations.V2DeletePipelineResponse](../../sdk/models/operations/v2deletepipelineresponse.md)\>** ### Errors @@ -947,13 +1222,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## exportLogs +## deleteTransactionMetadata -Export logs +Delete metadata by key ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -965,7 +1240,9 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.exportLogs({ + const result = await sdk.ledger.v2.deleteTransactionMetadata({ + id: 1234n, + key: "foo", ledger: "ledger001", }); @@ -981,7 +1258,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ExportLogs } from "@formance/formance-sdk/funcs/ledgerV2ExportLogs.js"; +import { ledgerV2DeleteTransactionMetadata } from "@formance/formance-sdk/funcs/ledgerV2DeleteTransactionMetadata.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -993,14 +1270,16 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ExportLogs(sdk, { + const res = await ledgerV2DeleteTransactionMetadata(sdk, { + id: 1234n, + key: "foo", ledger: "ledger001", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ExportLogs failed:", res.error); + console.log("ledgerV2DeleteTransactionMetadata failed:", res.error); } } @@ -1011,19 +1290,99 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ExportLogsRequest](../../sdk/models/operations/v2exportlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2DeleteTransactionMetadataRequest](../../sdk/models/operations/v2deletetransactionmetadatarequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ExportLogsResponse](../../sdk/models/operations/v2exportlogsresponse.md)\>** +**Promise\<[operations.V2DeleteTransactionMetadataResponse](../../sdk/models/operations/v2deletetransactionmetadataresponse.md)\>** ### Errors -| Error Type | Status Code | Content Type | -| --------------- | --------------- | --------------- | +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## exportLogs + +Export logs + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.exportLogs({ + ledger: "ledger001", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2ExportLogs } from "@formance/formance-sdk/funcs/ledgerV2ExportLogs.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2ExportLogs(sdk, { + ledger: "ledger001", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2ExportLogs failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2ExportLogsRequest](../../sdk/models/operations/v2exportlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2ExportLogsResponse](../../sdk/models/operations/v2exportlogsresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| --------------- | --------------- | --------------- | | errors.SDKError | 4XX, 5XX | \*/\* | ## getAccount @@ -1032,7 +1391,409 @@ Get account by its address ### Example Usage - + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.getAccount({ + address: "users:001", + ledger: "ledger001", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2GetAccount } from "@formance/formance-sdk/funcs/ledgerV2GetAccount.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2GetAccount(sdk, { + address: "users:001", + ledger: "ledger001", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2GetAccount failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2GetAccountRequest](../../sdk/models/operations/v2getaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2GetAccountResponse](../../sdk/models/operations/v2getaccountresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## getBalancesAggregated + +Get the aggregated balances from selected accounts + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.getBalancesAggregated({ + ledger: "ledger001", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2GetBalancesAggregated } from "@formance/formance-sdk/funcs/ledgerV2GetBalancesAggregated.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2GetBalancesAggregated(sdk, { + ledger: "ledger001", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2GetBalancesAggregated failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2GetBalancesAggregatedRequest](../../sdk/models/operations/v2getbalancesaggregatedrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2GetBalancesAggregatedResponse](../../sdk/models/operations/v2getbalancesaggregatedresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## getExporterState + +Get exporter state + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.getExporterState({ + exporterID: "", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2GetExporterState } from "@formance/formance-sdk/funcs/ledgerV2GetExporterState.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2GetExporterState(sdk, { + exporterID: "", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2GetExporterState failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2GetExporterStateRequest](../../sdk/models/operations/v2getexporterstaterequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2GetExporterStateResponse](../../sdk/models/operations/v2getexporterstateresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## getLedger + +Get a ledger + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.getLedger({ + ledger: "ledger001", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2GetLedger } from "@formance/formance-sdk/funcs/ledgerV2GetLedger.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2GetLedger(sdk, { + ledger: "ledger001", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2GetLedger failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2GetLedgerRequest](../../sdk/models/operations/v2getledgerrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2GetLedgerResponse](../../sdk/models/operations/v2getledgerresponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## getLedgerInfo + +Get information about a ledger + +### Example Usage + + +```typescript +import { SDK } from "@formance/formance-sdk"; + +const sdk = new SDK({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const result = await sdk.ledger.v2.getLedgerInfo({ + ledger: "ledger001", + }); + + console.log(result); +} + +run(); +``` + +### Standalone function + +The standalone function version of this method: + +```typescript +import { SDKCore } from "@formance/formance-sdk/core.js"; +import { ledgerV2GetLedgerInfo } from "@formance/formance-sdk/funcs/ledgerV2GetLedgerInfo.js"; + +// Use `SDKCore` for best tree-shaking performance. +// You can create one instance of it to use across an application. +const sdk = new SDKCore({ + security: { + clientID: "", + clientSecret: "", + }, +}); + +async function run() { + const res = await ledgerV2GetLedgerInfo(sdk, { + ledger: "ledger001", + }); + if (res.ok) { + const { value: result } = res; + console.log(result); + } else { + console.log("ledgerV2GetLedgerInfo failed:", res.error); + } +} + +run(); +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2GetLedgerInfoRequest](../../sdk/models/operations/v2getledgerinforequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | +| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | +| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | + +### Response + +**Promise\<[operations.V2GetLedgerInfoResponse](../../sdk/models/operations/v2getledgerinforesponse.md)\>** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------- | ---------------------- | ---------------------- | +| errors.V2ErrorResponse | default | application/json | +| errors.SDKError | 4XX, 5XX | \*/\* | + +## getPipelineState + +Get pipeline state + +### Example Usage + + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1044,9 +1805,9 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getAccount({ - address: "users:001", + const result = await sdk.ledger.v2.getPipelineState({ ledger: "ledger001", + pipelineID: "", }); console.log(result); @@ -1061,7 +1822,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetAccount } from "@formance/formance-sdk/funcs/ledgerV2GetAccount.js"; +import { ledgerV2GetPipelineState } from "@formance/formance-sdk/funcs/ledgerV2GetPipelineState.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1073,15 +1834,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetAccount(sdk, { - address: "users:001", + const res = await ledgerV2GetPipelineState(sdk, { ledger: "ledger001", + pipelineID: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetAccount failed:", res.error); + console.log("ledgerV2GetPipelineState failed:", res.error); } } @@ -1092,14 +1853,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2GetAccountRequest](../../sdk/models/operations/v2getaccountrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2GetPipelineStateRequest](../../sdk/models/operations/v2getpipelinestaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetAccountResponse](../../sdk/models/operations/v2getaccountresponse.md)\>** +**Promise\<[operations.V2GetPipelineStateResponse](../../sdk/models/operations/v2getpipelinestateresponse.md)\>** ### Errors @@ -1108,13 +1869,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getBalancesAggregated +## getTransaction -Get the aggregated balances from selected accounts +Get transaction from a ledger by its ID ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1126,7 +1887,8 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getBalancesAggregated({ + const result = await sdk.ledger.v2.getTransaction({ + id: 1234n, ledger: "ledger001", }); @@ -1142,7 +1904,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetBalancesAggregated } from "@formance/formance-sdk/funcs/ledgerV2GetBalancesAggregated.js"; +import { ledgerV2GetTransaction } from "@formance/formance-sdk/funcs/ledgerV2GetTransaction.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1154,14 +1916,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetBalancesAggregated(sdk, { + const res = await ledgerV2GetTransaction(sdk, { + id: 1234n, ledger: "ledger001", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetBalancesAggregated failed:", res.error); + console.log("ledgerV2GetTransaction failed:", res.error); } } @@ -1172,14 +1935,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2GetBalancesAggregatedRequest](../../sdk/models/operations/v2getbalancesaggregatedrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2GetTransactionRequest](../../sdk/models/operations/v2gettransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetBalancesAggregatedResponse](../../sdk/models/operations/v2getbalancesaggregatedresponse.md)\>** +**Promise\<[operations.V2GetTransactionResponse](../../sdk/models/operations/v2gettransactionresponse.md)\>** ### Errors @@ -1188,13 +1951,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getInfo +## getVolumesWithBalances -Show server information +Get list of volumes with balances for (account/asset) ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1206,7 +1969,13 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getInfo(); + const result = await sdk.ledger.v2.getVolumesWithBalances({ + cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + groupBy: 3, + ledger: "ledger001", + pageSize: 100, + sort: "id:desc", + }); console.log(result); } @@ -1220,7 +1989,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetInfo } from "@formance/formance-sdk/funcs/ledgerV2GetInfo.js"; +import { ledgerV2GetVolumesWithBalances } from "@formance/formance-sdk/funcs/ledgerV2GetVolumesWithBalances.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1232,12 +2001,18 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetInfo(sdk); + const res = await ledgerV2GetVolumesWithBalances(sdk, { + cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + groupBy: 3, + ledger: "ledger001", + pageSize: 100, + sort: "id:desc", + }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetInfo failed:", res.error); + console.log("ledgerV2GetVolumesWithBalances failed:", res.error); } } @@ -1248,13 +2023,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `request` | [operations.V2GetVolumesWithBalancesRequest](../../sdk/models/operations/v2getvolumeswithbalancesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetInfoResponse](../../sdk/models/operations/v2getinforesponse.md)\>** +**Promise\<[operations.V2GetVolumesWithBalancesResponse](../../sdk/models/operations/v2getvolumeswithbalancesresponse.md)\>** ### Errors @@ -1263,15 +2039,14 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getLedger - -Get a ledger +## importLogs ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; +import { openAsBlob } from "node:fs"; const sdk = new SDK({ security: { @@ -1281,7 +2056,8 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getLedger({ + const result = await sdk.ledger.v2.importLogs({ + v2ImportLogsRequest: await openAsBlob("example.file"), ledger: "ledger001", }); @@ -1297,7 +2073,8 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetLedger } from "@formance/formance-sdk/funcs/ledgerV2GetLedger.js"; +import { ledgerV2ImportLogs } from "@formance/formance-sdk/funcs/ledgerV2ImportLogs.js"; +import { openAsBlob } from "node:fs"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1309,14 +2086,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetLedger(sdk, { + const res = await ledgerV2ImportLogs(sdk, { + v2ImportLogsRequest: await openAsBlob("example.file"), ledger: "ledger001", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetLedger failed:", res.error); + console.log("ledgerV2ImportLogs failed:", res.error); } } @@ -1327,14 +2105,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2GetLedgerRequest](../../sdk/models/operations/v2getledgerrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ImportLogsRequest](../../sdk/models/operations/v2importlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetLedgerResponse](../../sdk/models/operations/v2getledgerresponse.md)\>** +**Promise\<[operations.V2ImportLogsResponse](../../sdk/models/operations/v2importlogsresponse.md)\>** ### Errors @@ -1343,13 +2121,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getLedgerInfo +## listAccounts -Get information about a ledger +List accounts from a ledger, sorted by address in descending order. ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1361,8 +2139,11 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getLedgerInfo({ + const result = await sdk.ledger.v2.listAccounts({ + cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", + pageSize: 100, + sort: "id:desc", }); console.log(result); @@ -1377,7 +2158,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetLedgerInfo } from "@formance/formance-sdk/funcs/ledgerV2GetLedgerInfo.js"; +import { ledgerV2ListAccounts } from "@formance/formance-sdk/funcs/ledgerV2ListAccounts.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1389,14 +2170,17 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetLedgerInfo(sdk, { + const res = await ledgerV2ListAccounts(sdk, { + cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", + pageSize: 100, + sort: "id:desc", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetLedgerInfo failed:", res.error); + console.log("ledgerV2ListAccounts failed:", res.error); } } @@ -1407,14 +2191,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2GetLedgerInfoRequest](../../sdk/models/operations/v2getledgerinforequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ListAccountsRequest](../../sdk/models/operations/v2listaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetLedgerInfoResponse](../../sdk/models/operations/v2getledgerinforesponse.md)\>** +**Promise\<[operations.V2ListAccountsResponse](../../sdk/models/operations/v2listaccountsresponse.md)\>** ### Errors @@ -1423,13 +2207,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getMetrics +## listExporters -Read in memory metrics +List exporters ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1441,7 +2225,7 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getMetrics(); + const result = await sdk.ledger.v2.listExporters(); console.log(result); } @@ -1455,7 +2239,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetMetrics } from "@formance/formance-sdk/funcs/ledgerV2GetMetrics.js"; +import { ledgerV2ListExporters } from "@formance/formance-sdk/funcs/ledgerV2ListExporters.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1467,12 +2251,12 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetMetrics(sdk); + const res = await ledgerV2ListExporters(sdk); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetMetrics failed:", res.error); + console.log("ledgerV2ListExporters failed:", res.error); } } @@ -1489,7 +2273,7 @@ run(); ### Response -**Promise\<[operations.GetMetricsResponse](../../sdk/models/operations/getmetricsresponse.md)\>** +**Promise\<[operations.V2ListExportersResponse](../../sdk/models/operations/v2listexportersresponse.md)\>** ### Errors @@ -1498,13 +2282,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getTransaction +## listLedgers -Get transaction from a ledger by its ID +List ledgers ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1516,9 +2300,10 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getTransaction({ - id: 1234n, - ledger: "ledger001", + const result = await sdk.ledger.v2.listLedgers({ + cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + pageSize: 100, + sort: "id:desc", }); console.log(result); @@ -1533,7 +2318,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetTransaction } from "@formance/formance-sdk/funcs/ledgerV2GetTransaction.js"; +import { ledgerV2ListLedgers } from "@formance/formance-sdk/funcs/ledgerV2ListLedgers.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1545,15 +2330,16 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetTransaction(sdk, { - id: 1234n, - ledger: "ledger001", + const res = await ledgerV2ListLedgers(sdk, { + cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + pageSize: 100, + sort: "id:desc", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetTransaction failed:", res.error); + console.log("ledgerV2ListLedgers failed:", res.error); } } @@ -1564,14 +2350,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2GetTransactionRequest](../../sdk/models/operations/v2gettransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ListLedgersRequest](../../sdk/models/operations/v2listledgersrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetTransactionResponse](../../sdk/models/operations/v2gettransactionresponse.md)\>** +**Promise\<[operations.V2ListLedgersResponse](../../sdk/models/operations/v2listledgersresponse.md)\>** ### Errors @@ -1580,13 +2366,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## getVolumesWithBalances +## listLogs -Get list of volumes with balances for (account/asset) +List the logs from a ledger, sorted by ID in descending order. ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1598,11 +2384,11 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.getVolumesWithBalances({ + const result = await sdk.ledger.v2.listLogs({ cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", - groupBy: 3, ledger: "ledger001", pageSize: 100, + sort: "id:desc", }); console.log(result); @@ -1617,7 +2403,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2GetVolumesWithBalances } from "@formance/formance-sdk/funcs/ledgerV2GetVolumesWithBalances.js"; +import { ledgerV2ListLogs } from "@formance/formance-sdk/funcs/ledgerV2ListLogs.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1629,17 +2415,17 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2GetVolumesWithBalances(sdk, { + const res = await ledgerV2ListLogs(sdk, { cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", - groupBy: 3, ledger: "ledger001", pageSize: 100, + sort: "id:desc", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2GetVolumesWithBalances failed:", res.error); + console.log("ledgerV2ListLogs failed:", res.error); } } @@ -1650,14 +2436,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2GetVolumesWithBalancesRequest](../../sdk/models/operations/v2getvolumeswithbalancesrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ListLogsRequest](../../sdk/models/operations/v2listlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2GetVolumesWithBalancesResponse](../../sdk/models/operations/v2getvolumeswithbalancesresponse.md)\>** +**Promise\<[operations.V2ListLogsResponse](../../sdk/models/operations/v2listlogsresponse.md)\>** ### Errors @@ -1666,14 +2452,15 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## importLogs +## listPipelines + +List pipelines ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; -import { openAsBlob } from "node:fs"; const sdk = new SDK({ security: { @@ -1683,8 +2470,7 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.importLogs({ - v2ImportLogsRequest: await openAsBlob("example.file"), + const result = await sdk.ledger.v2.listPipelines({ ledger: "ledger001", }); @@ -1700,8 +2486,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ImportLogs } from "@formance/formance-sdk/funcs/ledgerV2ImportLogs.js"; -import { openAsBlob } from "node:fs"; +import { ledgerV2ListPipelines } from "@formance/formance-sdk/funcs/ledgerV2ListPipelines.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1713,15 +2498,14 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ImportLogs(sdk, { - v2ImportLogsRequest: await openAsBlob("example.file"), + const res = await ledgerV2ListPipelines(sdk, { ledger: "ledger001", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ImportLogs failed:", res.error); + console.log("ledgerV2ListPipelines failed:", res.error); } } @@ -1732,14 +2516,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ImportLogsRequest](../../sdk/models/operations/v2importlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ListPipelinesRequest](../../sdk/models/operations/v2listpipelinesrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ImportLogsResponse](../../sdk/models/operations/v2importlogsresponse.md)\>** +**Promise\<[operations.V2ListPipelinesResponse](../../sdk/models/operations/v2listpipelinesresponse.md)\>** ### Errors @@ -1748,13 +2532,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## listAccounts +## listTransactions -List accounts from a ledger, sorted by address in descending order. +List transactions from a ledger, sorted by id in descending order. ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1766,10 +2550,11 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.listAccounts({ + const result = await sdk.ledger.v2.listTransactions({ cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", pageSize: 100, + sort: "id:desc", }); console.log(result); @@ -1784,7 +2569,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ListAccounts } from "@formance/formance-sdk/funcs/ledgerV2ListAccounts.js"; +import { ledgerV2ListTransactions } from "@formance/formance-sdk/funcs/ledgerV2ListTransactions.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1796,16 +2581,17 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ListAccounts(sdk, { + const res = await ledgerV2ListTransactions(sdk, { cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", ledger: "ledger001", pageSize: 100, + sort: "id:desc", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ListAccounts failed:", res.error); + console.log("ledgerV2ListTransactions failed:", res.error); } } @@ -1816,14 +2602,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ListAccountsRequest](../../sdk/models/operations/v2listaccountsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ListTransactionsRequest](../../sdk/models/operations/v2listtransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ListAccountsResponse](../../sdk/models/operations/v2listaccountsresponse.md)\>** +**Promise\<[operations.V2ListTransactionsResponse](../../sdk/models/operations/v2listtransactionsresponse.md)\>** ### Errors @@ -1832,13 +2618,14 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## listLedgers +## readStats + +Get statistics from a ledger. (aggregate metrics on accounts and transactions) -List ledgers ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1850,9 +2637,8 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.listLedgers({ - cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", - pageSize: 100, + const result = await sdk.ledger.v2.readStats({ + ledger: "ledger001", }); console.log(result); @@ -1867,7 +2653,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ListLedgers } from "@formance/formance-sdk/funcs/ledgerV2ListLedgers.js"; +import { ledgerV2ReadStats } from "@formance/formance-sdk/funcs/ledgerV2ReadStats.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1879,15 +2665,14 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ListLedgers(sdk, { - cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", - pageSize: 100, + const res = await ledgerV2ReadStats(sdk, { + ledger: "ledger001", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ListLedgers failed:", res.error); + console.log("ledgerV2ReadStats failed:", res.error); } } @@ -1898,14 +2683,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ListLedgersRequest](../../sdk/models/operations/v2listledgersrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ReadStatsRequest](../../sdk/models/operations/v2readstatsrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ListLedgersResponse](../../sdk/models/operations/v2listledgersresponse.md)\>** +**Promise\<[operations.V2ReadStatsResponse](../../sdk/models/operations/v2readstatsresponse.md)\>** ### Errors @@ -1914,13 +2699,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## listLogs +## resetPipeline -List the logs from a ledger, sorted by ID in descending order. +Reset pipeline ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -1932,10 +2717,9 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.listLogs({ - cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + const result = await sdk.ledger.v2.resetPipeline({ ledger: "ledger001", - pageSize: 100, + pipelineID: "", }); console.log(result); @@ -1950,7 +2734,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ListLogs } from "@formance/formance-sdk/funcs/ledgerV2ListLogs.js"; +import { ledgerV2ResetPipeline } from "@formance/formance-sdk/funcs/ledgerV2ResetPipeline.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -1962,16 +2746,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ListLogs(sdk, { - cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + const res = await ledgerV2ResetPipeline(sdk, { ledger: "ledger001", - pageSize: 100, + pipelineID: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ListLogs failed:", res.error); + console.log("ledgerV2ResetPipeline failed:", res.error); } } @@ -1982,14 +2765,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ListLogsRequest](../../sdk/models/operations/v2listlogsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2ResetPipelineRequest](../../sdk/models/operations/v2resetpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ListLogsResponse](../../sdk/models/operations/v2listlogsresponse.md)\>** +**Promise\<[operations.V2ResetPipelineResponse](../../sdk/models/operations/v2resetpipelineresponse.md)\>** ### Errors @@ -1998,13 +2781,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## listTransactions +## revertTransaction -List transactions from a ledger, sorted by id in descending order. +Revert a ledger transaction by its ID ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -2016,10 +2799,10 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.listTransactions({ - cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + const result = await sdk.ledger.v2.revertTransaction({ + dryRun: true, + id: 1234n, ledger: "ledger001", - pageSize: 100, }); console.log(result); @@ -2034,7 +2817,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ListTransactions } from "@formance/formance-sdk/funcs/ledgerV2ListTransactions.js"; +import { ledgerV2RevertTransaction } from "@formance/formance-sdk/funcs/ledgerV2RevertTransaction.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -2046,16 +2829,16 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ListTransactions(sdk, { - cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==", + const res = await ledgerV2RevertTransaction(sdk, { + dryRun: true, + id: 1234n, ledger: "ledger001", - pageSize: 100, }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ListTransactions failed:", res.error); + console.log("ledgerV2RevertTransaction failed:", res.error); } } @@ -2066,14 +2849,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ListTransactionsRequest](../../sdk/models/operations/v2listtransactionsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2RevertTransactionRequest](../../sdk/models/operations/v2reverttransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ListTransactionsResponse](../../sdk/models/operations/v2listtransactionsresponse.md)\>** +**Promise\<[operations.V2RevertTransactionResponse](../../sdk/models/operations/v2reverttransactionresponse.md)\>** ### Errors @@ -2082,14 +2865,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## readStats - -Get statistics from a ledger. (aggregate metrics on accounts and transactions) +## startPipeline +Start pipeline ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -2101,8 +2883,9 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.readStats({ + const result = await sdk.ledger.v2.startPipeline({ ledger: "ledger001", + pipelineID: "", }); console.log(result); @@ -2117,7 +2900,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2ReadStats } from "@formance/formance-sdk/funcs/ledgerV2ReadStats.js"; +import { ledgerV2StartPipeline } from "@formance/formance-sdk/funcs/ledgerV2StartPipeline.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -2129,14 +2912,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2ReadStats(sdk, { + const res = await ledgerV2StartPipeline(sdk, { ledger: "ledger001", + pipelineID: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2ReadStats failed:", res.error); + console.log("ledgerV2StartPipeline failed:", res.error); } } @@ -2147,14 +2931,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2ReadStatsRequest](../../sdk/models/operations/v2readstatsrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2StartPipelineRequest](../../sdk/models/operations/v2startpipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2ReadStatsResponse](../../sdk/models/operations/v2readstatsresponse.md)\>** +**Promise\<[operations.V2StartPipelineResponse](../../sdk/models/operations/v2startpipelineresponse.md)\>** ### Errors @@ -2163,13 +2947,13 @@ run(); | errors.V2ErrorResponse | default | application/json | | errors.SDKError | 4XX, 5XX | \*/\* | -## revertTransaction +## stopPipeline -Revert a ledger transaction by its ID +Stop pipeline ### Example Usage - + ```typescript import { SDK } from "@formance/formance-sdk"; @@ -2181,10 +2965,9 @@ const sdk = new SDK({ }); async function run() { - const result = await sdk.ledger.v2.revertTransaction({ - dryRun: true, - id: 1234n, + const result = await sdk.ledger.v2.stopPipeline({ ledger: "ledger001", + pipelineID: "", }); console.log(result); @@ -2199,7 +2982,7 @@ The standalone function version of this method: ```typescript import { SDKCore } from "@formance/formance-sdk/core.js"; -import { ledgerV2RevertTransaction } from "@formance/formance-sdk/funcs/ledgerV2RevertTransaction.js"; +import { ledgerV2StopPipeline } from "@formance/formance-sdk/funcs/ledgerV2StopPipeline.js"; // Use `SDKCore` for best tree-shaking performance. // You can create one instance of it to use across an application. @@ -2211,16 +2994,15 @@ const sdk = new SDKCore({ }); async function run() { - const res = await ledgerV2RevertTransaction(sdk, { - dryRun: true, - id: 1234n, + const res = await ledgerV2StopPipeline(sdk, { ledger: "ledger001", + pipelineID: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { - console.log("ledgerV2RevertTransaction failed:", res.error); + console.log("ledgerV2StopPipeline failed:", res.error); } } @@ -2231,14 +3013,14 @@ run(); | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `request` | [operations.V2RevertTransactionRequest](../../sdk/models/operations/v2reverttransactionrequest.md) | :heavy_check_mark: | The request object to use for the request. | +| `request` | [operations.V2StopPipelineRequest](../../sdk/models/operations/v2stoppipelinerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response -**Promise\<[operations.V2RevertTransactionResponse](../../sdk/models/operations/v2reverttransactionresponse.md)\>** +**Promise\<[operations.V2StopPipelineResponse](../../sdk/models/operations/v2stoppipelineresponse.md)\>** ### Errors diff --git a/examples/package-lock.json b/examples/package-lock.json index 13249903..d38c90de 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -18,7 +18,7 @@ }, "..": { "name": "@formance/formance-sdk", - "version": "4.5.0", + "version": "4.6.0", "dependencies": { "zod": "^3.20.0" }, diff --git a/gen.yaml b/gen.yaml index 8e760fbf..acbea361 100755 --- a/gen.yaml +++ b/gen.yaml @@ -22,7 +22,8 @@ generation: comments: {} telemetryEnabled: false typescript: - version: 4.5.0 + version: 4.6.0 + acceptHeaderEnum: true additionalDependencies: dependencies: {} devDependencies: {} @@ -52,6 +53,7 @@ typescript: jsonpath: legacy maxMethodParams: 0 methodArguments: require-security-and-request + modelPropertyCasing: camel moduleFormat: commonjs outputModelSuffix: output packageName: '@formance/formance-sdk' diff --git a/jsr.json b/jsr.json index e2ba2100..79f0051b 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@formance/formance-sdk", - "version": "4.5.0", + "version": "4.6.0", "exports": { ".": "./src/index.ts", "./sdk/models/errors": "./src/sdk/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index d84ae33d..cedc7809 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@formance/formance-sdk", - "version": "4.5.0", + "version": "4.6.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@formance/formance-sdk", - "version": "4.5.0", + "version": "4.6.0", "dependencies": { "zod": "^3.20.0" }, diff --git a/package.json b/package.json index d40e63d3..fcdd9ae1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@formance/formance-sdk", - "version": "4.5.0", + "version": "4.6.0", "author": "Formance", "main": "./index.js", "sideEffects": false, diff --git a/src/funcs/ledgerV2GetInfo.ts b/src/funcs/ledgerGetInfo.ts similarity index 99% rename from src/funcs/ledgerV2GetInfo.ts rename to src/funcs/ledgerGetInfo.ts index 8523c687..7bbdbb0f 100644 --- a/src/funcs/ledgerV2GetInfo.ts +++ b/src/funcs/ledgerGetInfo.ts @@ -26,7 +26,7 @@ import { Result } from "../sdk/types/fp.js"; /** * Show server information */ -export function ledgerV2GetInfo( +export function ledgerGetInfo( client: SDKCore, options?: RequestOptions, ): APIPromise< diff --git a/src/funcs/ledgerV2GetMetrics.ts b/src/funcs/ledgerGetMetrics.ts similarity index 99% rename from src/funcs/ledgerV2GetMetrics.ts rename to src/funcs/ledgerGetMetrics.ts index d105ad2f..f604e5af 100644 --- a/src/funcs/ledgerV2GetMetrics.ts +++ b/src/funcs/ledgerGetMetrics.ts @@ -26,7 +26,7 @@ import { Result } from "../sdk/types/fp.js"; /** * Read in memory metrics */ -export function ledgerV2GetMetrics( +export function ledgerGetMetrics( client: SDKCore, options?: RequestOptions, ): APIPromise< diff --git a/src/funcs/ledgerV1CountAccounts.ts b/src/funcs/ledgerV1CountAccounts.ts index 72470ce9..5ad8c98e 100644 --- a/src/funcs/ledgerV1CountAccounts.ts +++ b/src/funcs/ledgerV1CountAccounts.ts @@ -177,7 +177,7 @@ async function $do( | UnexpectedClientError | SDKValidationError >( - M.nil(200, operations.CountAccountsResponse$inboundSchema, { hdrs: true }), + M.nil(204, operations.CountAccountsResponse$inboundSchema, { hdrs: true }), M.jsonErr("default", errors.ErrorResponse$inboundSchema), )(response, req, { extraFields: responseFields }); if (!result.ok) { diff --git a/src/funcs/ledgerV2CreateExporter.ts b/src/funcs/ledgerV2CreateExporter.ts new file mode 100644 index 00000000..d13141f8 --- /dev/null +++ b/src/funcs/ledgerV2CreateExporter.ts @@ -0,0 +1,170 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeJSON } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import * as shared from "../sdk/models/shared/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Create exporter + */ +export function ledgerV2CreateExporter( + client: SDKCore, + request: shared.V2ExporterConfiguration, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2CreateExporterResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: shared.V2ExporterConfiguration, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2CreateExporterResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => shared.V2ExporterConfiguration$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = encodeJSON("body", payload, { explode: true }); + + const path = pathToFunc("/api/ledger/v2/_/exporters")(); + + const headers = new Headers(compactMap({ + "Content-Type": "application/json", + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2CreateExporter", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2CreateExporterResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(201, operations.V2CreateExporterResponse$inboundSchema, { + key: "object", + }), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2CreatePipeline.ts b/src/funcs/ledgerV2CreatePipeline.ts new file mode 100644 index 00000000..05599471 --- /dev/null +++ b/src/funcs/ledgerV2CreatePipeline.ts @@ -0,0 +1,178 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeJSON, encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Create pipeline + */ +export function ledgerV2CreatePipeline( + client: SDKCore, + request: operations.V2CreatePipelineRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2CreatePipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2CreatePipelineRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2CreatePipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2CreatePipelineRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = encodeJSON("body", payload.V2CreatePipelineRequest, { + explode: true, + }); + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc("/api/ledger/v2/{ledger}/pipelines")(pathParams); + + const headers = new Headers(compactMap({ + "Content-Type": "application/json", + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2CreatePipeline", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2CreatePipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(201, operations.V2CreatePipelineResponse$inboundSchema, { + key: "object", + }), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2DeleteExporter.ts b/src/funcs/ledgerV2DeleteExporter.ts new file mode 100644 index 00000000..cf359012 --- /dev/null +++ b/src/funcs/ledgerV2DeleteExporter.ts @@ -0,0 +1,175 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Delete exporter + */ +export function ledgerV2DeleteExporter( + client: SDKCore, + request: operations.V2DeleteExporterRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2DeleteExporterResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2DeleteExporterRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2DeleteExporterResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2DeleteExporterRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + exporterID: encodeSimple("exporterID", payload.exporterID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc("/api/ledger/v2/_/exporters/{exporterID}")( + pathParams, + ); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2DeleteExporter", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "DELETE", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2DeleteExporterResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.nil(204, operations.V2DeleteExporterResponse$inboundSchema), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2DeletePipeline.ts b/src/funcs/ledgerV2DeletePipeline.ts new file mode 100644 index 00000000..66ad62f2 --- /dev/null +++ b/src/funcs/ledgerV2DeletePipeline.ts @@ -0,0 +1,179 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Delete pipeline + */ +export function ledgerV2DeletePipeline( + client: SDKCore, + request: operations.V2DeletePipelineRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2DeletePipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2DeletePipelineRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2DeletePipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2DeletePipelineRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + pipelineID: encodeSimple("pipelineID", payload.pipelineID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc("/api/ledger/v2/{ledger}/pipelines/{pipelineID}")( + pathParams, + ); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2DeletePipeline", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "DELETE", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2DeletePipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.nil(204, operations.V2DeletePipelineResponse$inboundSchema), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2GetExporterState.ts b/src/funcs/ledgerV2GetExporterState.ts new file mode 100644 index 00000000..a189ed9e --- /dev/null +++ b/src/funcs/ledgerV2GetExporterState.ts @@ -0,0 +1,177 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Get exporter state + */ +export function ledgerV2GetExporterState( + client: SDKCore, + request: operations.V2GetExporterStateRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2GetExporterStateResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2GetExporterStateRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2GetExporterStateResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2GetExporterStateRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + exporterID: encodeSimple("exporterID", payload.exporterID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc("/api/ledger/v2/_/exporters/{exporterID}")( + pathParams, + ); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2GetExporterState", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "GET", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2GetExporterStateResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(200, operations.V2GetExporterStateResponse$inboundSchema, { + key: "object", + }), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2GetPipelineState.ts b/src/funcs/ledgerV2GetPipelineState.ts new file mode 100644 index 00000000..26f2bbc2 --- /dev/null +++ b/src/funcs/ledgerV2GetPipelineState.ts @@ -0,0 +1,181 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Get pipeline state + */ +export function ledgerV2GetPipelineState( + client: SDKCore, + request: operations.V2GetPipelineStateRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2GetPipelineStateResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2GetPipelineStateRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2GetPipelineStateResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2GetPipelineStateRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + pipelineID: encodeSimple("pipelineID", payload.pipelineID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc("/api/ledger/v2/{ledger}/pipelines/{pipelineID}")( + pathParams, + ); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2GetPipelineState", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "GET", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2GetPipelineStateResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(200, operations.V2GetPipelineStateResponse$inboundSchema, { + key: "object", + }), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2GetVolumesWithBalances.ts b/src/funcs/ledgerV2GetVolumesWithBalances.ts index 013b24f9..a32295c5 100644 --- a/src/funcs/ledgerV2GetVolumesWithBalances.ts +++ b/src/funcs/ledgerV2GetVolumesWithBalances.ts @@ -107,6 +107,7 @@ async function $do( "groupBy": payload.groupBy, "insertionDate": payload.insertionDate, "pageSize": payload.pageSize, + "sort": payload.sort, "startTime": payload.startTime, }), encodeJSONQuery({ diff --git a/src/funcs/ledgerV2ListAccounts.ts b/src/funcs/ledgerV2ListAccounts.ts index 474d0915..8e5c8575 100644 --- a/src/funcs/ledgerV2ListAccounts.ts +++ b/src/funcs/ledgerV2ListAccounts.ts @@ -108,6 +108,7 @@ async function $do( "expand": payload.expand, "pageSize": payload.pageSize, "pit": payload.pit, + "sort": payload.sort, }), encodeJSONQuery({ "query": payload.query, diff --git a/src/funcs/ledgerV2ListExporters.ts b/src/funcs/ledgerV2ListExporters.ts new file mode 100644 index 00000000..2426caee --- /dev/null +++ b/src/funcs/ledgerV2ListExporters.ts @@ -0,0 +1,151 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * List exporters + */ +export function ledgerV2ListExporters( + client: SDKCore, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2ListExportersResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + options, + )); +} + +async function $do( + client: SDKCore, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2ListExportersResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const path = pathToFunc("/api/ledger/v2/_/exporters")(); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2ListExporters", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "GET", + baseURL: options?.serverURL, + path: path, + headers: headers, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2ListExportersResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(200, operations.V2ListExportersResponse$inboundSchema, { + key: "object", + }), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2ListLedgers.ts b/src/funcs/ledgerV2ListLedgers.ts index 9b5fbb22..9294976d 100644 --- a/src/funcs/ledgerV2ListLedgers.ts +++ b/src/funcs/ledgerV2ListLedgers.ts @@ -90,6 +90,7 @@ async function $do( const query = encodeFormQuery({ "cursor": payload.cursor, "pageSize": payload.pageSize, + "sort": payload.sort, }); const headers = new Headers(compactMap({ diff --git a/src/funcs/ledgerV2ListLogs.ts b/src/funcs/ledgerV2ListLogs.ts index 1447cc29..f651fbf7 100644 --- a/src/funcs/ledgerV2ListLogs.ts +++ b/src/funcs/ledgerV2ListLogs.ts @@ -107,6 +107,7 @@ async function $do( "cursor": payload.cursor, "pageSize": payload.pageSize, "pit": payload.pit, + "sort": payload.sort, }), encodeJSONQuery({ "query": payload.query, diff --git a/src/funcs/ledgerV2ListPipelines.ts b/src/funcs/ledgerV2ListPipelines.ts new file mode 100644 index 00000000..bd3471d8 --- /dev/null +++ b/src/funcs/ledgerV2ListPipelines.ts @@ -0,0 +1,175 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * List pipelines + */ +export function ledgerV2ListPipelines( + client: SDKCore, + request: operations.V2ListPipelinesRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2ListPipelinesResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2ListPipelinesRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2ListPipelinesResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2ListPipelinesRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc("/api/ledger/v2/{ledger}/pipelines")(pathParams); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2ListPipelines", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "GET", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2ListPipelinesResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.json(200, operations.V2ListPipelinesResponse$inboundSchema, { + key: "object", + }), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2ListTransactions.ts b/src/funcs/ledgerV2ListTransactions.ts index 4e42ace8..40786333 100644 --- a/src/funcs/ledgerV2ListTransactions.ts +++ b/src/funcs/ledgerV2ListTransactions.ts @@ -110,6 +110,7 @@ async function $do( "pageSize": payload.pageSize, "pit": payload.pit, "reverse": payload.reverse, + "sort": payload.sort, }), encodeJSONQuery({ "query": payload.query, diff --git a/src/funcs/ledgerV2ResetPipeline.ts b/src/funcs/ledgerV2ResetPipeline.ts new file mode 100644 index 00000000..063bb37b --- /dev/null +++ b/src/funcs/ledgerV2ResetPipeline.ts @@ -0,0 +1,179 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Reset pipeline + */ +export function ledgerV2ResetPipeline( + client: SDKCore, + request: operations.V2ResetPipelineRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2ResetPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2ResetPipelineRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2ResetPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2ResetPipelineRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + pipelineID: encodeSimple("pipelineID", payload.pipelineID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc( + "/api/ledger/v2/{ledger}/pipelines/{pipelineID}/reset", + )(pathParams); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2ResetPipeline", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2ResetPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.nil(202, operations.V2ResetPipelineResponse$inboundSchema), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2RevertTransaction.ts b/src/funcs/ledgerV2RevertTransaction.ts index a5dd7658..0c3cdb9c 100644 --- a/src/funcs/ledgerV2RevertTransaction.ts +++ b/src/funcs/ledgerV2RevertTransaction.ts @@ -3,7 +3,7 @@ */ import { SDKCore } from "../core.js"; -import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; +import { encodeFormQuery, encodeJSON, encodeSimple } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { compactMap } from "../lib/primitives.js"; import { safeParse } from "../lib/schemas.js"; @@ -84,7 +84,9 @@ async function $do( return [parsed, { status: "invalid" }]; } const payload = parsed.value; - const body = null; + const body = encodeJSON("body", payload.V2RevertTransactionRequest, { + explode: true, + }); const pathParams = { id: encodeSimple("id", payload.id, { @@ -108,6 +110,7 @@ async function $do( }); const headers = new Headers(compactMap({ + "Content-Type": "application/json", Accept: "application/json", })); diff --git a/src/funcs/ledgerV2StartPipeline.ts b/src/funcs/ledgerV2StartPipeline.ts new file mode 100644 index 00000000..0991de42 --- /dev/null +++ b/src/funcs/ledgerV2StartPipeline.ts @@ -0,0 +1,179 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Start pipeline + */ +export function ledgerV2StartPipeline( + client: SDKCore, + request: operations.V2StartPipelineRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2StartPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2StartPipelineRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2StartPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2StartPipelineRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + pipelineID: encodeSimple("pipelineID", payload.pipelineID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc( + "/api/ledger/v2/{ledger}/pipelines/{pipelineID}/start", + )(pathParams); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2StartPipeline", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2StartPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.nil(202, operations.V2StartPipelineResponse$inboundSchema), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/ledgerV2StopPipeline.ts b/src/funcs/ledgerV2StopPipeline.ts new file mode 100644 index 00000000..f5bc70e4 --- /dev/null +++ b/src/funcs/ledgerV2StopPipeline.ts @@ -0,0 +1,179 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import { SDKCore } from "../core.js"; +import { encodeSimple } from "../lib/encodings.js"; +import * as M from "../lib/matchers.js"; +import { compactMap } from "../lib/primitives.js"; +import { safeParse } from "../lib/schemas.js"; +import { RequestOptions } from "../lib/sdks.js"; +import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; +import { pathToFunc } from "../lib/url.js"; +import { + ConnectionError, + InvalidRequestError, + RequestAbortedError, + RequestTimeoutError, + UnexpectedClientError, +} from "../sdk/models/errors/httpclienterrors.js"; +import * as errors from "../sdk/models/errors/index.js"; +import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; +import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js"; +import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; +import * as operations from "../sdk/models/operations/index.js"; +import { APICall, APIPromise } from "../sdk/types/async.js"; +import { Result } from "../sdk/types/fp.js"; + +/** + * Stop pipeline + */ +export function ledgerV2StopPipeline( + client: SDKCore, + request: operations.V2StopPipelineRequest, + options?: RequestOptions, +): APIPromise< + Result< + operations.V2StopPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + > +> { + return new APIPromise($do( + client, + request, + options, + )); +} + +async function $do( + client: SDKCore, + request: operations.V2StopPipelineRequest, + options?: RequestOptions, +): Promise< + [ + Result< + operations.V2StopPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >, + APICall, + ] +> { + const parsed = safeParse( + request, + (value) => operations.V2StopPipelineRequest$outboundSchema.parse(value), + "Input validation failed", + ); + if (!parsed.ok) { + return [parsed, { status: "invalid" }]; + } + const payload = parsed.value; + const body = null; + + const pathParams = { + ledger: encodeSimple("ledger", payload.ledger, { + explode: false, + charEncoding: "percent", + }), + pipelineID: encodeSimple("pipelineID", payload.pipelineID, { + explode: false, + charEncoding: "percent", + }), + }; + + const path = pathToFunc( + "/api/ledger/v2/{ledger}/pipelines/{pipelineID}/stop", + )(pathParams); + + const headers = new Headers(compactMap({ + Accept: "application/json", + })); + + const securityInput = await extractSecurity(client._options.security); + const requestSecurity = resolveGlobalSecurity(securityInput); + + const context = { + options: client._options, + baseURL: options?.serverURL ?? client._baseURL ?? "", + operationID: "v2StopPipeline", + oAuth2Scopes: ["auth:read"], + + resolvedSecurity: requestSecurity, + + securitySource: client._options.security, + retryConfig: options?.retries + || client._options.retryConfig + || { strategy: "none" }, + retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], + }; + + const requestRes = client._createRequest(context, { + security: requestSecurity, + method: "POST", + baseURL: options?.serverURL, + path: path, + headers: headers, + body: body, + userAgent: client._options.userAgent, + timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, + }, options); + if (!requestRes.ok) { + return [requestRes, { status: "invalid" }]; + } + const req = requestRes.value; + + const doResult = await client._do(req, { + context, + errorCodes: ["default"], + retryConfig: context.retryConfig, + retryCodes: context.retryCodes, + }); + if (!doResult.ok) { + return [doResult, { status: "request-error", request: req }]; + } + const response = doResult.value; + + const responseFields = { + ContentType: response.headers.get("content-type") + ?? "application/octet-stream", + StatusCode: response.status, + RawResponse: response, + Headers: {}, + }; + + const [result] = await M.match< + operations.V2StopPipelineResponse, + | errors.V2ErrorResponse + | SDKBaseError + | ResponseValidationError + | ConnectionError + | RequestAbortedError + | RequestTimeoutError + | InvalidRequestError + | UnexpectedClientError + | SDKValidationError + >( + M.nil(202, operations.V2StopPipelineResponse$inboundSchema), + M.jsonErr("default", errors.V2ErrorResponse$inboundSchema), + )(response, req, { extraFields: responseFields }); + if (!result.ok) { + return [result, { status: "complete", request: req, response }]; + } + + return [result, { status: "complete", request: req, response }]; +} diff --git a/src/funcs/reconciliationV1ListPolicies.ts b/src/funcs/reconciliationV1ListPolicies.ts index e105a899..28ef19e5 100644 --- a/src/funcs/reconciliationV1ListPolicies.ts +++ b/src/funcs/reconciliationV1ListPolicies.ts @@ -3,7 +3,11 @@ */ import { SDKCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; +import { + encodeFormQuery, + encodeJSONQuery, + queryJoin, +} from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { compactMap } from "../lib/primitives.js"; import { safeParse } from "../lib/schemas.js"; @@ -87,10 +91,15 @@ async function $do( const path = pathToFunc("/api/reconciliation/policies")(); - const query = encodeFormQuery({ - "cursor": payload.cursor, - "pageSize": payload.pageSize, - }); + const query = queryJoin( + encodeFormQuery({ + "cursor": payload.cursor, + "pageSize": payload.pageSize, + }), + encodeJSONQuery({ + "query": payload.query, + }, { explode: false }), + ); const headers = new Headers(compactMap({ Accept: "application/json", diff --git a/src/funcs/reconciliationV1ListReconciliations.ts b/src/funcs/reconciliationV1ListReconciliations.ts index 4cff9164..945ac668 100644 --- a/src/funcs/reconciliationV1ListReconciliations.ts +++ b/src/funcs/reconciliationV1ListReconciliations.ts @@ -3,7 +3,11 @@ */ import { SDKCore } from "../core.js"; -import { encodeFormQuery } from "../lib/encodings.js"; +import { + encodeFormQuery, + encodeJSONQuery, + queryJoin, +} from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { compactMap } from "../lib/primitives.js"; import { safeParse } from "../lib/schemas.js"; @@ -88,10 +92,15 @@ async function $do( const path = pathToFunc("/api/reconciliation/reconciliations")(); - const query = encodeFormQuery({ - "cursor": payload.cursor, - "pageSize": payload.pageSize, - }); + const query = queryJoin( + encodeFormQuery({ + "cursor": payload.cursor, + "pageSize": payload.pageSize, + }), + encodeJSONQuery({ + "query": payload.query, + }, { explode: false }), + ); const headers = new Headers(compactMap({ Accept: "application/json", diff --git a/src/lib/config.ts b/src/lib/config.ts index 15b55611..f194fcc8 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -27,7 +27,6 @@ export const ServerList = [ * The environment name. Defaults to the production environment. */ export const ServerEnvironment = { - EuSandbox: "eu.sandbox", Sandbox: "sandbox", EuWest1: "eu-west-1", UsEast1: "us-east-1", @@ -78,7 +77,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { const serverParams: Params[] = [ {}, { - "environment": options.environment ?? "eu.sandbox", + "environment": options.environment ?? "sandbox", "organization": options.organization ?? "orgID-stackID", }, ]; @@ -99,9 +98,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", - openapiDocVersion: "v3.0.5", - sdkVersion: "4.5.0", - genVersion: "2.701.8", + openapiDocVersion: "v3.1.0", + sdkVersion: "4.6.0", + genVersion: "2.721.3", userAgent: - "speakeasy-sdk/typescript 4.5.0 2.701.8 v3.0.5 @formance/formance-sdk", + "speakeasy-sdk/typescript 4.6.0 2.721.3 v3.1.0 @formance/formance-sdk", } as const; diff --git a/src/lib/url.ts b/src/lib/url.ts index 6bc6356e..f3a8de6c 100644 --- a/src/lib/url.ts +++ b/src/lib/url.ts @@ -10,7 +10,7 @@ export function pathToFunc( pathPattern: string, options?: { charEncoding?: "percent" | "none" }, ): (params?: Params) => string { - const paramRE = /\{([a-zA-Z0-9_]+?)\}/g; + const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g; return function buildURLPath(params: Record = {}): string { return pathPattern.replace(paramRE, function (_, placeholder) { diff --git a/src/sdk/ledger.ts b/src/sdk/ledger.ts index 9dfefa50..a95bba6a 100644 --- a/src/sdk/ledger.ts +++ b/src/sdk/ledger.ts @@ -2,18 +2,46 @@ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ -import { ClientSDK } from "../lib/sdks.js"; +import { ledgerGetInfo } from "../funcs/ledgerGetInfo.js"; +import { ledgerGetMetrics } from "../funcs/ledgerGetMetrics.js"; +import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import { LedgerV1 } from "./ledgerv1.js"; import { LedgerV2 } from "./ledgerv2.js"; +import * as operations from "./models/operations/index.js"; +import { unwrapAsync } from "./types/fp.js"; export class Ledger extends ClientSDK { + private _v1?: LedgerV1; + get v1(): LedgerV1 { + return (this._v1 ??= new LedgerV1(this._options)); + } + private _v2?: LedgerV2; get v2(): LedgerV2 { return (this._v2 ??= new LedgerV2(this._options)); } - private _v1?: LedgerV1; - get v1(): LedgerV1 { - return (this._v1 ??= new LedgerV1(this._options)); + /** + * Show server information + */ + async getInfo( + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerGetInfo( + this, + options, + )); + } + + /** + * Read in memory metrics + */ + async getMetrics( + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerGetMetrics( + this, + options, + )); } } diff --git a/src/sdk/ledgerv2.ts b/src/sdk/ledgerv2.ts index f81904fb..9f4a68ec 100644 --- a/src/sdk/ledgerv2.ts +++ b/src/sdk/ledgerv2.ts @@ -7,30 +7,40 @@ import { ledgerV2AddMetadataToAccount } from "../funcs/ledgerV2AddMetadataToAcco import { ledgerV2CountAccounts } from "../funcs/ledgerV2CountAccounts.js"; import { ledgerV2CountTransactions } from "../funcs/ledgerV2CountTransactions.js"; import { ledgerV2CreateBulk } from "../funcs/ledgerV2CreateBulk.js"; +import { ledgerV2CreateExporter } from "../funcs/ledgerV2CreateExporter.js"; import { ledgerV2CreateLedger } from "../funcs/ledgerV2CreateLedger.js"; +import { ledgerV2CreatePipeline } from "../funcs/ledgerV2CreatePipeline.js"; import { ledgerV2CreateTransaction } from "../funcs/ledgerV2CreateTransaction.js"; import { ledgerV2DeleteAccountMetadata } from "../funcs/ledgerV2DeleteAccountMetadata.js"; +import { ledgerV2DeleteExporter } from "../funcs/ledgerV2DeleteExporter.js"; import { ledgerV2DeleteLedgerMetadata } from "../funcs/ledgerV2DeleteLedgerMetadata.js"; +import { ledgerV2DeletePipeline } from "../funcs/ledgerV2DeletePipeline.js"; import { ledgerV2DeleteTransactionMetadata } from "../funcs/ledgerV2DeleteTransactionMetadata.js"; import { ledgerV2ExportLogs } from "../funcs/ledgerV2ExportLogs.js"; import { ledgerV2GetAccount } from "../funcs/ledgerV2GetAccount.js"; import { ledgerV2GetBalancesAggregated } from "../funcs/ledgerV2GetBalancesAggregated.js"; -import { ledgerV2GetInfo } from "../funcs/ledgerV2GetInfo.js"; +import { ledgerV2GetExporterState } from "../funcs/ledgerV2GetExporterState.js"; import { ledgerV2GetLedger } from "../funcs/ledgerV2GetLedger.js"; import { ledgerV2GetLedgerInfo } from "../funcs/ledgerV2GetLedgerInfo.js"; -import { ledgerV2GetMetrics } from "../funcs/ledgerV2GetMetrics.js"; +import { ledgerV2GetPipelineState } from "../funcs/ledgerV2GetPipelineState.js"; import { ledgerV2GetTransaction } from "../funcs/ledgerV2GetTransaction.js"; import { ledgerV2GetVolumesWithBalances } from "../funcs/ledgerV2GetVolumesWithBalances.js"; import { ledgerV2ImportLogs } from "../funcs/ledgerV2ImportLogs.js"; import { ledgerV2ListAccounts } from "../funcs/ledgerV2ListAccounts.js"; +import { ledgerV2ListExporters } from "../funcs/ledgerV2ListExporters.js"; import { ledgerV2ListLedgers } from "../funcs/ledgerV2ListLedgers.js"; import { ledgerV2ListLogs } from "../funcs/ledgerV2ListLogs.js"; +import { ledgerV2ListPipelines } from "../funcs/ledgerV2ListPipelines.js"; import { ledgerV2ListTransactions } from "../funcs/ledgerV2ListTransactions.js"; import { ledgerV2ReadStats } from "../funcs/ledgerV2ReadStats.js"; +import { ledgerV2ResetPipeline } from "../funcs/ledgerV2ResetPipeline.js"; import { ledgerV2RevertTransaction } from "../funcs/ledgerV2RevertTransaction.js"; +import { ledgerV2StartPipeline } from "../funcs/ledgerV2StartPipeline.js"; +import { ledgerV2StopPipeline } from "../funcs/ledgerV2StopPipeline.js"; import { ledgerV2UpdateLedgerMetadata } from "../funcs/ledgerV2UpdateLedgerMetadata.js"; import { ClientSDK, RequestOptions } from "../lib/sdks.js"; import * as operations from "./models/operations/index.js"; +import * as shared from "./models/shared/index.js"; import { unwrapAsync } from "./types/fp.js"; export class LedgerV2 extends ClientSDK { @@ -104,6 +114,20 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * Create exporter + */ + async createExporter( + request: shared.V2ExporterConfiguration, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2CreateExporter( + this, + request, + options, + )); + } + /** * Create a ledger */ @@ -118,6 +142,20 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * Create pipeline + */ + async createPipeline( + request: operations.V2CreatePipelineRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2CreatePipeline( + this, + request, + options, + )); + } + /** * Create a new transaction to a ledger */ @@ -149,6 +187,20 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * Delete exporter + */ + async deleteExporter( + request: operations.V2DeleteExporterRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2DeleteExporter( + this, + request, + options, + )); + } + /** * Delete ledger metadata by key */ @@ -163,6 +215,20 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * Delete pipeline + */ + async deletePipeline( + request: operations.V2DeletePipelineRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2DeletePipeline( + this, + request, + options, + )); + } + /** * Delete metadata by key * @@ -223,13 +289,15 @@ export class LedgerV2 extends ClientSDK { } /** - * Show server information + * Get exporter state */ - async getInfo( + async getExporterState( + request: operations.V2GetExporterStateRequest, options?: RequestOptions, - ): Promise { - return unwrapAsync(ledgerV2GetInfo( + ): Promise { + return unwrapAsync(ledgerV2GetExporterState( this, + request, options, )); } @@ -263,13 +331,15 @@ export class LedgerV2 extends ClientSDK { } /** - * Read in memory metrics + * Get pipeline state */ - async getMetrics( + async getPipelineState( + request: operations.V2GetPipelineStateRequest, options?: RequestOptions, - ): Promise { - return unwrapAsync(ledgerV2GetMetrics( + ): Promise { + return unwrapAsync(ledgerV2GetPipelineState( this, + request, options, )); } @@ -330,6 +400,18 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * List exporters + */ + async listExporters( + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2ListExporters( + this, + options, + )); + } + /** * List ledgers */ @@ -361,6 +443,20 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * List pipelines + */ + async listPipelines( + request: operations.V2ListPipelinesRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2ListPipelines( + this, + request, + options, + )); + } + /** * List transactions from a ledger * @@ -395,6 +491,20 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * Reset pipeline + */ + async resetPipeline( + request: operations.V2ResetPipelineRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2ResetPipeline( + this, + request, + options, + )); + } + /** * Revert a ledger transaction by its ID */ @@ -409,6 +519,34 @@ export class LedgerV2 extends ClientSDK { )); } + /** + * Start pipeline + */ + async startPipeline( + request: operations.V2StartPipelineRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2StartPipeline( + this, + request, + options, + )); + } + + /** + * Stop pipeline + */ + async stopPipeline( + request: operations.V2StopPipelineRequest, + options?: RequestOptions, + ): Promise { + return unwrapAsync(ledgerV2StopPipeline( + this, + request, + options, + )); + } + /** * Update ledger metadata */ diff --git a/src/sdk/models/errors/index.ts b/src/sdk/models/errors/index.ts index 832b8a98..64f87547 100644 --- a/src/sdk/models/errors/index.ts +++ b/src/sdk/models/errors/index.ts @@ -8,6 +8,7 @@ export * from "./httpclienterrors.js"; export * from "./paymentserrorresponse.js"; export * from "./reconciliationerrorresponse.js"; export * from "./responsevalidationerror.js"; +export * from "./sdkbaseerror.js"; export * from "./sdkerror.js"; export * from "./sdkvalidationerror.js"; export * from "./v2error.js"; diff --git a/src/sdk/models/operations/index.ts b/src/sdk/models/operations/index.ts index 77f56a6e..aeab966a 100644 --- a/src/sdk/models/operations/index.ts +++ b/src/sdk/models/operations/index.ts @@ -135,42 +135,53 @@ export * from "./v2cancelevent.js"; export * from "./v2countaccounts.js"; export * from "./v2counttransactions.js"; export * from "./v2createbulk.js"; +export * from "./v2createexporter.js"; export * from "./v2createledger.js"; +export * from "./v2createpipeline.js"; export * from "./v2createtransaction.js"; export * from "./v2createtrigger.js"; export * from "./v2createworkflow.js"; export * from "./v2deleteaccountmetadata.js"; +export * from "./v2deleteexporter.js"; export * from "./v2deleteledgermetadata.js"; +export * from "./v2deletepipeline.js"; export * from "./v2deletetransactionmetadata.js"; export * from "./v2deletetrigger.js"; export * from "./v2deleteworkflow.js"; export * from "./v2exportlogs.js"; export * from "./v2getaccount.js"; export * from "./v2getbalancesaggregated.js"; +export * from "./v2getexporterstate.js"; export * from "./v2getinfo.js"; export * from "./v2getinstance.js"; export * from "./v2getinstancehistory.js"; export * from "./v2getinstancestagehistory.js"; export * from "./v2getledger.js"; export * from "./v2getledgerinfo.js"; +export * from "./v2getpipelinestate.js"; export * from "./v2getserverinfo.js"; export * from "./v2gettransaction.js"; export * from "./v2getvolumeswithbalances.js"; export * from "./v2getworkflow.js"; export * from "./v2importlogs.js"; export * from "./v2listaccounts.js"; +export * from "./v2listexporters.js"; export * from "./v2listinstances.js"; export * from "./v2listledgers.js"; export * from "./v2listlogs.js"; +export * from "./v2listpipelines.js"; export * from "./v2listtransactions.js"; export * from "./v2listtriggers.js"; export * from "./v2listtriggersoccurrences.js"; export * from "./v2listworkflows.js"; export * from "./v2readstats.js"; export * from "./v2readtrigger.js"; +export * from "./v2resetpipeline.js"; export * from "./v2reverttransaction.js"; export * from "./v2runworkflow.js"; export * from "./v2sendevent.js"; +export * from "./v2startpipeline.js"; +export * from "./v2stoppipeline.js"; export * from "./v2updateledgermetadata.js"; export * from "./v3addaccounttopool.js"; export * from "./v3addbankaccounttopaymentserviceuser.js"; diff --git a/src/sdk/models/operations/listpolicies.ts b/src/sdk/models/operations/listpolicies.ts index 720243fb..e303807d 100644 --- a/src/sdk/models/operations/listpolicies.ts +++ b/src/sdk/models/operations/listpolicies.ts @@ -25,6 +25,7 @@ export type ListPoliciesRequest = { * @remarks */ pageSize?: number | undefined; + query?: { [k: string]: any } | undefined; }; export type ListPoliciesResponse = { @@ -54,12 +55,14 @@ export const ListPoliciesRequest$inboundSchema: z.ZodType< > = z.object({ cursor: z.string().optional(), pageSize: z.number().int().optional(), + query: z.record(z.any()).optional(), }); /** @internal */ export type ListPoliciesRequest$Outbound = { cursor?: string | undefined; pageSize?: number | undefined; + query?: { [k: string]: any } | undefined; }; /** @internal */ @@ -70,6 +73,7 @@ export const ListPoliciesRequest$outboundSchema: z.ZodType< > = z.object({ cursor: z.string().optional(), pageSize: z.number().int().optional(), + query: z.record(z.any()).optional(), }); /** diff --git a/src/sdk/models/operations/listreconciliations.ts b/src/sdk/models/operations/listreconciliations.ts index b7db8986..f3ce63bd 100644 --- a/src/sdk/models/operations/listreconciliations.ts +++ b/src/sdk/models/operations/listreconciliations.ts @@ -25,6 +25,7 @@ export type ListReconciliationsRequest = { * @remarks */ pageSize?: number | undefined; + query?: { [k: string]: any } | undefined; }; export type ListReconciliationsResponse = { @@ -56,12 +57,14 @@ export const ListReconciliationsRequest$inboundSchema: z.ZodType< > = z.object({ cursor: z.string().optional(), pageSize: z.number().int().optional(), + query: z.record(z.any()).optional(), }); /** @internal */ export type ListReconciliationsRequest$Outbound = { cursor?: string | undefined; pageSize?: number | undefined; + query?: { [k: string]: any } | undefined; }; /** @internal */ @@ -72,6 +75,7 @@ export const ListReconciliationsRequest$outboundSchema: z.ZodType< > = z.object({ cursor: z.string().optional(), pageSize: z.number().int().optional(), + query: z.record(z.any()).optional(), }); /** diff --git a/src/sdk/models/operations/runscript.ts b/src/sdk/models/operations/runscript.ts index 039a5776..a2e3a8af 100644 --- a/src/sdk/models/operations/runscript.ts +++ b/src/sdk/models/operations/runscript.ts @@ -32,6 +32,7 @@ export type RunScriptResponse = { * @remarks * * On failure, it will also return a 200 status code, and the following fields: + * * - `details`: contains a URL. When there is an error parsing Numscript, the result can be difficult to read—the provided URL will render the error in an easy-to-read format. * - `errorCode` and `error_code` (deprecated): contains the string code of the error * - `errorMessage` and `error_message` (deprecated): contains a human-readable indication of what went wrong, for example that an account had insufficient funds, or that there was an error in the provided Numscript. diff --git a/src/sdk/models/operations/v2createexporter.ts b/src/sdk/models/operations/v2createexporter.ts new file mode 100644 index 00000000..49393eb7 --- /dev/null +++ b/src/sdk/models/operations/v2createexporter.ts @@ -0,0 +1,169 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import * as shared from "../shared/index.js"; + +/** + * Created exporter + */ +export type V2CreateExporterResponseBody = { + data: shared.V2Exporter; +}; + +export type V2CreateExporterResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; + /** + * Created exporter + */ + object?: V2CreateExporterResponseBody | undefined; +}; + +/** @internal */ +export const V2CreateExporterResponseBody$inboundSchema: z.ZodType< + V2CreateExporterResponseBody, + z.ZodTypeDef, + unknown +> = z.object({ + data: shared.V2Exporter$inboundSchema, +}); + +/** @internal */ +export type V2CreateExporterResponseBody$Outbound = { + data: shared.V2Exporter$Outbound; +}; + +/** @internal */ +export const V2CreateExporterResponseBody$outboundSchema: z.ZodType< + V2CreateExporterResponseBody$Outbound, + z.ZodTypeDef, + V2CreateExporterResponseBody +> = z.object({ + data: shared.V2Exporter$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2CreateExporterResponseBody$ { + /** @deprecated use `V2CreateExporterResponseBody$inboundSchema` instead. */ + export const inboundSchema = V2CreateExporterResponseBody$inboundSchema; + /** @deprecated use `V2CreateExporterResponseBody$outboundSchema` instead. */ + export const outboundSchema = V2CreateExporterResponseBody$outboundSchema; + /** @deprecated use `V2CreateExporterResponseBody$Outbound` instead. */ + export type Outbound = V2CreateExporterResponseBody$Outbound; +} + +export function v2CreateExporterResponseBodyToJSON( + v2CreateExporterResponseBody: V2CreateExporterResponseBody, +): string { + return JSON.stringify( + V2CreateExporterResponseBody$outboundSchema.parse( + v2CreateExporterResponseBody, + ), + ); +} + +export function v2CreateExporterResponseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2CreateExporterResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2CreateExporterResponseBody' from JSON`, + ); +} + +/** @internal */ +export const V2CreateExporterResponse$inboundSchema: z.ZodType< + V2CreateExporterResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), + object: z.lazy(() => V2CreateExporterResponseBody$inboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2CreateExporterResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; + object?: V2CreateExporterResponseBody$Outbound | undefined; +}; + +/** @internal */ +export const V2CreateExporterResponse$outboundSchema: z.ZodType< + V2CreateExporterResponse$Outbound, + z.ZodTypeDef, + V2CreateExporterResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), + object: z.lazy(() => V2CreateExporterResponseBody$outboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2CreateExporterResponse$ { + /** @deprecated use `V2CreateExporterResponse$inboundSchema` instead. */ + export const inboundSchema = V2CreateExporterResponse$inboundSchema; + /** @deprecated use `V2CreateExporterResponse$outboundSchema` instead. */ + export const outboundSchema = V2CreateExporterResponse$outboundSchema; + /** @deprecated use `V2CreateExporterResponse$Outbound` instead. */ + export type Outbound = V2CreateExporterResponse$Outbound; +} + +export function v2CreateExporterResponseToJSON( + v2CreateExporterResponse: V2CreateExporterResponse, +): string { + return JSON.stringify( + V2CreateExporterResponse$outboundSchema.parse(v2CreateExporterResponse), + ); +} + +export function v2CreateExporterResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2CreateExporterResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2CreateExporterResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2createpipeline.ts b/src/sdk/models/operations/v2createpipeline.ts new file mode 100644 index 00000000..ae13636e --- /dev/null +++ b/src/sdk/models/operations/v2createpipeline.ts @@ -0,0 +1,244 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import * as shared from "../shared/index.js"; + +export type V2CreatePipelineRequest = { + v2CreatePipelineRequest?: shared.V2CreatePipelineRequest | undefined; + /** + * Name of the ledger. + */ + ledger: string; +}; + +/** + * Created ipeline + */ +export type V2CreatePipelineResponseBody = { + data: shared.V2Pipeline; +}; + +export type V2CreatePipelineResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; + /** + * Created ipeline + */ + object?: V2CreatePipelineResponseBody | undefined; +}; + +/** @internal */ +export const V2CreatePipelineRequest$inboundSchema: z.ZodType< + V2CreatePipelineRequest, + z.ZodTypeDef, + unknown +> = z.object({ + V2CreatePipelineRequest: shared.V2CreatePipelineRequest$inboundSchema + .optional(), + ledger: z.string(), +}).transform((v) => { + return remap$(v, { + "V2CreatePipelineRequest": "v2CreatePipelineRequest", + }); +}); + +/** @internal */ +export type V2CreatePipelineRequest$Outbound = { + V2CreatePipelineRequest?: shared.V2CreatePipelineRequest$Outbound | undefined; + ledger: string; +}; + +/** @internal */ +export const V2CreatePipelineRequest$outboundSchema: z.ZodType< + V2CreatePipelineRequest$Outbound, + z.ZodTypeDef, + V2CreatePipelineRequest +> = z.object({ + v2CreatePipelineRequest: shared.V2CreatePipelineRequest$outboundSchema + .optional(), + ledger: z.string(), +}).transform((v) => { + return remap$(v, { + v2CreatePipelineRequest: "V2CreatePipelineRequest", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2CreatePipelineRequest$ { + /** @deprecated use `V2CreatePipelineRequest$inboundSchema` instead. */ + export const inboundSchema = V2CreatePipelineRequest$inboundSchema; + /** @deprecated use `V2CreatePipelineRequest$outboundSchema` instead. */ + export const outboundSchema = V2CreatePipelineRequest$outboundSchema; + /** @deprecated use `V2CreatePipelineRequest$Outbound` instead. */ + export type Outbound = V2CreatePipelineRequest$Outbound; +} + +export function v2CreatePipelineRequestToJSON( + v2CreatePipelineRequest: V2CreatePipelineRequest, +): string { + return JSON.stringify( + V2CreatePipelineRequest$outboundSchema.parse(v2CreatePipelineRequest), + ); +} + +export function v2CreatePipelineRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2CreatePipelineRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2CreatePipelineRequest' from JSON`, + ); +} + +/** @internal */ +export const V2CreatePipelineResponseBody$inboundSchema: z.ZodType< + V2CreatePipelineResponseBody, + z.ZodTypeDef, + unknown +> = z.object({ + data: shared.V2Pipeline$inboundSchema, +}); + +/** @internal */ +export type V2CreatePipelineResponseBody$Outbound = { + data: shared.V2Pipeline$Outbound; +}; + +/** @internal */ +export const V2CreatePipelineResponseBody$outboundSchema: z.ZodType< + V2CreatePipelineResponseBody$Outbound, + z.ZodTypeDef, + V2CreatePipelineResponseBody +> = z.object({ + data: shared.V2Pipeline$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2CreatePipelineResponseBody$ { + /** @deprecated use `V2CreatePipelineResponseBody$inboundSchema` instead. */ + export const inboundSchema = V2CreatePipelineResponseBody$inboundSchema; + /** @deprecated use `V2CreatePipelineResponseBody$outboundSchema` instead. */ + export const outboundSchema = V2CreatePipelineResponseBody$outboundSchema; + /** @deprecated use `V2CreatePipelineResponseBody$Outbound` instead. */ + export type Outbound = V2CreatePipelineResponseBody$Outbound; +} + +export function v2CreatePipelineResponseBodyToJSON( + v2CreatePipelineResponseBody: V2CreatePipelineResponseBody, +): string { + return JSON.stringify( + V2CreatePipelineResponseBody$outboundSchema.parse( + v2CreatePipelineResponseBody, + ), + ); +} + +export function v2CreatePipelineResponseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2CreatePipelineResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2CreatePipelineResponseBody' from JSON`, + ); +} + +/** @internal */ +export const V2CreatePipelineResponse$inboundSchema: z.ZodType< + V2CreatePipelineResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), + object: z.lazy(() => V2CreatePipelineResponseBody$inboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2CreatePipelineResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; + object?: V2CreatePipelineResponseBody$Outbound | undefined; +}; + +/** @internal */ +export const V2CreatePipelineResponse$outboundSchema: z.ZodType< + V2CreatePipelineResponse$Outbound, + z.ZodTypeDef, + V2CreatePipelineResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), + object: z.lazy(() => V2CreatePipelineResponseBody$outboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2CreatePipelineResponse$ { + /** @deprecated use `V2CreatePipelineResponse$inboundSchema` instead. */ + export const inboundSchema = V2CreatePipelineResponse$inboundSchema; + /** @deprecated use `V2CreatePipelineResponse$outboundSchema` instead. */ + export const outboundSchema = V2CreatePipelineResponse$outboundSchema; + /** @deprecated use `V2CreatePipelineResponse$Outbound` instead. */ + export type Outbound = V2CreatePipelineResponse$Outbound; +} + +export function v2CreatePipelineResponseToJSON( + v2CreatePipelineResponse: V2CreatePipelineResponse, +): string { + return JSON.stringify( + V2CreatePipelineResponse$outboundSchema.parse(v2CreatePipelineResponse), + ); +} + +export function v2CreatePipelineResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2CreatePipelineResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2CreatePipelineResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2createtransaction.ts b/src/sdk/models/operations/v2createtransaction.ts index 8bed8ca6..3f8b5f5b 100644 --- a/src/sdk/models/operations/v2createtransaction.ts +++ b/src/sdk/models/operations/v2createtransaction.ts @@ -28,6 +28,8 @@ export type V2CreateTransactionRequest = { dryRun?: boolean | undefined; /** * Disable balance checks when passing postings + * + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ force?: boolean | undefined; /** diff --git a/src/sdk/models/operations/v2deleteexporter.ts b/src/sdk/models/operations/v2deleteexporter.ts new file mode 100644 index 00000000..63fb8917 --- /dev/null +++ b/src/sdk/models/operations/v2deleteexporter.ts @@ -0,0 +1,159 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2DeleteExporterRequest = { + /** + * The exporter id + */ + exporterID: string; +}; + +export type V2DeleteExporterResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; +}; + +/** @internal */ +export const V2DeleteExporterRequest$inboundSchema: z.ZodType< + V2DeleteExporterRequest, + z.ZodTypeDef, + unknown +> = z.object({ + exporterID: z.string(), +}); + +/** @internal */ +export type V2DeleteExporterRequest$Outbound = { + exporterID: string; +}; + +/** @internal */ +export const V2DeleteExporterRequest$outboundSchema: z.ZodType< + V2DeleteExporterRequest$Outbound, + z.ZodTypeDef, + V2DeleteExporterRequest +> = z.object({ + exporterID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2DeleteExporterRequest$ { + /** @deprecated use `V2DeleteExporterRequest$inboundSchema` instead. */ + export const inboundSchema = V2DeleteExporterRequest$inboundSchema; + /** @deprecated use `V2DeleteExporterRequest$outboundSchema` instead. */ + export const outboundSchema = V2DeleteExporterRequest$outboundSchema; + /** @deprecated use `V2DeleteExporterRequest$Outbound` instead. */ + export type Outbound = V2DeleteExporterRequest$Outbound; +} + +export function v2DeleteExporterRequestToJSON( + v2DeleteExporterRequest: V2DeleteExporterRequest, +): string { + return JSON.stringify( + V2DeleteExporterRequest$outboundSchema.parse(v2DeleteExporterRequest), + ); +} + +export function v2DeleteExporterRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2DeleteExporterRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2DeleteExporterRequest' from JSON`, + ); +} + +/** @internal */ +export const V2DeleteExporterResponse$inboundSchema: z.ZodType< + V2DeleteExporterResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2DeleteExporterResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; +}; + +/** @internal */ +export const V2DeleteExporterResponse$outboundSchema: z.ZodType< + V2DeleteExporterResponse$Outbound, + z.ZodTypeDef, + V2DeleteExporterResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2DeleteExporterResponse$ { + /** @deprecated use `V2DeleteExporterResponse$inboundSchema` instead. */ + export const inboundSchema = V2DeleteExporterResponse$inboundSchema; + /** @deprecated use `V2DeleteExporterResponse$outboundSchema` instead. */ + export const outboundSchema = V2DeleteExporterResponse$outboundSchema; + /** @deprecated use `V2DeleteExporterResponse$Outbound` instead. */ + export type Outbound = V2DeleteExporterResponse$Outbound; +} + +export function v2DeleteExporterResponseToJSON( + v2DeleteExporterResponse: V2DeleteExporterResponse, +): string { + return JSON.stringify( + V2DeleteExporterResponse$outboundSchema.parse(v2DeleteExporterResponse), + ); +} + +export function v2DeleteExporterResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2DeleteExporterResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2DeleteExporterResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2deletepipeline.ts b/src/sdk/models/operations/v2deletepipeline.ts new file mode 100644 index 00000000..af22d976 --- /dev/null +++ b/src/sdk/models/operations/v2deletepipeline.ts @@ -0,0 +1,166 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2DeletePipelineRequest = { + /** + * Name of the ledger. + */ + ledger: string; + /** + * The pipeline id + */ + pipelineID: string; +}; + +export type V2DeletePipelineResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; +}; + +/** @internal */ +export const V2DeletePipelineRequest$inboundSchema: z.ZodType< + V2DeletePipelineRequest, + z.ZodTypeDef, + unknown +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** @internal */ +export type V2DeletePipelineRequest$Outbound = { + ledger: string; + pipelineID: string; +}; + +/** @internal */ +export const V2DeletePipelineRequest$outboundSchema: z.ZodType< + V2DeletePipelineRequest$Outbound, + z.ZodTypeDef, + V2DeletePipelineRequest +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2DeletePipelineRequest$ { + /** @deprecated use `V2DeletePipelineRequest$inboundSchema` instead. */ + export const inboundSchema = V2DeletePipelineRequest$inboundSchema; + /** @deprecated use `V2DeletePipelineRequest$outboundSchema` instead. */ + export const outboundSchema = V2DeletePipelineRequest$outboundSchema; + /** @deprecated use `V2DeletePipelineRequest$Outbound` instead. */ + export type Outbound = V2DeletePipelineRequest$Outbound; +} + +export function v2DeletePipelineRequestToJSON( + v2DeletePipelineRequest: V2DeletePipelineRequest, +): string { + return JSON.stringify( + V2DeletePipelineRequest$outboundSchema.parse(v2DeletePipelineRequest), + ); +} + +export function v2DeletePipelineRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2DeletePipelineRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2DeletePipelineRequest' from JSON`, + ); +} + +/** @internal */ +export const V2DeletePipelineResponse$inboundSchema: z.ZodType< + V2DeletePipelineResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2DeletePipelineResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; +}; + +/** @internal */ +export const V2DeletePipelineResponse$outboundSchema: z.ZodType< + V2DeletePipelineResponse$Outbound, + z.ZodTypeDef, + V2DeletePipelineResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2DeletePipelineResponse$ { + /** @deprecated use `V2DeletePipelineResponse$inboundSchema` instead. */ + export const inboundSchema = V2DeletePipelineResponse$inboundSchema; + /** @deprecated use `V2DeletePipelineResponse$outboundSchema` instead. */ + export const outboundSchema = V2DeletePipelineResponse$outboundSchema; + /** @deprecated use `V2DeletePipelineResponse$Outbound` instead. */ + export type Outbound = V2DeletePipelineResponse$Outbound; +} + +export function v2DeletePipelineResponseToJSON( + v2DeletePipelineResponse: V2DeletePipelineResponse, +): string { + return JSON.stringify( + V2DeletePipelineResponse$outboundSchema.parse(v2DeletePipelineResponse), + ); +} + +export function v2DeletePipelineResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2DeletePipelineResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2DeletePipelineResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2getexporterstate.ts b/src/sdk/models/operations/v2getexporterstate.ts new file mode 100644 index 00000000..1ee5ee3f --- /dev/null +++ b/src/sdk/models/operations/v2getexporterstate.ts @@ -0,0 +1,231 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import * as shared from "../shared/index.js"; + +export type V2GetExporterStateRequest = { + /** + * The exporter id + */ + exporterID: string; +}; + +/** + * Exporter information + */ +export type V2GetExporterStateResponseBody = { + data: shared.V2Exporter; +}; + +export type V2GetExporterStateResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; + /** + * Exporter information + */ + object?: V2GetExporterStateResponseBody | undefined; +}; + +/** @internal */ +export const V2GetExporterStateRequest$inboundSchema: z.ZodType< + V2GetExporterStateRequest, + z.ZodTypeDef, + unknown +> = z.object({ + exporterID: z.string(), +}); + +/** @internal */ +export type V2GetExporterStateRequest$Outbound = { + exporterID: string; +}; + +/** @internal */ +export const V2GetExporterStateRequest$outboundSchema: z.ZodType< + V2GetExporterStateRequest$Outbound, + z.ZodTypeDef, + V2GetExporterStateRequest +> = z.object({ + exporterID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2GetExporterStateRequest$ { + /** @deprecated use `V2GetExporterStateRequest$inboundSchema` instead. */ + export const inboundSchema = V2GetExporterStateRequest$inboundSchema; + /** @deprecated use `V2GetExporterStateRequest$outboundSchema` instead. */ + export const outboundSchema = V2GetExporterStateRequest$outboundSchema; + /** @deprecated use `V2GetExporterStateRequest$Outbound` instead. */ + export type Outbound = V2GetExporterStateRequest$Outbound; +} + +export function v2GetExporterStateRequestToJSON( + v2GetExporterStateRequest: V2GetExporterStateRequest, +): string { + return JSON.stringify( + V2GetExporterStateRequest$outboundSchema.parse(v2GetExporterStateRequest), + ); +} + +export function v2GetExporterStateRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2GetExporterStateRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2GetExporterStateRequest' from JSON`, + ); +} + +/** @internal */ +export const V2GetExporterStateResponseBody$inboundSchema: z.ZodType< + V2GetExporterStateResponseBody, + z.ZodTypeDef, + unknown +> = z.object({ + data: shared.V2Exporter$inboundSchema, +}); + +/** @internal */ +export type V2GetExporterStateResponseBody$Outbound = { + data: shared.V2Exporter$Outbound; +}; + +/** @internal */ +export const V2GetExporterStateResponseBody$outboundSchema: z.ZodType< + V2GetExporterStateResponseBody$Outbound, + z.ZodTypeDef, + V2GetExporterStateResponseBody +> = z.object({ + data: shared.V2Exporter$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2GetExporterStateResponseBody$ { + /** @deprecated use `V2GetExporterStateResponseBody$inboundSchema` instead. */ + export const inboundSchema = V2GetExporterStateResponseBody$inboundSchema; + /** @deprecated use `V2GetExporterStateResponseBody$outboundSchema` instead. */ + export const outboundSchema = V2GetExporterStateResponseBody$outboundSchema; + /** @deprecated use `V2GetExporterStateResponseBody$Outbound` instead. */ + export type Outbound = V2GetExporterStateResponseBody$Outbound; +} + +export function v2GetExporterStateResponseBodyToJSON( + v2GetExporterStateResponseBody: V2GetExporterStateResponseBody, +): string { + return JSON.stringify( + V2GetExporterStateResponseBody$outboundSchema.parse( + v2GetExporterStateResponseBody, + ), + ); +} + +export function v2GetExporterStateResponseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2GetExporterStateResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2GetExporterStateResponseBody' from JSON`, + ); +} + +/** @internal */ +export const V2GetExporterStateResponse$inboundSchema: z.ZodType< + V2GetExporterStateResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), + object: z.lazy(() => V2GetExporterStateResponseBody$inboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2GetExporterStateResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; + object?: V2GetExporterStateResponseBody$Outbound | undefined; +}; + +/** @internal */ +export const V2GetExporterStateResponse$outboundSchema: z.ZodType< + V2GetExporterStateResponse$Outbound, + z.ZodTypeDef, + V2GetExporterStateResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), + object: z.lazy(() => V2GetExporterStateResponseBody$outboundSchema) + .optional(), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2GetExporterStateResponse$ { + /** @deprecated use `V2GetExporterStateResponse$inboundSchema` instead. */ + export const inboundSchema = V2GetExporterStateResponse$inboundSchema; + /** @deprecated use `V2GetExporterStateResponse$outboundSchema` instead. */ + export const outboundSchema = V2GetExporterStateResponse$outboundSchema; + /** @deprecated use `V2GetExporterStateResponse$Outbound` instead. */ + export type Outbound = V2GetExporterStateResponse$Outbound; +} + +export function v2GetExporterStateResponseToJSON( + v2GetExporterStateResponse: V2GetExporterStateResponse, +): string { + return JSON.stringify( + V2GetExporterStateResponse$outboundSchema.parse(v2GetExporterStateResponse), + ); +} + +export function v2GetExporterStateResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2GetExporterStateResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2GetExporterStateResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2getpipelinestate.ts b/src/sdk/models/operations/v2getpipelinestate.ts new file mode 100644 index 00000000..00c52751 --- /dev/null +++ b/src/sdk/models/operations/v2getpipelinestate.ts @@ -0,0 +1,238 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import * as shared from "../shared/index.js"; + +export type V2GetPipelineStateRequest = { + /** + * Name of the ledger. + */ + ledger: string; + /** + * The pipeline id + */ + pipelineID: string; +}; + +/** + * Pipeline information + */ +export type V2GetPipelineStateResponseBody = { + data: shared.V2Pipeline; +}; + +export type V2GetPipelineStateResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; + /** + * Pipeline information + */ + object?: V2GetPipelineStateResponseBody | undefined; +}; + +/** @internal */ +export const V2GetPipelineStateRequest$inboundSchema: z.ZodType< + V2GetPipelineStateRequest, + z.ZodTypeDef, + unknown +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** @internal */ +export type V2GetPipelineStateRequest$Outbound = { + ledger: string; + pipelineID: string; +}; + +/** @internal */ +export const V2GetPipelineStateRequest$outboundSchema: z.ZodType< + V2GetPipelineStateRequest$Outbound, + z.ZodTypeDef, + V2GetPipelineStateRequest +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2GetPipelineStateRequest$ { + /** @deprecated use `V2GetPipelineStateRequest$inboundSchema` instead. */ + export const inboundSchema = V2GetPipelineStateRequest$inboundSchema; + /** @deprecated use `V2GetPipelineStateRequest$outboundSchema` instead. */ + export const outboundSchema = V2GetPipelineStateRequest$outboundSchema; + /** @deprecated use `V2GetPipelineStateRequest$Outbound` instead. */ + export type Outbound = V2GetPipelineStateRequest$Outbound; +} + +export function v2GetPipelineStateRequestToJSON( + v2GetPipelineStateRequest: V2GetPipelineStateRequest, +): string { + return JSON.stringify( + V2GetPipelineStateRequest$outboundSchema.parse(v2GetPipelineStateRequest), + ); +} + +export function v2GetPipelineStateRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2GetPipelineStateRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2GetPipelineStateRequest' from JSON`, + ); +} + +/** @internal */ +export const V2GetPipelineStateResponseBody$inboundSchema: z.ZodType< + V2GetPipelineStateResponseBody, + z.ZodTypeDef, + unknown +> = z.object({ + data: shared.V2Pipeline$inboundSchema, +}); + +/** @internal */ +export type V2GetPipelineStateResponseBody$Outbound = { + data: shared.V2Pipeline$Outbound; +}; + +/** @internal */ +export const V2GetPipelineStateResponseBody$outboundSchema: z.ZodType< + V2GetPipelineStateResponseBody$Outbound, + z.ZodTypeDef, + V2GetPipelineStateResponseBody +> = z.object({ + data: shared.V2Pipeline$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2GetPipelineStateResponseBody$ { + /** @deprecated use `V2GetPipelineStateResponseBody$inboundSchema` instead. */ + export const inboundSchema = V2GetPipelineStateResponseBody$inboundSchema; + /** @deprecated use `V2GetPipelineStateResponseBody$outboundSchema` instead. */ + export const outboundSchema = V2GetPipelineStateResponseBody$outboundSchema; + /** @deprecated use `V2GetPipelineStateResponseBody$Outbound` instead. */ + export type Outbound = V2GetPipelineStateResponseBody$Outbound; +} + +export function v2GetPipelineStateResponseBodyToJSON( + v2GetPipelineStateResponseBody: V2GetPipelineStateResponseBody, +): string { + return JSON.stringify( + V2GetPipelineStateResponseBody$outboundSchema.parse( + v2GetPipelineStateResponseBody, + ), + ); +} + +export function v2GetPipelineStateResponseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2GetPipelineStateResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2GetPipelineStateResponseBody' from JSON`, + ); +} + +/** @internal */ +export const V2GetPipelineStateResponse$inboundSchema: z.ZodType< + V2GetPipelineStateResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), + object: z.lazy(() => V2GetPipelineStateResponseBody$inboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2GetPipelineStateResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; + object?: V2GetPipelineStateResponseBody$Outbound | undefined; +}; + +/** @internal */ +export const V2GetPipelineStateResponse$outboundSchema: z.ZodType< + V2GetPipelineStateResponse$Outbound, + z.ZodTypeDef, + V2GetPipelineStateResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), + object: z.lazy(() => V2GetPipelineStateResponseBody$outboundSchema) + .optional(), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2GetPipelineStateResponse$ { + /** @deprecated use `V2GetPipelineStateResponse$inboundSchema` instead. */ + export const inboundSchema = V2GetPipelineStateResponse$inboundSchema; + /** @deprecated use `V2GetPipelineStateResponse$outboundSchema` instead. */ + export const outboundSchema = V2GetPipelineStateResponse$outboundSchema; + /** @deprecated use `V2GetPipelineStateResponse$Outbound` instead. */ + export type Outbound = V2GetPipelineStateResponse$Outbound; +} + +export function v2GetPipelineStateResponseToJSON( + v2GetPipelineStateResponse: V2GetPipelineStateResponse, +): string { + return JSON.stringify( + V2GetPipelineStateResponse$outboundSchema.parse(v2GetPipelineStateResponse), + ); +} + +export function v2GetPipelineStateResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2GetPipelineStateResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2GetPipelineStateResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2getvolumeswithbalances.ts b/src/sdk/models/operations/v2getvolumeswithbalances.ts index 4384c888..112dac04 100644 --- a/src/sdk/models/operations/v2getvolumeswithbalances.ts +++ b/src/sdk/models/operations/v2getvolumeswithbalances.ts @@ -39,6 +39,13 @@ export type V2GetVolumesWithBalancesRequest = { */ pageSize?: number | undefined; query?: { [k: string]: any } | undefined; + /** + * Sort results using a field name and order (ascending or descending). + * + * @remarks + * Format: `:`, where `` is the field name and `` is either `asc` or `desc`. + */ + sort?: string | undefined; startTime?: Date | undefined; }; @@ -77,6 +84,7 @@ export const V2GetVolumesWithBalancesRequest$inboundSchema: z.ZodType< ledger: z.string(), pageSize: z.number().int().optional(), query: z.record(z.any()).optional(), + sort: z.string().optional(), startTime: z.string().datetime({ offset: true }).transform(v => new Date(v)) .optional(), }); @@ -90,6 +98,7 @@ export type V2GetVolumesWithBalancesRequest$Outbound = { ledger: string; pageSize?: number | undefined; query?: { [k: string]: any } | undefined; + sort?: string | undefined; startTime?: string | undefined; }; @@ -106,6 +115,7 @@ export const V2GetVolumesWithBalancesRequest$outboundSchema: z.ZodType< ledger: z.string(), pageSize: z.number().int().optional(), query: z.record(z.any()).optional(), + sort: z.string().optional(), startTime: z.date().transform(v => v.toISOString()).optional(), }); diff --git a/src/sdk/models/operations/v2listaccounts.ts b/src/sdk/models/operations/v2listaccounts.ts index 0c2533f0..d730f7c0 100644 --- a/src/sdk/models/operations/v2listaccounts.ts +++ b/src/sdk/models/operations/v2listaccounts.ts @@ -32,6 +32,13 @@ export type V2ListAccountsRequest = { pageSize?: number | undefined; pit?: Date | undefined; query?: { [k: string]: any } | undefined; + /** + * Sort results using a field name and order (ascending or descending). + * + * @remarks + * Format: `:`, where `` is the field name and `` is either `asc` or `desc`. + */ + sort?: string | undefined; }; export type V2ListAccountsResponse = { @@ -66,6 +73,7 @@ export const V2ListAccountsRequest$inboundSchema: z.ZodType< pit: z.string().datetime({ offset: true }).transform(v => new Date(v)) .optional(), query: z.record(z.any()).optional(), + sort: z.string().optional(), }); /** @internal */ @@ -76,6 +84,7 @@ export type V2ListAccountsRequest$Outbound = { pageSize?: number | undefined; pit?: string | undefined; query?: { [k: string]: any } | undefined; + sort?: string | undefined; }; /** @internal */ @@ -90,6 +99,7 @@ export const V2ListAccountsRequest$outboundSchema: z.ZodType< pageSize: z.number().int().optional(), pit: z.date().transform(v => v.toISOString()).optional(), query: z.record(z.any()).optional(), + sort: z.string().optional(), }); /** diff --git a/src/sdk/models/operations/v2listexporters.ts b/src/sdk/models/operations/v2listexporters.ts new file mode 100644 index 00000000..17af00a1 --- /dev/null +++ b/src/sdk/models/operations/v2listexporters.ts @@ -0,0 +1,305 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import * as shared from "../shared/index.js"; + +export type V2ListExportersCursor2 = { + data: Array; + hasMore: boolean; + next?: string | undefined; + pageSize: number; + previous?: string | undefined; +}; + +export type V2ListExportersCursor1 = { + cursor: V2ListExportersCursor2; + data?: Array | undefined; +}; + +/** + * Exporters list + */ +export type V2ListExportersResponseBody = { + cursor?: V2ListExportersCursor1 | undefined; +}; + +export type V2ListExportersResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; + /** + * Exporters list + */ + object?: V2ListExportersResponseBody | undefined; +}; + +/** @internal */ +export const V2ListExportersCursor2$inboundSchema: z.ZodType< + V2ListExportersCursor2, + z.ZodTypeDef, + unknown +> = z.object({ + data: z.array(shared.V2Exporter$inboundSchema), + hasMore: z.boolean(), + next: z.string().optional(), + pageSize: z.number().int(), + previous: z.string().optional(), +}); + +/** @internal */ +export type V2ListExportersCursor2$Outbound = { + data: Array; + hasMore: boolean; + next?: string | undefined; + pageSize: number; + previous?: string | undefined; +}; + +/** @internal */ +export const V2ListExportersCursor2$outboundSchema: z.ZodType< + V2ListExportersCursor2$Outbound, + z.ZodTypeDef, + V2ListExportersCursor2 +> = z.object({ + data: z.array(shared.V2Exporter$outboundSchema), + hasMore: z.boolean(), + next: z.string().optional(), + pageSize: z.number().int(), + previous: z.string().optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListExportersCursor2$ { + /** @deprecated use `V2ListExportersCursor2$inboundSchema` instead. */ + export const inboundSchema = V2ListExportersCursor2$inboundSchema; + /** @deprecated use `V2ListExportersCursor2$outboundSchema` instead. */ + export const outboundSchema = V2ListExportersCursor2$outboundSchema; + /** @deprecated use `V2ListExportersCursor2$Outbound` instead. */ + export type Outbound = V2ListExportersCursor2$Outbound; +} + +export function v2ListExportersCursor2ToJSON( + v2ListExportersCursor2: V2ListExportersCursor2, +): string { + return JSON.stringify( + V2ListExportersCursor2$outboundSchema.parse(v2ListExportersCursor2), + ); +} + +export function v2ListExportersCursor2FromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListExportersCursor2$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListExportersCursor2' from JSON`, + ); +} + +/** @internal */ +export const V2ListExportersCursor1$inboundSchema: z.ZodType< + V2ListExportersCursor1, + z.ZodTypeDef, + unknown +> = z.object({ + cursor: z.lazy(() => V2ListExportersCursor2$inboundSchema), + data: z.array(shared.V2Exporter$inboundSchema).optional(), +}); + +/** @internal */ +export type V2ListExportersCursor1$Outbound = { + cursor: V2ListExportersCursor2$Outbound; + data?: Array | undefined; +}; + +/** @internal */ +export const V2ListExportersCursor1$outboundSchema: z.ZodType< + V2ListExportersCursor1$Outbound, + z.ZodTypeDef, + V2ListExportersCursor1 +> = z.object({ + cursor: z.lazy(() => V2ListExportersCursor2$outboundSchema), + data: z.array(shared.V2Exporter$outboundSchema).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListExportersCursor1$ { + /** @deprecated use `V2ListExportersCursor1$inboundSchema` instead. */ + export const inboundSchema = V2ListExportersCursor1$inboundSchema; + /** @deprecated use `V2ListExportersCursor1$outboundSchema` instead. */ + export const outboundSchema = V2ListExportersCursor1$outboundSchema; + /** @deprecated use `V2ListExportersCursor1$Outbound` instead. */ + export type Outbound = V2ListExportersCursor1$Outbound; +} + +export function v2ListExportersCursor1ToJSON( + v2ListExportersCursor1: V2ListExportersCursor1, +): string { + return JSON.stringify( + V2ListExportersCursor1$outboundSchema.parse(v2ListExportersCursor1), + ); +} + +export function v2ListExportersCursor1FromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListExportersCursor1$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListExportersCursor1' from JSON`, + ); +} + +/** @internal */ +export const V2ListExportersResponseBody$inboundSchema: z.ZodType< + V2ListExportersResponseBody, + z.ZodTypeDef, + unknown +> = z.object({ + cursor: z.lazy(() => V2ListExportersCursor1$inboundSchema).optional(), +}); + +/** @internal */ +export type V2ListExportersResponseBody$Outbound = { + cursor?: V2ListExportersCursor1$Outbound | undefined; +}; + +/** @internal */ +export const V2ListExportersResponseBody$outboundSchema: z.ZodType< + V2ListExportersResponseBody$Outbound, + z.ZodTypeDef, + V2ListExportersResponseBody +> = z.object({ + cursor: z.lazy(() => V2ListExportersCursor1$outboundSchema).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListExportersResponseBody$ { + /** @deprecated use `V2ListExportersResponseBody$inboundSchema` instead. */ + export const inboundSchema = V2ListExportersResponseBody$inboundSchema; + /** @deprecated use `V2ListExportersResponseBody$outboundSchema` instead. */ + export const outboundSchema = V2ListExportersResponseBody$outboundSchema; + /** @deprecated use `V2ListExportersResponseBody$Outbound` instead. */ + export type Outbound = V2ListExportersResponseBody$Outbound; +} + +export function v2ListExportersResponseBodyToJSON( + v2ListExportersResponseBody: V2ListExportersResponseBody, +): string { + return JSON.stringify( + V2ListExportersResponseBody$outboundSchema.parse( + v2ListExportersResponseBody, + ), + ); +} + +export function v2ListExportersResponseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListExportersResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListExportersResponseBody' from JSON`, + ); +} + +/** @internal */ +export const V2ListExportersResponse$inboundSchema: z.ZodType< + V2ListExportersResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), + object: z.lazy(() => V2ListExportersResponseBody$inboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2ListExportersResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; + object?: V2ListExportersResponseBody$Outbound | undefined; +}; + +/** @internal */ +export const V2ListExportersResponse$outboundSchema: z.ZodType< + V2ListExportersResponse$Outbound, + z.ZodTypeDef, + V2ListExportersResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), + object: z.lazy(() => V2ListExportersResponseBody$outboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListExportersResponse$ { + /** @deprecated use `V2ListExportersResponse$inboundSchema` instead. */ + export const inboundSchema = V2ListExportersResponse$inboundSchema; + /** @deprecated use `V2ListExportersResponse$outboundSchema` instead. */ + export const outboundSchema = V2ListExportersResponse$outboundSchema; + /** @deprecated use `V2ListExportersResponse$Outbound` instead. */ + export type Outbound = V2ListExportersResponse$Outbound; +} + +export function v2ListExportersResponseToJSON( + v2ListExportersResponse: V2ListExportersResponse, +): string { + return JSON.stringify( + V2ListExportersResponse$outboundSchema.parse(v2ListExportersResponse), + ); +} + +export function v2ListExportersResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListExportersResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListExportersResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2listledgers.ts b/src/sdk/models/operations/v2listledgers.ts index f0c3179d..14f995bf 100644 --- a/src/sdk/models/operations/v2listledgers.ts +++ b/src/sdk/models/operations/v2listledgers.ts @@ -25,6 +25,13 @@ export type V2ListLedgersRequest = { * @remarks */ pageSize?: number | undefined; + /** + * Sort results using a field name and order (ascending or descending). + * + * @remarks + * Format: `:`, where `` is the field name and `` is either `asc` or `desc`. + */ + sort?: string | undefined; }; export type V2ListLedgersResponse = { @@ -54,12 +61,14 @@ export const V2ListLedgersRequest$inboundSchema: z.ZodType< > = z.object({ cursor: z.string().optional(), pageSize: z.number().int().optional(), + sort: z.string().optional(), }); /** @internal */ export type V2ListLedgersRequest$Outbound = { cursor?: string | undefined; pageSize?: number | undefined; + sort?: string | undefined; }; /** @internal */ @@ -70,6 +79,7 @@ export const V2ListLedgersRequest$outboundSchema: z.ZodType< > = z.object({ cursor: z.string().optional(), pageSize: z.number().int().optional(), + sort: z.string().optional(), }); /** diff --git a/src/sdk/models/operations/v2listlogs.ts b/src/sdk/models/operations/v2listlogs.ts index 4f842a7b..cdd2b445 100644 --- a/src/sdk/models/operations/v2listlogs.ts +++ b/src/sdk/models/operations/v2listlogs.ts @@ -31,6 +31,13 @@ export type V2ListLogsRequest = { pageSize?: number | undefined; pit?: Date | undefined; query?: { [k: string]: any } | undefined; + /** + * Sort results using a field name and order (ascending or descending). + * + * @remarks + * Format: `:`, where `` is the field name and `` is either `asc` or `desc`. + */ + sort?: string | undefined; }; export type V2ListLogsResponse = { @@ -64,6 +71,7 @@ export const V2ListLogsRequest$inboundSchema: z.ZodType< pit: z.string().datetime({ offset: true }).transform(v => new Date(v)) .optional(), query: z.record(z.any()).optional(), + sort: z.string().optional(), }); /** @internal */ @@ -73,6 +81,7 @@ export type V2ListLogsRequest$Outbound = { pageSize?: number | undefined; pit?: string | undefined; query?: { [k: string]: any } | undefined; + sort?: string | undefined; }; /** @internal */ @@ -86,6 +95,7 @@ export const V2ListLogsRequest$outboundSchema: z.ZodType< pageSize: z.number().int().optional(), pit: z.date().transform(v => v.toISOString()).optional(), query: z.record(z.any()).optional(), + sort: z.string().optional(), }); /** diff --git a/src/sdk/models/operations/v2listpipelines.ts b/src/sdk/models/operations/v2listpipelines.ts new file mode 100644 index 00000000..de8126fc --- /dev/null +++ b/src/sdk/models/operations/v2listpipelines.ts @@ -0,0 +1,366 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import * as shared from "../shared/index.js"; + +export type V2ListPipelinesRequest = { + /** + * Name of the ledger. + */ + ledger: string; +}; + +export type V2ListPipelinesCursor2 = { + data: Array; + hasMore: boolean; + next?: string | undefined; + pageSize: number; + previous?: string | undefined; +}; + +export type V2ListPipelinesCursor1 = { + cursor: V2ListPipelinesCursor2; + data?: Array | undefined; +}; + +/** + * Pipelines list + */ +export type V2ListPipelinesResponseBody = { + cursor?: V2ListPipelinesCursor1 | undefined; +}; + +export type V2ListPipelinesResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; + /** + * Pipelines list + */ + object?: V2ListPipelinesResponseBody | undefined; +}; + +/** @internal */ +export const V2ListPipelinesRequest$inboundSchema: z.ZodType< + V2ListPipelinesRequest, + z.ZodTypeDef, + unknown +> = z.object({ + ledger: z.string(), +}); + +/** @internal */ +export type V2ListPipelinesRequest$Outbound = { + ledger: string; +}; + +/** @internal */ +export const V2ListPipelinesRequest$outboundSchema: z.ZodType< + V2ListPipelinesRequest$Outbound, + z.ZodTypeDef, + V2ListPipelinesRequest +> = z.object({ + ledger: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListPipelinesRequest$ { + /** @deprecated use `V2ListPipelinesRequest$inboundSchema` instead. */ + export const inboundSchema = V2ListPipelinesRequest$inboundSchema; + /** @deprecated use `V2ListPipelinesRequest$outboundSchema` instead. */ + export const outboundSchema = V2ListPipelinesRequest$outboundSchema; + /** @deprecated use `V2ListPipelinesRequest$Outbound` instead. */ + export type Outbound = V2ListPipelinesRequest$Outbound; +} + +export function v2ListPipelinesRequestToJSON( + v2ListPipelinesRequest: V2ListPipelinesRequest, +): string { + return JSON.stringify( + V2ListPipelinesRequest$outboundSchema.parse(v2ListPipelinesRequest), + ); +} + +export function v2ListPipelinesRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListPipelinesRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListPipelinesRequest' from JSON`, + ); +} + +/** @internal */ +export const V2ListPipelinesCursor2$inboundSchema: z.ZodType< + V2ListPipelinesCursor2, + z.ZodTypeDef, + unknown +> = z.object({ + data: z.array(shared.V2Pipeline$inboundSchema), + hasMore: z.boolean(), + next: z.string().optional(), + pageSize: z.number().int(), + previous: z.string().optional(), +}); + +/** @internal */ +export type V2ListPipelinesCursor2$Outbound = { + data: Array; + hasMore: boolean; + next?: string | undefined; + pageSize: number; + previous?: string | undefined; +}; + +/** @internal */ +export const V2ListPipelinesCursor2$outboundSchema: z.ZodType< + V2ListPipelinesCursor2$Outbound, + z.ZodTypeDef, + V2ListPipelinesCursor2 +> = z.object({ + data: z.array(shared.V2Pipeline$outboundSchema), + hasMore: z.boolean(), + next: z.string().optional(), + pageSize: z.number().int(), + previous: z.string().optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListPipelinesCursor2$ { + /** @deprecated use `V2ListPipelinesCursor2$inboundSchema` instead. */ + export const inboundSchema = V2ListPipelinesCursor2$inboundSchema; + /** @deprecated use `V2ListPipelinesCursor2$outboundSchema` instead. */ + export const outboundSchema = V2ListPipelinesCursor2$outboundSchema; + /** @deprecated use `V2ListPipelinesCursor2$Outbound` instead. */ + export type Outbound = V2ListPipelinesCursor2$Outbound; +} + +export function v2ListPipelinesCursor2ToJSON( + v2ListPipelinesCursor2: V2ListPipelinesCursor2, +): string { + return JSON.stringify( + V2ListPipelinesCursor2$outboundSchema.parse(v2ListPipelinesCursor2), + ); +} + +export function v2ListPipelinesCursor2FromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListPipelinesCursor2$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListPipelinesCursor2' from JSON`, + ); +} + +/** @internal */ +export const V2ListPipelinesCursor1$inboundSchema: z.ZodType< + V2ListPipelinesCursor1, + z.ZodTypeDef, + unknown +> = z.object({ + cursor: z.lazy(() => V2ListPipelinesCursor2$inboundSchema), + data: z.array(shared.V2Pipeline$inboundSchema).optional(), +}); + +/** @internal */ +export type V2ListPipelinesCursor1$Outbound = { + cursor: V2ListPipelinesCursor2$Outbound; + data?: Array | undefined; +}; + +/** @internal */ +export const V2ListPipelinesCursor1$outboundSchema: z.ZodType< + V2ListPipelinesCursor1$Outbound, + z.ZodTypeDef, + V2ListPipelinesCursor1 +> = z.object({ + cursor: z.lazy(() => V2ListPipelinesCursor2$outboundSchema), + data: z.array(shared.V2Pipeline$outboundSchema).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListPipelinesCursor1$ { + /** @deprecated use `V2ListPipelinesCursor1$inboundSchema` instead. */ + export const inboundSchema = V2ListPipelinesCursor1$inboundSchema; + /** @deprecated use `V2ListPipelinesCursor1$outboundSchema` instead. */ + export const outboundSchema = V2ListPipelinesCursor1$outboundSchema; + /** @deprecated use `V2ListPipelinesCursor1$Outbound` instead. */ + export type Outbound = V2ListPipelinesCursor1$Outbound; +} + +export function v2ListPipelinesCursor1ToJSON( + v2ListPipelinesCursor1: V2ListPipelinesCursor1, +): string { + return JSON.stringify( + V2ListPipelinesCursor1$outboundSchema.parse(v2ListPipelinesCursor1), + ); +} + +export function v2ListPipelinesCursor1FromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListPipelinesCursor1$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListPipelinesCursor1' from JSON`, + ); +} + +/** @internal */ +export const V2ListPipelinesResponseBody$inboundSchema: z.ZodType< + V2ListPipelinesResponseBody, + z.ZodTypeDef, + unknown +> = z.object({ + cursor: z.lazy(() => V2ListPipelinesCursor1$inboundSchema).optional(), +}); + +/** @internal */ +export type V2ListPipelinesResponseBody$Outbound = { + cursor?: V2ListPipelinesCursor1$Outbound | undefined; +}; + +/** @internal */ +export const V2ListPipelinesResponseBody$outboundSchema: z.ZodType< + V2ListPipelinesResponseBody$Outbound, + z.ZodTypeDef, + V2ListPipelinesResponseBody +> = z.object({ + cursor: z.lazy(() => V2ListPipelinesCursor1$outboundSchema).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListPipelinesResponseBody$ { + /** @deprecated use `V2ListPipelinesResponseBody$inboundSchema` instead. */ + export const inboundSchema = V2ListPipelinesResponseBody$inboundSchema; + /** @deprecated use `V2ListPipelinesResponseBody$outboundSchema` instead. */ + export const outboundSchema = V2ListPipelinesResponseBody$outboundSchema; + /** @deprecated use `V2ListPipelinesResponseBody$Outbound` instead. */ + export type Outbound = V2ListPipelinesResponseBody$Outbound; +} + +export function v2ListPipelinesResponseBodyToJSON( + v2ListPipelinesResponseBody: V2ListPipelinesResponseBody, +): string { + return JSON.stringify( + V2ListPipelinesResponseBody$outboundSchema.parse( + v2ListPipelinesResponseBody, + ), + ); +} + +export function v2ListPipelinesResponseBodyFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListPipelinesResponseBody$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListPipelinesResponseBody' from JSON`, + ); +} + +/** @internal */ +export const V2ListPipelinesResponse$inboundSchema: z.ZodType< + V2ListPipelinesResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), + object: z.lazy(() => V2ListPipelinesResponseBody$inboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2ListPipelinesResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; + object?: V2ListPipelinesResponseBody$Outbound | undefined; +}; + +/** @internal */ +export const V2ListPipelinesResponse$outboundSchema: z.ZodType< + V2ListPipelinesResponse$Outbound, + z.ZodTypeDef, + V2ListPipelinesResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), + object: z.lazy(() => V2ListPipelinesResponseBody$outboundSchema).optional(), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ListPipelinesResponse$ { + /** @deprecated use `V2ListPipelinesResponse$inboundSchema` instead. */ + export const inboundSchema = V2ListPipelinesResponse$inboundSchema; + /** @deprecated use `V2ListPipelinesResponse$outboundSchema` instead. */ + export const outboundSchema = V2ListPipelinesResponse$outboundSchema; + /** @deprecated use `V2ListPipelinesResponse$Outbound` instead. */ + export type Outbound = V2ListPipelinesResponse$Outbound; +} + +export function v2ListPipelinesResponseToJSON( + v2ListPipelinesResponse: V2ListPipelinesResponse, +): string { + return JSON.stringify( + V2ListPipelinesResponse$outboundSchema.parse(v2ListPipelinesResponse), + ); +} + +export function v2ListPipelinesResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ListPipelinesResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ListPipelinesResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2listtransactions.ts b/src/sdk/models/operations/v2listtransactions.ts index 31f0327d..ba210592 100644 --- a/src/sdk/models/operations/v2listtransactions.ts +++ b/src/sdk/models/operations/v2listtransactions.ts @@ -9,6 +9,9 @@ import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import * as shared from "../shared/index.js"; +/** + * Deprecated: Use sort param + */ export enum Order { Effective = "effective", } @@ -28,6 +31,11 @@ export type V2ListTransactionsRequest = { * Name of the ledger. */ ledger: string; + /** + * Deprecated: Use sort param + * + * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. + */ order?: Order | undefined; /** * The maximum number of results to return per page. @@ -38,6 +46,13 @@ export type V2ListTransactionsRequest = { pit?: Date | undefined; query?: { [k: string]: any } | undefined; reverse?: boolean | undefined; + /** + * Sort results using a field name and order (ascending or descending). + * + * @remarks + * Format: `:`, where `` is the field name and `` is either `asc` or `desc`. + */ + sort?: string | undefined; }; export type V2ListTransactionsResponse = { @@ -96,6 +111,7 @@ export const V2ListTransactionsRequest$inboundSchema: z.ZodType< .optional(), query: z.record(z.any()).optional(), reverse: z.boolean().optional(), + sort: z.string().optional(), }); /** @internal */ @@ -108,6 +124,7 @@ export type V2ListTransactionsRequest$Outbound = { pit?: string | undefined; query?: { [k: string]: any } | undefined; reverse?: boolean | undefined; + sort?: string | undefined; }; /** @internal */ @@ -124,6 +141,7 @@ export const V2ListTransactionsRequest$outboundSchema: z.ZodType< pit: z.date().transform(v => v.toISOString()).optional(), query: z.record(z.any()).optional(), reverse: z.boolean().optional(), + sort: z.string().optional(), }); /** diff --git a/src/sdk/models/operations/v2resetpipeline.ts b/src/sdk/models/operations/v2resetpipeline.ts new file mode 100644 index 00000000..620560f9 --- /dev/null +++ b/src/sdk/models/operations/v2resetpipeline.ts @@ -0,0 +1,166 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2ResetPipelineRequest = { + /** + * Name of the ledger. + */ + ledger: string; + /** + * The pipeline id + */ + pipelineID: string; +}; + +export type V2ResetPipelineResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; +}; + +/** @internal */ +export const V2ResetPipelineRequest$inboundSchema: z.ZodType< + V2ResetPipelineRequest, + z.ZodTypeDef, + unknown +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** @internal */ +export type V2ResetPipelineRequest$Outbound = { + ledger: string; + pipelineID: string; +}; + +/** @internal */ +export const V2ResetPipelineRequest$outboundSchema: z.ZodType< + V2ResetPipelineRequest$Outbound, + z.ZodTypeDef, + V2ResetPipelineRequest +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ResetPipelineRequest$ { + /** @deprecated use `V2ResetPipelineRequest$inboundSchema` instead. */ + export const inboundSchema = V2ResetPipelineRequest$inboundSchema; + /** @deprecated use `V2ResetPipelineRequest$outboundSchema` instead. */ + export const outboundSchema = V2ResetPipelineRequest$outboundSchema; + /** @deprecated use `V2ResetPipelineRequest$Outbound` instead. */ + export type Outbound = V2ResetPipelineRequest$Outbound; +} + +export function v2ResetPipelineRequestToJSON( + v2ResetPipelineRequest: V2ResetPipelineRequest, +): string { + return JSON.stringify( + V2ResetPipelineRequest$outboundSchema.parse(v2ResetPipelineRequest), + ); +} + +export function v2ResetPipelineRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ResetPipelineRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ResetPipelineRequest' from JSON`, + ); +} + +/** @internal */ +export const V2ResetPipelineResponse$inboundSchema: z.ZodType< + V2ResetPipelineResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2ResetPipelineResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; +}; + +/** @internal */ +export const V2ResetPipelineResponse$outboundSchema: z.ZodType< + V2ResetPipelineResponse$Outbound, + z.ZodTypeDef, + V2ResetPipelineResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ResetPipelineResponse$ { + /** @deprecated use `V2ResetPipelineResponse$inboundSchema` instead. */ + export const inboundSchema = V2ResetPipelineResponse$inboundSchema; + /** @deprecated use `V2ResetPipelineResponse$outboundSchema` instead. */ + export const outboundSchema = V2ResetPipelineResponse$outboundSchema; + /** @deprecated use `V2ResetPipelineResponse$Outbound` instead. */ + export type Outbound = V2ResetPipelineResponse$Outbound; +} + +export function v2ResetPipelineResponseToJSON( + v2ResetPipelineResponse: V2ResetPipelineResponse, +): string { + return JSON.stringify( + V2ResetPipelineResponse$outboundSchema.parse(v2ResetPipelineResponse), + ); +} + +export function v2ResetPipelineResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ResetPipelineResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ResetPipelineResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2reverttransaction.ts b/src/sdk/models/operations/v2reverttransaction.ts index c1751fbc..0bde6812 100644 --- a/src/sdk/models/operations/v2reverttransaction.ts +++ b/src/sdk/models/operations/v2reverttransaction.ts @@ -10,6 +10,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import * as shared from "../shared/index.js"; export type V2RevertTransactionRequest = { + v2RevertTransactionRequest?: shared.V2RevertTransactionRequest | undefined; /** * Revert transaction at effective date of the original tx */ @@ -57,15 +58,24 @@ export const V2RevertTransactionRequest$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + V2RevertTransactionRequest: shared.V2RevertTransactionRequest$inboundSchema + .optional(), atEffectiveDate: z.boolean().optional(), dryRun: z.boolean().optional(), force: z.boolean().optional(), id: z.number().transform(v => BigInt(v)), ledger: z.string(), +}).transform((v) => { + return remap$(v, { + "V2RevertTransactionRequest": "v2RevertTransactionRequest", + }); }); /** @internal */ export type V2RevertTransactionRequest$Outbound = { + V2RevertTransactionRequest?: + | shared.V2RevertTransactionRequest$Outbound + | undefined; atEffectiveDate?: boolean | undefined; dryRun?: boolean | undefined; force?: boolean | undefined; @@ -79,11 +89,17 @@ export const V2RevertTransactionRequest$outboundSchema: z.ZodType< z.ZodTypeDef, V2RevertTransactionRequest > = z.object({ + v2RevertTransactionRequest: shared.V2RevertTransactionRequest$outboundSchema + .optional(), atEffectiveDate: z.boolean().optional(), dryRun: z.boolean().optional(), force: z.boolean().optional(), id: z.bigint().transform(v => Number(v)), ledger: z.string(), +}).transform((v) => { + return remap$(v, { + v2RevertTransactionRequest: "V2RevertTransactionRequest", + }); }); /** diff --git a/src/sdk/models/operations/v2startpipeline.ts b/src/sdk/models/operations/v2startpipeline.ts new file mode 100644 index 00000000..f228d40b --- /dev/null +++ b/src/sdk/models/operations/v2startpipeline.ts @@ -0,0 +1,166 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2StartPipelineRequest = { + /** + * Name of the ledger. + */ + ledger: string; + /** + * The pipeline id + */ + pipelineID: string; +}; + +export type V2StartPipelineResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; +}; + +/** @internal */ +export const V2StartPipelineRequest$inboundSchema: z.ZodType< + V2StartPipelineRequest, + z.ZodTypeDef, + unknown +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** @internal */ +export type V2StartPipelineRequest$Outbound = { + ledger: string; + pipelineID: string; +}; + +/** @internal */ +export const V2StartPipelineRequest$outboundSchema: z.ZodType< + V2StartPipelineRequest$Outbound, + z.ZodTypeDef, + V2StartPipelineRequest +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2StartPipelineRequest$ { + /** @deprecated use `V2StartPipelineRequest$inboundSchema` instead. */ + export const inboundSchema = V2StartPipelineRequest$inboundSchema; + /** @deprecated use `V2StartPipelineRequest$outboundSchema` instead. */ + export const outboundSchema = V2StartPipelineRequest$outboundSchema; + /** @deprecated use `V2StartPipelineRequest$Outbound` instead. */ + export type Outbound = V2StartPipelineRequest$Outbound; +} + +export function v2StartPipelineRequestToJSON( + v2StartPipelineRequest: V2StartPipelineRequest, +): string { + return JSON.stringify( + V2StartPipelineRequest$outboundSchema.parse(v2StartPipelineRequest), + ); +} + +export function v2StartPipelineRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2StartPipelineRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2StartPipelineRequest' from JSON`, + ); +} + +/** @internal */ +export const V2StartPipelineResponse$inboundSchema: z.ZodType< + V2StartPipelineResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2StartPipelineResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; +}; + +/** @internal */ +export const V2StartPipelineResponse$outboundSchema: z.ZodType< + V2StartPipelineResponse$Outbound, + z.ZodTypeDef, + V2StartPipelineResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2StartPipelineResponse$ { + /** @deprecated use `V2StartPipelineResponse$inboundSchema` instead. */ + export const inboundSchema = V2StartPipelineResponse$inboundSchema; + /** @deprecated use `V2StartPipelineResponse$outboundSchema` instead. */ + export const outboundSchema = V2StartPipelineResponse$outboundSchema; + /** @deprecated use `V2StartPipelineResponse$Outbound` instead. */ + export type Outbound = V2StartPipelineResponse$Outbound; +} + +export function v2StartPipelineResponseToJSON( + v2StartPipelineResponse: V2StartPipelineResponse, +): string { + return JSON.stringify( + V2StartPipelineResponse$outboundSchema.parse(v2StartPipelineResponse), + ); +} + +export function v2StartPipelineResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2StartPipelineResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2StartPipelineResponse' from JSON`, + ); +} diff --git a/src/sdk/models/operations/v2stoppipeline.ts b/src/sdk/models/operations/v2stoppipeline.ts new file mode 100644 index 00000000..e2d84fe6 --- /dev/null +++ b/src/sdk/models/operations/v2stoppipeline.ts @@ -0,0 +1,166 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { remap as remap$ } from "../../../lib/primitives.js"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2StopPipelineRequest = { + /** + * Name of the ledger. + */ + ledger: string; + /** + * The pipeline id + */ + pipelineID: string; +}; + +export type V2StopPipelineResponse = { + /** + * HTTP response content type for this operation + */ + contentType: string; + /** + * HTTP response status code for this operation + */ + statusCode: number; + /** + * Raw HTTP response; suitable for custom response parsing + */ + rawResponse: Response; +}; + +/** @internal */ +export const V2StopPipelineRequest$inboundSchema: z.ZodType< + V2StopPipelineRequest, + z.ZodTypeDef, + unknown +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** @internal */ +export type V2StopPipelineRequest$Outbound = { + ledger: string; + pipelineID: string; +}; + +/** @internal */ +export const V2StopPipelineRequest$outboundSchema: z.ZodType< + V2StopPipelineRequest$Outbound, + z.ZodTypeDef, + V2StopPipelineRequest +> = z.object({ + ledger: z.string(), + pipelineID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2StopPipelineRequest$ { + /** @deprecated use `V2StopPipelineRequest$inboundSchema` instead. */ + export const inboundSchema = V2StopPipelineRequest$inboundSchema; + /** @deprecated use `V2StopPipelineRequest$outboundSchema` instead. */ + export const outboundSchema = V2StopPipelineRequest$outboundSchema; + /** @deprecated use `V2StopPipelineRequest$Outbound` instead. */ + export type Outbound = V2StopPipelineRequest$Outbound; +} + +export function v2StopPipelineRequestToJSON( + v2StopPipelineRequest: V2StopPipelineRequest, +): string { + return JSON.stringify( + V2StopPipelineRequest$outboundSchema.parse(v2StopPipelineRequest), + ); +} + +export function v2StopPipelineRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2StopPipelineRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2StopPipelineRequest' from JSON`, + ); +} + +/** @internal */ +export const V2StopPipelineResponse$inboundSchema: z.ZodType< + V2StopPipelineResponse, + z.ZodTypeDef, + unknown +> = z.object({ + ContentType: z.string(), + StatusCode: z.number().int(), + RawResponse: z.instanceof(Response), +}).transform((v) => { + return remap$(v, { + "ContentType": "contentType", + "StatusCode": "statusCode", + "RawResponse": "rawResponse", + }); +}); + +/** @internal */ +export type V2StopPipelineResponse$Outbound = { + ContentType: string; + StatusCode: number; + RawResponse: never; +}; + +/** @internal */ +export const V2StopPipelineResponse$outboundSchema: z.ZodType< + V2StopPipelineResponse$Outbound, + z.ZodTypeDef, + V2StopPipelineResponse +> = z.object({ + contentType: z.string(), + statusCode: z.number().int(), + rawResponse: z.instanceof(Response).transform(() => { + throw new Error("Response cannot be serialized"); + }), +}).transform((v) => { + return remap$(v, { + contentType: "ContentType", + statusCode: "StatusCode", + rawResponse: "RawResponse", + }); +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2StopPipelineResponse$ { + /** @deprecated use `V2StopPipelineResponse$inboundSchema` instead. */ + export const inboundSchema = V2StopPipelineResponse$inboundSchema; + /** @deprecated use `V2StopPipelineResponse$outboundSchema` instead. */ + export const outboundSchema = V2StopPipelineResponse$outboundSchema; + /** @deprecated use `V2StopPipelineResponse$Outbound` instead. */ + export type Outbound = V2StopPipelineResponse$Outbound; +} + +export function v2StopPipelineResponseToJSON( + v2StopPipelineResponse: V2StopPipelineResponse, +): string { + return JSON.stringify( + V2StopPipelineResponse$outboundSchema.parse(v2StopPipelineResponse), + ); +} + +export function v2StopPipelineResponseFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2StopPipelineResponse$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2StopPipelineResponse' from JSON`, + ); +} diff --git a/src/sdk/models/shared/index.ts b/src/sdk/models/shared/index.ts index 8ef022b4..9efab231 100644 --- a/src/sdk/models/shared/index.ts +++ b/src/sdk/models/shared/index.ts @@ -124,6 +124,7 @@ export * from "./orchestrationpaymentmetadata.js"; export * from "./orchestrationpaymentstatus.js"; export * from "./orchestrationposttransaction.js"; export * from "./orchestrationtransaction.js"; +export * from "./orchestrationv2account.js"; export * from "./orchestrationv2posttransaction.js"; export * from "./orchestrationv2transaction.js"; export * from "./orchestrationwallet.js"; @@ -228,6 +229,7 @@ export * from "./v2activitycreditwallet.js"; export * from "./v2activitydebitwallet.js"; export * from "./v2activitydebitwalletoutput.js"; export * from "./v2activitygetaccount.js"; +export * from "./v2activitygetaccountoutput.js"; export * from "./v2activitygetpayment.js"; export * from "./v2activitygetpaymentoutput.js"; export * from "./v2activitygetwallet.js"; @@ -247,6 +249,7 @@ export * from "./v2bulkresponse.js"; export * from "./v2configinforesponse.js"; export * from "./v2connector.js"; export * from "./v2createledgerrequest.js"; +export * from "./v2createpipelinerequest.js"; export * from "./v2createtransactionresponse.js"; export * from "./v2createtriggerresponse.js"; export * from "./v2createworkflowresponse.js"; @@ -254,6 +257,8 @@ export * from "./v2creditwalletrequest.js"; export * from "./v2debitwalletrequest.js"; export * from "./v2errorresponse.js"; export * from "./v2errorsenum.js"; +export * from "./v2exporter.js"; +export * from "./v2exporterconfiguration.js"; export * from "./v2getledgerresponse.js"; export * from "./v2gettransactionresponse.js"; export * from "./v2getworkflowinstancehistoryresponse.js"; @@ -279,9 +284,11 @@ export * from "./v2payment.js"; export * from "./v2paymentadjustment.js"; export * from "./v2paymentmetadata.js"; export * from "./v2paymentstatus.js"; +export * from "./v2pipeline.js"; export * from "./v2posting.js"; export * from "./v2posttransaction.js"; export * from "./v2readtriggerresponse.js"; +export * from "./v2reverttransactionrequest.js"; export * from "./v2runworkflowresponse.js"; export * from "./v2serverinfo.js"; export * from "./v2stage.js"; diff --git a/src/sdk/models/shared/orchestrationv2account.ts b/src/sdk/models/shared/orchestrationv2account.ts new file mode 100644 index 00000000..71bc7622 --- /dev/null +++ b/src/sdk/models/shared/orchestrationv2account.ts @@ -0,0 +1,84 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import { + V2Volume, + V2Volume$inboundSchema, + V2Volume$Outbound, + V2Volume$outboundSchema, +} from "./v2volume.js"; + +export type OrchestrationV2Account = { + address: string; + effectiveVolumes?: { [k: string]: V2Volume } | undefined; + metadata: { [k: string]: string }; + volumes?: { [k: string]: V2Volume } | undefined; +}; + +/** @internal */ +export const OrchestrationV2Account$inboundSchema: z.ZodType< + OrchestrationV2Account, + z.ZodTypeDef, + unknown +> = z.object({ + address: z.string(), + effectiveVolumes: z.record(V2Volume$inboundSchema).optional(), + metadata: z.record(z.string()), + volumes: z.record(V2Volume$inboundSchema).optional(), +}); + +/** @internal */ +export type OrchestrationV2Account$Outbound = { + address: string; + effectiveVolumes?: { [k: string]: V2Volume$Outbound } | undefined; + metadata: { [k: string]: string }; + volumes?: { [k: string]: V2Volume$Outbound } | undefined; +}; + +/** @internal */ +export const OrchestrationV2Account$outboundSchema: z.ZodType< + OrchestrationV2Account$Outbound, + z.ZodTypeDef, + OrchestrationV2Account +> = z.object({ + address: z.string(), + effectiveVolumes: z.record(V2Volume$outboundSchema).optional(), + metadata: z.record(z.string()), + volumes: z.record(V2Volume$outboundSchema).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace OrchestrationV2Account$ { + /** @deprecated use `OrchestrationV2Account$inboundSchema` instead. */ + export const inboundSchema = OrchestrationV2Account$inboundSchema; + /** @deprecated use `OrchestrationV2Account$outboundSchema` instead. */ + export const outboundSchema = OrchestrationV2Account$outboundSchema; + /** @deprecated use `OrchestrationV2Account$Outbound` instead. */ + export type Outbound = OrchestrationV2Account$Outbound; +} + +export function orchestrationV2AccountToJSON( + orchestrationV2Account: OrchestrationV2Account, +): string { + return JSON.stringify( + OrchestrationV2Account$outboundSchema.parse(orchestrationV2Account), + ); +} + +export function orchestrationV2AccountFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => OrchestrationV2Account$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'OrchestrationV2Account' from JSON`, + ); +} diff --git a/src/sdk/models/shared/trigger.ts b/src/sdk/models/shared/trigger.ts index 69765959..fabb6ff1 100644 --- a/src/sdk/models/shared/trigger.ts +++ b/src/sdk/models/shared/trigger.ts @@ -14,6 +14,7 @@ export type Trigger = { id: string; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -28,6 +29,7 @@ export const Trigger$inboundSchema: z.ZodType = id: z.string(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); @@ -39,6 +41,7 @@ export type Trigger$Outbound = { id: string; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -54,6 +57,7 @@ export const Trigger$outboundSchema: z.ZodType< id: z.string(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); diff --git a/src/sdk/models/shared/triggerdata.ts b/src/sdk/models/shared/triggerdata.ts index 22020049..76a0d533 100644 --- a/src/sdk/models/shared/triggerdata.ts +++ b/src/sdk/models/shared/triggerdata.ts @@ -12,6 +12,7 @@ export type TriggerData = { filter?: string | undefined; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -25,6 +26,7 @@ export const TriggerData$inboundSchema: z.ZodType< filter: z.string().optional(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); @@ -34,6 +36,7 @@ export type TriggerData$Outbound = { filter?: string | undefined; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -47,6 +50,7 @@ export const TriggerData$outboundSchema: z.ZodType< filter: z.string().optional(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); diff --git a/src/sdk/models/shared/v2account.ts b/src/sdk/models/shared/v2account.ts index d9a1a02e..b47063f4 100644 --- a/src/sdk/models/shared/v2account.ts +++ b/src/sdk/models/shared/v2account.ts @@ -16,7 +16,10 @@ import { export type V2Account = { address: string; effectiveVolumes?: { [k: string]: V2Volume } | undefined; + firstUsage?: Date | undefined; + insertionDate?: Date | undefined; metadata: { [k: string]: string }; + updatedAt?: Date | undefined; volumes?: { [k: string]: V2Volume } | undefined; }; @@ -28,7 +31,14 @@ export const V2Account$inboundSchema: z.ZodType< > = z.object({ address: z.string(), effectiveVolumes: z.record(V2Volume$inboundSchema).optional(), + firstUsage: z.string().datetime({ offset: true }).transform(v => new Date(v)) + .optional(), + insertionDate: z.string().datetime({ offset: true }).transform(v => + new Date(v) + ).optional(), metadata: z.record(z.string()), + updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)) + .optional(), volumes: z.record(V2Volume$inboundSchema).optional(), }); @@ -36,7 +46,10 @@ export const V2Account$inboundSchema: z.ZodType< export type V2Account$Outbound = { address: string; effectiveVolumes?: { [k: string]: V2Volume$Outbound } | undefined; + firstUsage?: string | undefined; + insertionDate?: string | undefined; metadata: { [k: string]: string }; + updatedAt?: string | undefined; volumes?: { [k: string]: V2Volume$Outbound } | undefined; }; @@ -48,7 +61,10 @@ export const V2Account$outboundSchema: z.ZodType< > = z.object({ address: z.string(), effectiveVolumes: z.record(V2Volume$outboundSchema).optional(), + firstUsage: z.date().transform(v => v.toISOString()).optional(), + insertionDate: z.date().transform(v => v.toISOString()).optional(), metadata: z.record(z.string()), + updatedAt: z.date().transform(v => v.toISOString()).optional(), volumes: z.record(V2Volume$outboundSchema).optional(), }); diff --git a/src/sdk/models/shared/v2activitygetaccountoutput.ts b/src/sdk/models/shared/v2activitygetaccountoutput.ts new file mode 100644 index 00000000..7b9928dd --- /dev/null +++ b/src/sdk/models/shared/v2activitygetaccountoutput.ts @@ -0,0 +1,72 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; +import { + OrchestrationV2Account, + OrchestrationV2Account$inboundSchema, + OrchestrationV2Account$Outbound, + OrchestrationV2Account$outboundSchema, +} from "./orchestrationv2account.js"; + +export type V2ActivityGetAccountOutput = { + data: OrchestrationV2Account; +}; + +/** @internal */ +export const V2ActivityGetAccountOutput$inboundSchema: z.ZodType< + V2ActivityGetAccountOutput, + z.ZodTypeDef, + unknown +> = z.object({ + data: OrchestrationV2Account$inboundSchema, +}); + +/** @internal */ +export type V2ActivityGetAccountOutput$Outbound = { + data: OrchestrationV2Account$Outbound; +}; + +/** @internal */ +export const V2ActivityGetAccountOutput$outboundSchema: z.ZodType< + V2ActivityGetAccountOutput$Outbound, + z.ZodTypeDef, + V2ActivityGetAccountOutput +> = z.object({ + data: OrchestrationV2Account$outboundSchema, +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ActivityGetAccountOutput$ { + /** @deprecated use `V2ActivityGetAccountOutput$inboundSchema` instead. */ + export const inboundSchema = V2ActivityGetAccountOutput$inboundSchema; + /** @deprecated use `V2ActivityGetAccountOutput$outboundSchema` instead. */ + export const outboundSchema = V2ActivityGetAccountOutput$outboundSchema; + /** @deprecated use `V2ActivityGetAccountOutput$Outbound` instead. */ + export type Outbound = V2ActivityGetAccountOutput$Outbound; +} + +export function v2ActivityGetAccountOutputToJSON( + v2ActivityGetAccountOutput: V2ActivityGetAccountOutput, +): string { + return JSON.stringify( + V2ActivityGetAccountOutput$outboundSchema.parse(v2ActivityGetAccountOutput), + ); +} + +export function v2ActivityGetAccountOutputFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ActivityGetAccountOutput$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ActivityGetAccountOutput' from JSON`, + ); +} diff --git a/src/sdk/models/shared/v2createpipelinerequest.ts b/src/sdk/models/shared/v2createpipelinerequest.ts new file mode 100644 index 00000000..04423ea4 --- /dev/null +++ b/src/sdk/models/shared/v2createpipelinerequest.ts @@ -0,0 +1,66 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2CreatePipelineRequest = { + exporterID: string; +}; + +/** @internal */ +export const V2CreatePipelineRequest$inboundSchema: z.ZodType< + V2CreatePipelineRequest, + z.ZodTypeDef, + unknown +> = z.object({ + exporterID: z.string(), +}); + +/** @internal */ +export type V2CreatePipelineRequest$Outbound = { + exporterID: string; +}; + +/** @internal */ +export const V2CreatePipelineRequest$outboundSchema: z.ZodType< + V2CreatePipelineRequest$Outbound, + z.ZodTypeDef, + V2CreatePipelineRequest +> = z.object({ + exporterID: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2CreatePipelineRequest$ { + /** @deprecated use `V2CreatePipelineRequest$inboundSchema` instead. */ + export const inboundSchema = V2CreatePipelineRequest$inboundSchema; + /** @deprecated use `V2CreatePipelineRequest$outboundSchema` instead. */ + export const outboundSchema = V2CreatePipelineRequest$outboundSchema; + /** @deprecated use `V2CreatePipelineRequest$Outbound` instead. */ + export type Outbound = V2CreatePipelineRequest$Outbound; +} + +export function v2CreatePipelineRequestToJSON( + v2CreatePipelineRequest: V2CreatePipelineRequest, +): string { + return JSON.stringify( + V2CreatePipelineRequest$outboundSchema.parse(v2CreatePipelineRequest), + ); +} + +export function v2CreatePipelineRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2CreatePipelineRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2CreatePipelineRequest' from JSON`, + ); +} diff --git a/src/sdk/models/shared/v2exporter.ts b/src/sdk/models/shared/v2exporter.ts new file mode 100644 index 00000000..60f91748 --- /dev/null +++ b/src/sdk/models/shared/v2exporter.ts @@ -0,0 +1,74 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2Exporter = { + config: { [k: string]: any }; + createdAt: Date; + driver: string; + id: string; +}; + +/** @internal */ +export const V2Exporter$inboundSchema: z.ZodType< + V2Exporter, + z.ZodTypeDef, + unknown +> = z.object({ + config: z.record(z.any()), + createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)), + driver: z.string(), + id: z.string(), +}); + +/** @internal */ +export type V2Exporter$Outbound = { + config: { [k: string]: any }; + createdAt: string; + driver: string; + id: string; +}; + +/** @internal */ +export const V2Exporter$outboundSchema: z.ZodType< + V2Exporter$Outbound, + z.ZodTypeDef, + V2Exporter +> = z.object({ + config: z.record(z.any()), + createdAt: z.date().transform(v => v.toISOString()), + driver: z.string(), + id: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2Exporter$ { + /** @deprecated use `V2Exporter$inboundSchema` instead. */ + export const inboundSchema = V2Exporter$inboundSchema; + /** @deprecated use `V2Exporter$outboundSchema` instead. */ + export const outboundSchema = V2Exporter$outboundSchema; + /** @deprecated use `V2Exporter$Outbound` instead. */ + export type Outbound = V2Exporter$Outbound; +} + +export function v2ExporterToJSON(v2Exporter: V2Exporter): string { + return JSON.stringify(V2Exporter$outboundSchema.parse(v2Exporter)); +} + +export function v2ExporterFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2Exporter$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2Exporter' from JSON`, + ); +} diff --git a/src/sdk/models/shared/v2exporterconfiguration.ts b/src/sdk/models/shared/v2exporterconfiguration.ts new file mode 100644 index 00000000..534931ca --- /dev/null +++ b/src/sdk/models/shared/v2exporterconfiguration.ts @@ -0,0 +1,70 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2ExporterConfiguration = { + config: { [k: string]: any }; + driver: string; +}; + +/** @internal */ +export const V2ExporterConfiguration$inboundSchema: z.ZodType< + V2ExporterConfiguration, + z.ZodTypeDef, + unknown +> = z.object({ + config: z.record(z.any()), + driver: z.string(), +}); + +/** @internal */ +export type V2ExporterConfiguration$Outbound = { + config: { [k: string]: any }; + driver: string; +}; + +/** @internal */ +export const V2ExporterConfiguration$outboundSchema: z.ZodType< + V2ExporterConfiguration$Outbound, + z.ZodTypeDef, + V2ExporterConfiguration +> = z.object({ + config: z.record(z.any()), + driver: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2ExporterConfiguration$ { + /** @deprecated use `V2ExporterConfiguration$inboundSchema` instead. */ + export const inboundSchema = V2ExporterConfiguration$inboundSchema; + /** @deprecated use `V2ExporterConfiguration$outboundSchema` instead. */ + export const outboundSchema = V2ExporterConfiguration$outboundSchema; + /** @deprecated use `V2ExporterConfiguration$Outbound` instead. */ + export type Outbound = V2ExporterConfiguration$Outbound; +} + +export function v2ExporterConfigurationToJSON( + v2ExporterConfiguration: V2ExporterConfiguration, +): string { + return JSON.stringify( + V2ExporterConfiguration$outboundSchema.parse(v2ExporterConfiguration), + ); +} + +export function v2ExporterConfigurationFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2ExporterConfiguration$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2ExporterConfiguration' from JSON`, + ); +} diff --git a/src/sdk/models/shared/v2ledger.ts b/src/sdk/models/shared/v2ledger.ts index 8d204267..c31d4129 100644 --- a/src/sdk/models/shared/v2ledger.ts +++ b/src/sdk/models/shared/v2ledger.ts @@ -10,6 +10,8 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export type V2Ledger = { addedAt: Date; bucket: string; + features?: { [k: string]: string } | undefined; + id?: number | undefined; metadata?: { [k: string]: string } | undefined; name: string; }; @@ -22,6 +24,8 @@ export const V2Ledger$inboundSchema: z.ZodType< > = z.object({ addedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)), bucket: z.string(), + features: z.record(z.string()).optional(), + id: z.number().int().optional(), metadata: z.record(z.string()).optional(), name: z.string(), }); @@ -30,6 +34,8 @@ export const V2Ledger$inboundSchema: z.ZodType< export type V2Ledger$Outbound = { addedAt: string; bucket: string; + features?: { [k: string]: string } | undefined; + id?: number | undefined; metadata?: { [k: string]: string } | undefined; name: string; }; @@ -42,6 +48,8 @@ export const V2Ledger$outboundSchema: z.ZodType< > = z.object({ addedAt: z.date().transform(v => v.toISOString()), bucket: z.string(), + features: z.record(z.string()).optional(), + id: z.number().int().optional(), metadata: z.record(z.string()).optional(), name: z.string(), }); diff --git a/src/sdk/models/shared/v2migrationinfo.ts b/src/sdk/models/shared/v2migrationinfo.ts index 3501df81..2252b039 100644 --- a/src/sdk/models/shared/v2migrationinfo.ts +++ b/src/sdk/models/shared/v2migrationinfo.ts @@ -10,6 +10,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js"; export enum V2MigrationInfoState { ToDo = "TO DO", Done = "DONE", + Progress = "PROGRESS", } export type V2MigrationInfo = { diff --git a/src/sdk/models/shared/v2pipeline.ts b/src/sdk/models/shared/v2pipeline.ts new file mode 100644 index 00000000..6209b917 --- /dev/null +++ b/src/sdk/models/shared/v2pipeline.ts @@ -0,0 +1,82 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2Pipeline = { + createdAt: Date; + enabled?: boolean | undefined; + exporterID: string; + id: string; + lastLogID?: number | undefined; + ledger: string; +}; + +/** @internal */ +export const V2Pipeline$inboundSchema: z.ZodType< + V2Pipeline, + z.ZodTypeDef, + unknown +> = z.object({ + createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v)), + enabled: z.boolean().optional(), + exporterID: z.string(), + id: z.string(), + lastLogID: z.number().int().optional(), + ledger: z.string(), +}); + +/** @internal */ +export type V2Pipeline$Outbound = { + createdAt: string; + enabled?: boolean | undefined; + exporterID: string; + id: string; + lastLogID?: number | undefined; + ledger: string; +}; + +/** @internal */ +export const V2Pipeline$outboundSchema: z.ZodType< + V2Pipeline$Outbound, + z.ZodTypeDef, + V2Pipeline +> = z.object({ + createdAt: z.date().transform(v => v.toISOString()), + enabled: z.boolean().optional(), + exporterID: z.string(), + id: z.string(), + lastLogID: z.number().int().optional(), + ledger: z.string(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2Pipeline$ { + /** @deprecated use `V2Pipeline$inboundSchema` instead. */ + export const inboundSchema = V2Pipeline$inboundSchema; + /** @deprecated use `V2Pipeline$outboundSchema` instead. */ + export const outboundSchema = V2Pipeline$outboundSchema; + /** @deprecated use `V2Pipeline$Outbound` instead. */ + export type Outbound = V2Pipeline$Outbound; +} + +export function v2PipelineToJSON(v2Pipeline: V2Pipeline): string { + return JSON.stringify(V2Pipeline$outboundSchema.parse(v2Pipeline)); +} + +export function v2PipelineFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2Pipeline$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2Pipeline' from JSON`, + ); +} diff --git a/src/sdk/models/shared/v2posttransaction.ts b/src/sdk/models/shared/v2posttransaction.ts index a0b7b43c..99d98898 100644 --- a/src/sdk/models/shared/v2posttransaction.ts +++ b/src/sdk/models/shared/v2posttransaction.ts @@ -13,19 +13,52 @@ import { V2Posting$outboundSchema, } from "./v2posting.js"; +/** + * The numscript runtime used to execute the script. Uses "machine" by default, unless the "--experimental-numscript-interpreter" feature flag is passed. + */ +export enum Runtime { + ExperimentalInterpreter = "experimental-interpreter", + Machine = "machine", +} + export type V2PostTransactionScript = { plain: string; vars?: { [k: string]: string } | undefined; }; export type V2PostTransaction = { + accountMetadata?: { [k: string]: { [k: string]: string } } | undefined; + force?: boolean | undefined; metadata: { [k: string]: string }; postings?: Array | undefined; reference?: string | undefined; + /** + * The numscript runtime used to execute the script. Uses "machine" by default, unless the "--experimental-numscript-interpreter" feature flag is passed. + */ + runtime?: Runtime | undefined; script?: V2PostTransactionScript | undefined; timestamp?: Date | undefined; }; +/** @internal */ +export const Runtime$inboundSchema: z.ZodNativeEnum = z + .nativeEnum(Runtime); + +/** @internal */ +export const Runtime$outboundSchema: z.ZodNativeEnum = + Runtime$inboundSchema; + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace Runtime$ { + /** @deprecated use `Runtime$inboundSchema` instead. */ + export const inboundSchema = Runtime$inboundSchema; + /** @deprecated use `Runtime$outboundSchema` instead. */ + export const outboundSchema = Runtime$outboundSchema; +} + /** @internal */ export const V2PostTransactionScript$inboundSchema: z.ZodType< V2PostTransactionScript, @@ -89,9 +122,12 @@ export const V2PostTransaction$inboundSchema: z.ZodType< z.ZodTypeDef, unknown > = z.object({ + accountMetadata: z.record(z.record(z.string())).optional(), + force: z.boolean().optional(), metadata: z.record(z.string()), postings: z.array(V2Posting$inboundSchema).optional(), reference: z.string().optional(), + runtime: Runtime$inboundSchema.optional(), script: z.lazy(() => V2PostTransactionScript$inboundSchema).optional(), timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)) .optional(), @@ -99,9 +135,12 @@ export const V2PostTransaction$inboundSchema: z.ZodType< /** @internal */ export type V2PostTransaction$Outbound = { + accountMetadata?: { [k: string]: { [k: string]: string } } | undefined; + force?: boolean | undefined; metadata: { [k: string]: string }; postings?: Array | undefined; reference?: string | undefined; + runtime?: string | undefined; script?: V2PostTransactionScript$Outbound | undefined; timestamp?: string | undefined; }; @@ -112,9 +151,12 @@ export const V2PostTransaction$outboundSchema: z.ZodType< z.ZodTypeDef, V2PostTransaction > = z.object({ + accountMetadata: z.record(z.record(z.string())).optional(), + force: z.boolean().optional(), metadata: z.record(z.string()), postings: z.array(V2Posting$outboundSchema).optional(), reference: z.string().optional(), + runtime: Runtime$outboundSchema.optional(), script: z.lazy(() => V2PostTransactionScript$outboundSchema).optional(), timestamp: z.date().transform(v => v.toISOString()).optional(), }); diff --git a/src/sdk/models/shared/v2reverttransactionrequest.ts b/src/sdk/models/shared/v2reverttransactionrequest.ts new file mode 100644 index 00000000..e86aad11 --- /dev/null +++ b/src/sdk/models/shared/v2reverttransactionrequest.ts @@ -0,0 +1,66 @@ +/* + * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + */ + +import * as z from "zod"; +import { safeParse } from "../../../lib/schemas.js"; +import { Result as SafeParseResult } from "../../types/fp.js"; +import { SDKValidationError } from "../errors/sdkvalidationerror.js"; + +export type V2RevertTransactionRequest = { + metadata?: { [k: string]: string } | undefined; +}; + +/** @internal */ +export const V2RevertTransactionRequest$inboundSchema: z.ZodType< + V2RevertTransactionRequest, + z.ZodTypeDef, + unknown +> = z.object({ + metadata: z.record(z.string()).optional(), +}); + +/** @internal */ +export type V2RevertTransactionRequest$Outbound = { + metadata?: { [k: string]: string } | undefined; +}; + +/** @internal */ +export const V2RevertTransactionRequest$outboundSchema: z.ZodType< + V2RevertTransactionRequest$Outbound, + z.ZodTypeDef, + V2RevertTransactionRequest +> = z.object({ + metadata: z.record(z.string()).optional(), +}); + +/** + * @internal + * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. + */ +export namespace V2RevertTransactionRequest$ { + /** @deprecated use `V2RevertTransactionRequest$inboundSchema` instead. */ + export const inboundSchema = V2RevertTransactionRequest$inboundSchema; + /** @deprecated use `V2RevertTransactionRequest$outboundSchema` instead. */ + export const outboundSchema = V2RevertTransactionRequest$outboundSchema; + /** @deprecated use `V2RevertTransactionRequest$Outbound` instead. */ + export type Outbound = V2RevertTransactionRequest$Outbound; +} + +export function v2RevertTransactionRequestToJSON( + v2RevertTransactionRequest: V2RevertTransactionRequest, +): string { + return JSON.stringify( + V2RevertTransactionRequest$outboundSchema.parse(v2RevertTransactionRequest), + ); +} + +export function v2RevertTransactionRequestFromJSON( + jsonString: string, +): SafeParseResult { + return safeParse( + jsonString, + (x) => V2RevertTransactionRequest$inboundSchema.parse(JSON.parse(x)), + `Failed to parse 'V2RevertTransactionRequest' from JSON`, + ); +} diff --git a/src/sdk/models/shared/v2transaction.ts b/src/sdk/models/shared/v2transaction.ts index 46b50318..e3b84367 100644 --- a/src/sdk/models/shared/v2transaction.ts +++ b/src/sdk/models/shared/v2transaction.ts @@ -36,6 +36,7 @@ export type V2Transaction = { reverted: boolean; revertedAt?: Date | undefined; timestamp: Date; + updatedAt?: Date | undefined; }; /** @internal */ @@ -60,6 +61,8 @@ export const V2Transaction$inboundSchema: z.ZodType< revertedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)) .optional(), timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)), + updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)) + .optional(), }); /** @internal */ @@ -84,6 +87,7 @@ export type V2Transaction$Outbound = { reverted: boolean; revertedAt?: string | undefined; timestamp: string; + updatedAt?: string | undefined; }; /** @internal */ @@ -106,6 +110,7 @@ export const V2Transaction$outboundSchema: z.ZodType< reverted: z.boolean(), revertedAt: z.date().transform(v => v.toISOString()).optional(), timestamp: z.date().transform(v => v.toISOString()), + updatedAt: z.date().transform(v => v.toISOString()).optional(), }); /** diff --git a/src/sdk/models/shared/v2trigger.ts b/src/sdk/models/shared/v2trigger.ts index fe425d76..92b45dea 100644 --- a/src/sdk/models/shared/v2trigger.ts +++ b/src/sdk/models/shared/v2trigger.ts @@ -14,6 +14,7 @@ export type V2Trigger = { id: string; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -29,6 +30,7 @@ export const V2Trigger$inboundSchema: z.ZodType< id: z.string(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); @@ -40,6 +42,7 @@ export type V2Trigger$Outbound = { id: string; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -55,6 +58,7 @@ export const V2Trigger$outboundSchema: z.ZodType< id: z.string(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); diff --git a/src/sdk/models/shared/v2triggerdata.ts b/src/sdk/models/shared/v2triggerdata.ts index c497f01b..8aa28288 100644 --- a/src/sdk/models/shared/v2triggerdata.ts +++ b/src/sdk/models/shared/v2triggerdata.ts @@ -12,6 +12,7 @@ export type V2TriggerData = { filter?: string | undefined; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -25,6 +26,7 @@ export const V2TriggerData$inboundSchema: z.ZodType< filter: z.string().optional(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); @@ -34,6 +36,7 @@ export type V2TriggerData$Outbound = { filter?: string | undefined; name?: string | undefined; vars?: { [k: string]: any } | undefined; + version?: string | undefined; workflowID: string; }; @@ -47,6 +50,7 @@ export const V2TriggerData$outboundSchema: z.ZodType< filter: z.string().optional(), name: z.string().optional(), vars: z.record(z.any()).optional(), + version: z.string().optional(), workflowID: z.string(), }); diff --git a/src/sdk/models/shared/v2workflowinstance.ts b/src/sdk/models/shared/v2workflowinstance.ts index c0831e45..72d1a897 100644 --- a/src/sdk/models/shared/v2workflowinstance.ts +++ b/src/sdk/models/shared/v2workflowinstance.ts @@ -12,6 +12,12 @@ import { V2StageStatus$Outbound, V2StageStatus$outboundSchema, } from "./v2stagestatus.js"; +import { + V2Workflow, + V2Workflow$inboundSchema, + V2Workflow$Outbound, + V2Workflow$outboundSchema, +} from "./v2workflow.js"; export type V2WorkflowInstance = { createdAt: Date; @@ -21,6 +27,7 @@ export type V2WorkflowInstance = { terminated: boolean; terminatedAt?: Date | undefined; updatedAt: Date; + workflow?: V2Workflow | undefined; workflowID: string; }; @@ -39,6 +46,7 @@ export const V2WorkflowInstance$inboundSchema: z.ZodType< new Date(v) ).optional(), updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)), + workflow: V2Workflow$inboundSchema.optional(), workflowID: z.string(), }); @@ -51,6 +59,7 @@ export type V2WorkflowInstance$Outbound = { terminated: boolean; terminatedAt?: string | undefined; updatedAt: string; + workflow?: V2Workflow$Outbound | undefined; workflowID: string; }; @@ -67,6 +76,7 @@ export const V2WorkflowInstance$outboundSchema: z.ZodType< terminated: z.boolean(), terminatedAt: z.date().transform(v => v.toISOString()).optional(), updatedAt: z.date().transform(v => v.toISOString()), + workflow: V2Workflow$outboundSchema.optional(), workflowID: z.string(), }); diff --git a/src/sdk/models/shared/v2workflowinstancehistorystageoutput.ts b/src/sdk/models/shared/v2workflowinstancehistorystageoutput.ts index 2d34fb95..78584256 100644 --- a/src/sdk/models/shared/v2workflowinstancehistorystageoutput.ts +++ b/src/sdk/models/shared/v2workflowinstancehistorystageoutput.ts @@ -7,12 +7,6 @@ import { remap as remap$ } from "../../../lib/primitives.js"; import { safeParse } from "../../../lib/schemas.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; -import { - V2AccountResponse, - V2AccountResponse$inboundSchema, - V2AccountResponse$Outbound, - V2AccountResponse$outboundSchema, -} from "./v2accountresponse.js"; import { V2ActivityCreateTransactionOutput, V2ActivityCreateTransactionOutput$inboundSchema, @@ -25,6 +19,12 @@ import { V2ActivityDebitWalletOutput$Outbound, V2ActivityDebitWalletOutput$outboundSchema, } from "./v2activitydebitwalletoutput.js"; +import { + V2ActivityGetAccountOutput, + V2ActivityGetAccountOutput$inboundSchema, + V2ActivityGetAccountOutput$Outbound, + V2ActivityGetAccountOutput$outboundSchema, +} from "./v2activitygetaccountoutput.js"; import { V2ActivityGetPaymentOutput, V2ActivityGetPaymentOutput$inboundSchema, @@ -47,7 +47,7 @@ import { export type V2WorkflowInstanceHistoryStageOutput = { createTransaction?: V2ActivityCreateTransactionOutput | undefined; debitWallet?: V2ActivityDebitWalletOutput | undefined; - getAccount?: V2AccountResponse | undefined; + getAccount?: V2ActivityGetAccountOutput | undefined; getPayment?: V2ActivityGetPaymentOutput | undefined; getWallet?: V2ActivityGetWalletOutput | undefined; listWallets?: V2ListWalletsResponse | undefined; @@ -61,7 +61,7 @@ export const V2WorkflowInstanceHistoryStageOutput$inboundSchema: z.ZodType< > = z.object({ CreateTransaction: V2ActivityCreateTransactionOutput$inboundSchema.optional(), DebitWallet: V2ActivityDebitWalletOutput$inboundSchema.optional(), - GetAccount: V2AccountResponse$inboundSchema.optional(), + GetAccount: V2ActivityGetAccountOutput$inboundSchema.optional(), GetPayment: V2ActivityGetPaymentOutput$inboundSchema.optional(), GetWallet: V2ActivityGetWalletOutput$inboundSchema.optional(), ListWallets: V2ListWalletsResponse$inboundSchema.optional(), @@ -80,7 +80,7 @@ export const V2WorkflowInstanceHistoryStageOutput$inboundSchema: z.ZodType< export type V2WorkflowInstanceHistoryStageOutput$Outbound = { CreateTransaction?: V2ActivityCreateTransactionOutput$Outbound | undefined; DebitWallet?: V2ActivityDebitWalletOutput$Outbound | undefined; - GetAccount?: V2AccountResponse$Outbound | undefined; + GetAccount?: V2ActivityGetAccountOutput$Outbound | undefined; GetPayment?: V2ActivityGetPaymentOutput$Outbound | undefined; GetWallet?: V2ActivityGetWalletOutput$Outbound | undefined; ListWallets?: V2ListWalletsResponse$Outbound | undefined; @@ -95,7 +95,7 @@ export const V2WorkflowInstanceHistoryStageOutput$outboundSchema: z.ZodType< createTransaction: V2ActivityCreateTransactionOutput$outboundSchema .optional(), debitWallet: V2ActivityDebitWalletOutput$outboundSchema.optional(), - getAccount: V2AccountResponse$outboundSchema.optional(), + getAccount: V2ActivityGetAccountOutput$outboundSchema.optional(), getPayment: V2ActivityGetPaymentOutput$outboundSchema.optional(), getWallet: V2ActivityGetWalletOutput$outboundSchema.optional(), listWallets: V2ListWalletsResponse$outboundSchema.optional(), diff --git a/src/sdk/models/shared/workflowinstance.ts b/src/sdk/models/shared/workflowinstance.ts index 35788551..07998e0c 100644 --- a/src/sdk/models/shared/workflowinstance.ts +++ b/src/sdk/models/shared/workflowinstance.ts @@ -12,6 +12,12 @@ import { StageStatus$Outbound, StageStatus$outboundSchema, } from "./stagestatus.js"; +import { + Workflow, + Workflow$inboundSchema, + Workflow$Outbound, + Workflow$outboundSchema, +} from "./workflow.js"; export type WorkflowInstance = { createdAt: Date; @@ -21,6 +27,7 @@ export type WorkflowInstance = { terminated: boolean; terminatedAt?: Date | undefined; updatedAt: Date; + workflow?: Workflow | undefined; workflowID: string; }; @@ -39,6 +46,7 @@ export const WorkflowInstance$inboundSchema: z.ZodType< new Date(v) ).optional(), updatedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)), + workflow: Workflow$inboundSchema.optional(), workflowID: z.string(), }); @@ -51,6 +59,7 @@ export type WorkflowInstance$Outbound = { terminated: boolean; terminatedAt?: string | undefined; updatedAt: string; + workflow?: Workflow$Outbound | undefined; workflowID: string; }; @@ -67,6 +76,7 @@ export const WorkflowInstance$outboundSchema: z.ZodType< terminated: z.boolean(), terminatedAt: z.date().transform(v => v.toISOString()).optional(), updatedAt: z.date().transform(v => v.toISOString()), + workflow: Workflow$outboundSchema.optional(), workflowID: z.string(), }); From 48dd7510fcd33ec452287be6eb9f15f1cd03745e Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Mon, 6 Oct 2025 11:40:02 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow