Skip to content

Commit 08f328a

Browse files
speakeasybotflemzord
authored andcommitted
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.517.3
1 parent 1de92a5 commit 08f328a

File tree

678 files changed

+1274
-28481
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

678 files changed

+1274
-28481
lines changed

.speakeasy/gen.lock

Lines changed: 13 additions & 233 deletions
Large diffs are not rendered by default.

.speakeasy/workflow.lock

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
speakeasyVersion: 1.509.0
1+
speakeasyVersion: 1.517.3
22
sources:
33
stacks-source:
44
sourceNamespace: stacks-source
5-
sourceRevisionDigest: sha256:044366d6af2a8e36d882be9d6a1eb64372dd74764676585e0c68ac28d1ecd117
6-
sourceBlobDigest: sha256:e583413700b9aecba27357f880a16f89537dfbf9133a31079aa911d750b454af
5+
sourceRevisionDigest: sha256:c318ca8b00b1aff49c4f5d4f6d8ae53ba397317b68997da81eaebc45b7b47f63
6+
sourceBlobDigest: sha256:b5c6c009ac10dcceaa9f613871634ff0cb8f04cc42a67362e6177c1c3e51df49
77
tags:
88
- latest
9-
- speakeasy-sdk-regen-1741087182
10-
- v3.0.1
9+
- speakeasy-sdk-regen-1741945775
10+
- v3.0.2
1111
targets:
1212
formance-sdk-typescript:
1313
source: stacks-source
1414
sourceNamespace: stacks-source
15-
sourceRevisionDigest: sha256:044366d6af2a8e36d882be9d6a1eb64372dd74764676585e0c68ac28d1ecd117
16-
sourceBlobDigest: sha256:e583413700b9aecba27357f880a16f89537dfbf9133a31079aa911d750b454af
15+
sourceRevisionDigest: sha256:c318ca8b00b1aff49c4f5d4f6d8ae53ba397317b68997da81eaebc45b7b47f63
16+
sourceBlobDigest: sha256:b5c6c009ac10dcceaa9f613871634ff0cb8f04cc42a67362e6177c1c3e51df49
1717
codeSamplesNamespace: stacks-source-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:93beb1fde0df6c4a3aa76f34830a2af320b8678bc6981217d276bae603f71800
18+
codeSamplesRevisionDigest: sha256:a0d927ce0ab6f222a8473c524331b03131fcff8f8fe6012858565eec13203b63
1919
workflow:
2020
workflowVersion: 1.0.0
2121
speakeasyVersion: latest
@@ -40,3 +40,5 @@ workflow:
4040
labelOverride:
4141
fixedValue: Typescript (SDK)
4242
blocking: false
43+
testing:
44+
enabled: false

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ and standard method from web, mobile and desktop applications.
4848
* [Custom HTTP Client](#custom-http-client)
4949
* [Authentication](#authentication-1)
5050
* [Standalone functions](#standalone-functions)
51+
* [File uploads](#file-uploads)
5152
* [Retries](#retries)
5253
* [Debugging](#debugging)
5354
* [Development](#development)
@@ -872,6 +873,46 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
872873
</details>
873874
<!-- End Standalone functions [standalone-funcs] -->
874875

876+
<!-- Start File uploads [file-upload] -->
877+
## File uploads
878+
879+
Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
880+
881+
> [!TIP]
882+
>
883+
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
884+
>
885+
> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
886+
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
887+
> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
888+
> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
889+
890+
```typescript
891+
import { SDK } from "@formance/formance-sdk";
892+
import { openAsBlob } from "node:fs";
893+
894+
const sdk = new SDK({
895+
security: {
896+
clientID: "<YOUR_CLIENT_ID_HERE>",
897+
clientSecret: "<YOUR_CLIENT_SECRET_HERE>",
898+
},
899+
});
900+
901+
async function run() {
902+
const result = await sdk.ledger.v2.importLogs({
903+
v2ImportLogsRequest: await openAsBlob("example.file"),
904+
ledger: "ledger001",
905+
});
906+
907+
// Handle the result
908+
console.log(result);
909+
}
910+
911+
run();
912+
913+
```
914+
<!-- End File uploads [file-upload] -->
915+
875916
<!-- Start Retries [retries] -->
876917
## Retries
877918

RELEASES.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,4 +256,14 @@ Based on:
256256
### Generated
257257
- [typescript v4.1.0] .
258258
### Releases
259-
- [NPM v4.1.0] https://www.npmjs.com/package/@formance/formance-sdk/v/4.1.0 - .
259+
- [NPM v4.1.0] https://www.npmjs.com/package/@formance/formance-sdk/v/4.1.0 - .
260+
261+
## 2025-03-14 09:49:17
262+
### Changes
263+
Based on:
264+
- OpenAPI Doc
265+
- Speakeasy CLI 1.517.3 (2.548.6) https://github.com/speakeasy-api/speakeasy
266+
### Generated
267+
- [typescript v4.2.0] .
268+
### Releases
269+
- [NPM v4.2.0] https://www.npmjs.com/package/@formance/formance-sdk/v/4.2.0 - .

docs/sdk/models/operations/activateconfigresponse.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ let value: ActivateConfigResponse = {
99
configResponse: {
1010
data: {
1111
active: true,
12-
createdAt: new Date("2025-11-26T04:51:12.762Z"),
12+
createdAt: new Date("2023-11-21T08:39:51.922Z"),
1313
endpoint: "https://example.com",
1414
eventTypes: [
1515
"TYPE1",
1616
"TYPE2",
1717
],
18-
id: "d90be851-ce1c-40f9-984e-4dfc81773652",
18+
id: "e4dfc817-7365-4274-880e-d8df1aff9290",
1919
secret: "V0bivxRWveaoz08afqjU6Ko/jwO0Cb+3",
20-
updatedAt: new Date("2023-10-16T00:41:24.184Z"),
20+
updatedAt: new Date("2025-11-13T21:51:48.921Z"),
2121
},
2222
},
2323
contentType: "<value>",
24-
statusCode: 300,
24+
statusCode: 206,
2525
rawResponse: new Response("{\"message\": \"hello world\"}", {
2626
headers: { "Content-Type": "application/json" },
2727
}),

docs/sdk/models/operations/addaccounttopoolresponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { AddAccountToPoolResponse } from "@formance/formance-sdk/sdk/models/oper
77

88
let value: AddAccountToPoolResponse = {
99
contentType: "<value>",
10-
statusCode: 424,
10+
statusCode: 201,
1111
rawResponse: new Response("{\"message\": \"hello world\"}", {
1212
headers: { "Content-Type": "application/json" },
1313
}),

docs/sdk/models/operations/addmetadataontransactionrequest.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
import { AddMetadataOnTransactionRequest } from "@formance/formance-sdk/sdk/models/operations";
77

88
let value: AddMetadataOnTransactionRequest = {
9+
requestBody: {
10+
"key": "<value>",
11+
},
912
ledger: "ledger001",
1013
txid: BigInt("1234"),
1114
};
@@ -15,6 +18,6 @@ let value: AddMetadataOnTransactionRequest = {
1518

1619
| Field | Type | Required | Description | Example |
1720
| --------------------- | --------------------- | --------------------- | --------------------- | --------------------- |
18-
| `requestBody` | Record<string, *any*> | :heavy_minus_sign: | metadata | |
21+
| `requestBody` | Record<string, *any*> | :heavy_check_mark: | metadata | |
1922
| `ledger` | *string* | :heavy_check_mark: | Name of the ledger. | ledger001 |
2023
| `txid` | *BigInt* | :heavy_check_mark: | Transaction ID. | 1234 |

docs/sdk/models/operations/addmetadataontransactionresponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { AddMetadataOnTransactionResponse } from "@formance/formance-sdk/sdk/mod
77

88
let value: AddMetadataOnTransactionResponse = {
99
contentType: "<value>",
10-
statusCode: 308,
10+
statusCode: 307,
1111
rawResponse: new Response("{\"message\": \"hello world\"}", {
1212
headers: { "Content-Type": "application/json" },
1313
}),

docs/sdk/models/operations/addmetadatatoaccountresponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { AddMetadataToAccountResponse } from "@formance/formance-sdk/sdk/models/
77

88
let value: AddMetadataToAccountResponse = {
99
contentType: "<value>",
10-
statusCode: 412,
10+
statusCode: 423,
1111
rawResponse: new Response("{\"message\": \"hello world\"}", {
1212
headers: { "Content-Type": "application/json" },
1313
}),

docs/sdk/models/operations/canceleventresponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { CancelEventResponse } from "@formance/formance-sdk/sdk/models/operation
77

88
let value: CancelEventResponse = {
99
contentType: "<value>",
10-
statusCode: 100,
10+
statusCode: 207,
1111
rawResponse: new Response("{\"message\": \"hello world\"}", {
1212
headers: { "Content-Type": "application/json" },
1313
}),

0 commit comments

Comments
 (0)