ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.441.1

Author: speakeasybot

.speakeasy/gen.lock

@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: 2bb10af9-e48a-4bd7-ae46-a35fa809dc29
 management:
-  docChecksum: 44df9207611e89976d823f6df231ee2b
-  docVersion: v2.1.0
-  speakeasyVersion: 1.423.2
-  generationVersion: 2.442.11
-  releaseVersion: 3.2.0
-  configChecksum: 575d7b5c8980c281c3fabe5cea2df460
+  docChecksum: 1cad063828c35998ccfdb3484f3caab0
+  docVersion: v2.1.1
+  speakeasyVersion: 1.441.1
+  generationVersion: 2.461.2
+  releaseVersion: 3.3.0
+  configChecksum: d24e401f87ab901cffa5338c63b86c93
   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.11
-    core: 3.18.2
+    core: 3.18.6
     defaultEnabledRetries: 0.1.0
     deprecations: 2.81.1
     downloadStreams: 0.1.1
     enumUnions: 0.1.0
-    envVarSecurityUsage: 0.1.1
-    errors: 2.82.3
+    envVarSecurityUsage: 0.1.2
+    errors: 2.84.0
     globalSecurity: 2.82.11
     globalSecurityCallbacks: 0.1.0
     globalServerURLs: 2.82.4
@@ -32,9 +32,9 @@ features:
     oauth2ClientCredentials: 0.2.0
     responseFormat: 0.2.3
     retries: 2.83.0
-    sdkHooks: 0.1.0
+    sdkHooks: 0.2.0
     tests: 0.7.0
-    unions: 2.85.7
+    unions: 2.85.8
 generatedFiles:
   - .eslintrc.cjs
   - .gitattributes

.speakeasy/workflow.lock

@@ -1,20 +1,20 @@
-speakeasyVersion: 1.423.2
+speakeasyVersion: 1.441.1
 sources:
     my-source:
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:f7d12f6c5cf7d4194f89dfd4988c48f12d8c34cf5902bbe96dfb886229b3f1b3
-        sourceBlobDigest: sha256:27a152e061a648cc77e2c103a656a64e8d4b64a319df8d5af09c5ec798094f3e
+        sourceRevisionDigest: sha256:25a113054c1e72e39f72b3f651ae9571df6083225130cdf314c099507d9a6d39
+        sourceBlobDigest: sha256:3e23c263761e5f072ed5b6c1218d39286188d47c0eca9823a5ecb64be3a02d57
         tags:
             - latest
-            - main
+            - speakeasy-sdk-regen-1732202930
 targets:
     formance-sdk-typescript:
         source: my-source
         sourceNamespace: my-source
-        sourceRevisionDigest: sha256:f7d12f6c5cf7d4194f89dfd4988c48f12d8c34cf5902bbe96dfb886229b3f1b3
-        sourceBlobDigest: sha256:27a152e061a648cc77e2c103a656a64e8d4b64a319df8d5af09c5ec798094f3e
+        sourceRevisionDigest: sha256:25a113054c1e72e39f72b3f651ae9571df6083225130cdf314c099507d9a6d39
+        sourceBlobDigest: sha256:3e23c263761e5f072ed5b6c1218d39286188d47c0eca9823a5ecb64be3a02d57
         codeSamplesNamespace: my-source-code-samples
-        codeSamplesRevisionDigest: sha256:11ba30e10ccf413d0785a74ac758ebee32553f88bf8b3509f26df212a821e84a
+        codeSamplesRevisionDigest: sha256:742392eb0d92e98b50315d6fddf26dfb71a3add09553a08412d18982efc85d10
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

README.md

@@ -366,10 +366,10 @@ If a HTTP request fails, an operation my also throw an error from the `sdk/model
 
 In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `createTransactions` method may throw the following errors:
 
-| Error Type           | Status Code          | Content Type         |
-| -------------------- | -------------------- | -------------------- |
-| errors.ErrorResponse | default              | application/json     |
-| errors.SDKError      | 4XX, 5XX             | \*/\*                |
+| Error Type           | Status Code | Content Type     |
+| -------------------- | ----------- | ---------------- |
+| errors.ErrorResponse | default     | application/json |
+| errors.SDKError      | 4XX, 5XX    | \*/\*            |
 
 ```typescript
 import { SDK } from "@formance/formance-sdk";
