@moovio/sdk 0.12.0 → 0.12.1

package/docs/sdks/feeplans/README.md

@@ -48,6 +48,7 @@ you'll need to specify the `/accounts/{accountID}/profile.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -61,7 +62,6 @@ async function run() {
     accountID: "93c43634-5477-42a7-972d-01fa76a09e17",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -79,6 +79,7 @@ import { feePlansListFeePlanAgreements } from "@moovio/sdk/funcs/feePlansListFee
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -91,15 +92,12 @@ async function run() {
     count: 20,
     accountID: "93c43634-5477-42a7-972d-01fa76a09e17",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansListFeePlanAgreements failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -137,6 +135,7 @@ you'll need to specify the `/accounts/{accountID}/profile.write` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -151,7 +150,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -169,6 +167,7 @@ import { feePlansCreateFeePlanAgreements } from "@moovio/sdk/funcs/feePlansCreat
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -182,15 +181,12 @@ async function run() {
       planID: "19801f96-ea27-4610-b4d1-8c6b46f37928",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansCreateFeePlanAgreements failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -231,6 +227,7 @@ you'll need to specify the `/accounts/{accountID}/profile.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -242,7 +239,6 @@ async function run() {
     accountID: "b3d59179-f74e-4ee8-b123-33220b3c7d4b",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -260,6 +256,7 @@ import { feePlansListFeePlans } from "@moovio/sdk/funcs/feePlansListFeePlans.js"
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -270,15 +267,12 @@ async function run() {
   const res = await feePlansListFeePlans(moov, {
     accountID: "b3d59179-f74e-4ee8-b123-33220b3c7d4b",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansListFeePlans failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -316,6 +310,7 @@ you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -329,7 +324,6 @@ async function run() {
     count: 20,
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -347,6 +341,7 @@ import { feePlansRetrieveFees } from "@moovio/sdk/funcs/feePlansRetrieveFees.js"
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -359,15 +354,12 @@ async function run() {
     skip: 60,
     count: 20,
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansRetrieveFees failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -405,6 +397,7 @@ you'll need to specify the `/accounts/{accountID}/transfers.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -416,7 +409,6 @@ async function run() {
     accountID: "55c34e26-269d-4872-8e42-0fa83e3f4b10",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -434,6 +426,7 @@ import { feePlansListFeesFetch } from "@moovio/sdk/funcs/feePlansListFeesFetch.j
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -444,15 +437,12 @@ async function run() {
   const res = await feePlansListFeesFetch(moov, {
     accountID: "55c34e26-269d-4872-8e42-0fa83e3f4b10",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansListFeesFetch failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -490,6 +480,7 @@ you'll need to specify the `/accounts/{accountID}/profile.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -501,7 +492,6 @@ async function run() {
     accountID: "600637f9-c38a-473f-b909-0d5ac537b8a5",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -519,6 +509,7 @@ import { feePlansListPartnerPricing } from "@moovio/sdk/funcs/feePlansListPartne
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -529,15 +520,12 @@ async function run() {
   const res = await feePlansListPartnerPricing(moov, {
     accountID: "600637f9-c38a-473f-b909-0d5ac537b8a5",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansListPartnerPricing failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -575,6 +563,7 @@ you'll need to specify the `/accounts/{accountID}/profile.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -588,7 +577,6 @@ async function run() {
     accountID: "123bfe5e-2288-4146-9d8a-4c07264c3758",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -606,6 +594,7 @@ import { feePlansListPartnerPricingAgreements } from "@moovio/sdk/funcs/feePlans
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -618,15 +607,12 @@ async function run() {
     count: 20,
     accountID: "123bfe5e-2288-4146-9d8a-4c07264c3758",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("feePlansListPartnerPricingAgreements failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/files/README.md

@@ -38,6 +38,7 @@ import { Moov } from "@moovio/sdk";
 import { openAsBlob } from "node:fs";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -54,7 +55,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -73,6 +73,7 @@ import { openAsBlob } from "node:fs";
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -88,15 +89,12 @@ async function run() {
       metadata: "{\"requirement_id\": \"document.individual.verification\"}",
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesUpload failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -136,6 +134,7 @@ you'll need to specify the `/accounts/{accountID}/files.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -147,7 +146,6 @@ async function run() {
     accountID: "d1133bf2-4853-4436-9a03-23739895ab98",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -165,6 +163,7 @@ import { filesList } from "@moovio/sdk/funcs/filesList.js";
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -175,15 +174,12 @@ async function run() {
   const res = await filesList(moov, {
     accountID: "d1133bf2-4853-4436-9a03-23739895ab98",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -221,6 +217,7 @@ you'll need to specify the `/accounts/{accountID}/files.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -233,7 +230,6 @@ async function run() {
     fileID: "af170db9-0d17-4a9f-ade6-5dd2f1b3412d",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -251,6 +247,7 @@ import { filesGet } from "@moovio/sdk/funcs/filesGet.js";
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -262,15 +259,12 @@ async function run() {
     accountID: "7f888113-d35a-4536-b9bc-c55076736ab6",
     fileID: "af170db9-0d17-4a9f-ade6-5dd2f1b3412d",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("filesGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/industries/README.md

@@ -23,6 +23,7 @@ you'll need to specify the `/profile-enrichment.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -32,7 +33,6 @@ const moov = new Moov({
 async function run() {
   const result = await moov.industries.list({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,6 +50,7 @@ import { industriesList } from "@moovio/sdk/funcs/industriesList.js";
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -58,15 +59,12 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await industriesList(moov, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("industriesList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();

package/docs/sdks/institutions/README.md

@@ -5,11 +5,102 @@
 
 ### Available Operations
 
+* [searchInstitutions](#searchinstitutions) - Search for financial institutions by name or routing number.
+
+This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).
+
+This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+you'll need to specify the `/institutions.read` scope.
 * [search](#search) - Search for institutions by either their name or routing number.
 
 To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) 
 you'll need to specify the `/fed.read` scope.
 
+## searchInstitutions
+
+Search for financial institutions by name or routing number.
+
+This endpoint returns metadata about each matched institution, including basic identifying details (such as name, routing number, and address) and information about which payment services they support (e.g., ACH, RTP, and Wire).
+
+This can be used to validate a financial institution before initiating payment activity, or to check which payment rails are available for a given routing number.
+
+To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/)
+you'll need to specify the `/institutions.read` scope.
+
+### Example Usage
+
+```typescript
+import { Moov } from "@moovio/sdk";
+
+const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
+  security: {
+    username: "",
+    password: "",
+  },
+});
+
+async function run() {
+  const result = await moov.institutions.searchInstitutions({});
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { MoovCore } from "@moovio/sdk/core.js";
+import { institutionsSearchInstitutions } from "@moovio/sdk/funcs/institutionsSearchInstitutions.js";
+
+// Use `MoovCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
+  security: {
+    username: "",
+    password: "",
+  },
+});
+
+async function run() {
+  const res = await institutionsSearchInstitutions(moov, {});
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("institutionsSearchInstitutions failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.SearchInstitutionsRequest](../../models/operations/searchinstitutionsrequest.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.SearchInstitutionsResponse](../../models/operations/searchinstitutionsresponse.md)\>**
+
+### Errors
+
+| Error Type      | Status Code     | Content Type    |
+| --------------- | --------------- | --------------- |
+| errors.APIError | 4XX, 5XX        | \*/\*           |
+
 ## search
 
 Search for institutions by either their name or routing number.
@@ -23,6 +114,7 @@ you'll need to specify the `/fed.read` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -32,7 +124,6 @@ const moov = new Moov({
 async function run() {
   const result = await moov.institutions.search({});
 
-  // Handle the result
   console.log(result);
 }
 
@@ -50,6 +141,7 @@ import { institutionsSearch } from "@moovio/sdk/funcs/institutionsSearch.js";
 // Use `MoovCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const moov = new MoovCore({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -58,15 +150,12 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await institutionsSearch(moov, {});
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("institutionsSearch failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();