@oatfi/oatfi-sdk-ts 0.4.0 → 0.6.1

package/docs/sdks/authentications/README.md

@@ -5,8 +5,82 @@
 
 ### Available Operations
 
+* [token](#token) - Login with API Key
 * [login](#login) - Login with email and password (Admin users only)
 
+## token
+
+Login with API Key
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="AuthController_login" method="post" path="/api/v3/auth/token" -->
+```typescript
+import { OatFiSDK } from "@oatfi/oatfi-sdk-ts";
+
+const oatFiSDK = new OatFiSDK({
+  bearer: process.env["OATFISDK_BEARER"] ?? "",
+});
+
+async function run() {
+  const result = await oatFiSDK.authentications.token({
+    apiKey: "api-key-123",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { OatFiSDKCore } from "@oatfi/oatfi-sdk-ts/core.js";
+import { authenticationsToken } from "@oatfi/oatfi-sdk-ts/funcs/authenticationsToken.js";
+
+// Use `OatFiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const oatFiSDK = new OatFiSDKCore({
+  bearer: process.env["OATFISDK_BEARER"] ?? "",
+});
+
+async function run() {
+  const res = await authenticationsToken(oatFiSDK, {
+    apiKey: "api-key-123",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("authenticationsToken failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [models.LoginDto](../../models/logindto.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\<[models.AuthResponseDto](../../models/authresponsedto.md)\>**
+
+### Errors
+
+| Error Type                  | Status Code                 | Content Type                |
+| --------------------------- | --------------------------- | --------------------------- |
+| errors.OatFiSDKDefaultError | 4XX, 5XX                    | \*/\*                       |
+
 ## login
 
 Login with email and password (Admin users only)

package/docs/sdks/businesses/README.md

@@ -258,7 +258,9 @@ const oatFiSDK = new OatFiSDK({
 async function run() {
   const result = await oatFiSDK.businesses.list();
 
-  console.log(result);
+  for await (const page of result) {
+    console.log(page);
+  }
 }
 
 run();
@@ -282,7 +284,9 @@ async function run() {
   const res = await businessesList(oatFiSDK);
   if (res.ok) {
     const { value: result } = res;
-    console.log(result);
+    for await (const page of result) {
+    console.log(page);
+  }
   } else {
     console.log("businessesList failed:", res.error);
   }
@@ -302,7 +306,7 @@ run();
 
 ### Response
 
-**Promise\<[models.ListResponseDto](../../models/listresponsedto.md)\>**
+**Promise\<[operations.BusinessesControllerFindAllResponse](../../models/operations/businessescontrollerfindallresponse.md)\>**
 
 ### Errors
 

package/examples/package-lock.json

@@ -18,8 +18,9 @@
     },
     "..": {
       "name": "@oatfi/oatfi-sdk-ts",
-      "version": "0.4.0",
+      "version": "0.6.1",
       "dependencies": {
+        "jsonpath-rfc9535": "1.1.0",
         "zod": "^3.25.0 || ^4.0.0"
       },
       "devDependencies": {

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "@oatfi/oatfi-sdk-ts",
-  "version": "0.4.0",
+  "version": "0.6.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oatfi/oatfi-sdk-ts",
-  "version": "0.4.0",
+  "version": "0.6.1",
   "author": "Speakeasy",
   "publishConfig": {
     "access": "restricted"
@@ -37,6 +37,7 @@
     "typescript-eslint": "^8.26.0"
   },
   "dependencies": {
+    "jsonpath-rfc9535": "1.1.0",
     "zod": "^3.25.0 || ^4.0.0"
   },
   "exports": {

package/src/funcs/applicationFilesDelete.ts

@@ -120,8 +120,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationFilesDownload.ts

@@ -119,8 +119,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationFilesGet.ts

@@ -120,8 +120,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationFilesList.ts

@@ -123,8 +123,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsCreate.ts

@@ -115,8 +115,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsFilesUpdate.ts

@@ -121,8 +121,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsFilesUpload.ts

@@ -162,8 +162,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsGet.ts

@@ -114,8 +114,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsGetTransactionsReportUrl.ts

@@ -119,8 +119,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsList.ts

@@ -116,8 +116,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsSubmit.ts

@@ -118,8 +118,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsTestApproveEvent.ts

@@ -120,8 +120,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/applicationsUpdate.ts

@@ -117,8 +117,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/authForgotPassword.ts

@@ -105,8 +105,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/authenticationChangePassword.ts

@@ -105,8 +105,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/authenticationGetProfile.ts

@@ -87,8 +87,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/authenticationRefreshToken.ts

@@ -104,8 +104,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/authenticationResetPassword.ts

@@ -105,8 +105,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/authenticationsLogin.ts

@@ -104,8 +104,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/{authenticationLogin.ts → authenticationsToken.ts}

@@ -27,7 +27,7 @@ import { Result } from "../types/fp.js";
 /**
  * Login with API Key
  */
-export function authenticationLogin(
+export function authenticationsToken(
   client: OatFiSDKCore,
   request: models.LoginDto,
   options?: RequestOptions,
@@ -104,8 +104,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/businessFilesDelete.ts

@@ -120,8 +120,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/businessFilesDownload.ts

@@ -119,8 +119,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/businessFilesGet.ts

@@ -120,8 +120,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {

package/src/funcs/businessFilesList.ts

@@ -121,8 +121,18 @@ async function $do(
     securitySource: client._options.bearer,
     retryConfig: options?.retries
       || client._options.retryConfig
+      || {
+        strategy: "backoff",
+        backoff: {
+          initialInterval: 500,
+          maxInterval: 60000,
+          exponent: 1.5,
+          maxElapsedTime: 120000,
+        },
+        retryConnectionErrors: true,
+      }
       || { strategy: "none" },
-    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+    retryCodes: options?.retryCodes || ["5XX"],
   };
 
   const requestRes = client._createRequest(context, {