@@ -442,12 +442,16 @@ Validation errors can also occur when either method arguments or data returned f
 
 ### Select Server by Index
 
-You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
 
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `http://localhost` | None |
-| 1 | `https://{organization}.{environment}.formance.cloud` | `environment` (default is `sandbox`), `organization` (default is `orgID-stackID`) |
+| #   | Server                                                | Variables                                                          | Default values                    |
+| --- | ----------------------------------------------------- | ------------------------------------------------------------------ | --------------------------------- |
+| 0   | `http://localhost`                                    |                                                                    |                                   |
+| 1   | `https://{organization}.{environment}.formance.cloud` | `environment: models.ServerEnvironment`<br/>`organization: string` | `"sandbox"`<br/>`"orgID-stackID"` |
+
+If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
+
+#### Example
 
 ```typescript
 import { SDK } from "@formance/formance-sdk";
@@ -471,16 +475,9 @@ run();
 
 ```
 
-#### Variables
-
-Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
- * `environment: models.ServerEnvironment`
- * `organization: string`
-
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
-
+The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { SDK } from "@formance/formance-sdk";
 
@@ -560,9 +557,9 @@ const sdk = new SDK({ httpClient });
 
 This SDK supports the following security scheme globally:
 
-| Name                           | Type                           | Scheme                         |
-| ------------------------------ | ------------------------------ | ------------------------------ |
-| `clientID` `clientSecret`      | oauth2                         | OAuth2 Client Credentials Flow |
+| Name                          | Type   | Scheme                         |
+| ----------------------------- | ------ | ------------------------------ |
+| `clientID`<br/>`clientSecret` | oauth2 | OAuth2 Client Credentials Flow |
 
 You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:
 ```typescript

RELEASES.md

@@ -226,4 +226,14 @@ Based on:
 ### Generated
 - [typescript v3.2.0] .
 ### Releases
-- [NPM v3.2.0] https://www.npmjs.com/package/@formance/formance-sdk/v/3.2.0 - .
+- [NPM v3.2.0] https://www.npmjs.com/package/@formance/formance-sdk/v/3.2.0 - .
+
+## 2024-11-21 15:28:45
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.441.1 (2.461.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v3.3.0] .
+### Releases
+- [NPM v3.3.0] https://www.npmjs.com/package/@formance/formance-sdk/v/3.3.0 - .

gen.yaml

@@ -9,17 +9,19 @@ generation:
     requestResponseComponentNamesFeb2024: false
   auth:
     oAuth2ClientCredentialsEnabled: true
+    oAuth2PasswordEnabled: false
   comments: {}
   telemetryEnabled: false
 typescript:
-  version: 3.2.0
+  version: 3.3.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
     peerDependencies: {}
   additionalPackageJSON: {}
   author: Formance
   clientServerStatusCodesAsErrors: false
+  defaultErrorName: SDKError
   enumFormat: enum
   flattenGlobalSecurity: true
   flatteningOrder: body-first

jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@formance/formance-sdk",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "exports": {
     ".": "./src/index.ts",    
     "./sdk/models/errors": "./src/sdk/models/errors/index.ts",    

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@formance/formance-sdk",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "author": "Formance",
   "main": "./index.js",
   "sideEffects": false,

package.json

@@ -63,12 +63,20 @@ export async function authV1CreateClient(
   });
 
   const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
   const context = {
     operationID: "createClient",
     oAuth2Scopes: ["auth:read", "auth:write"],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
   };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
@@ -86,9 +94,8 @@ export async function authV1CreateClient(
   const doResult = await client._do(req, {
     context,
     errorCodes: ["default"],
-    retryConfig: options?.retries
-      || client._options.retryConfig,
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
     return doResult;

src/funcs/authV1CreateClient.ts

@@ -68,12 +68,20 @@ export async function authV1CreateSecret(
   });
 
   const securityInput = await extractSecurity(client._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
   const context = {
     operationID: "createSecret",
     oAuth2Scopes: ["auth:read", "auth:write"],
+
+    resolvedSecurity: requestSecurity,
+
     securitySource: client._options.security,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
   };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
@@ -91,9 +99,8 @@ export async function authV1CreateSecret(
   const doResult = await client._do(req, {
     context,
     errorCodes: ["default"],
-    retryConfig: options?.retries
-      || client._options.retryConfig,
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
   });
   if (!doResult.ok) {
     return doResult;