@moovio/sdk 0.11.5 → 0.12.1

package/docs/sdks/transfers/README.md

@@ -87,6 +87,7 @@ you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -95,50 +96,26 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.create({
-    xIdempotencyKey: "080a8e77-4c2b-4ecc-9376-91775e024985",
-    accountID: "7a621cf0-21cd-49cf-8540-3315211a509a",
+    xIdempotencyKey: "d6903402-776f-48d6-8fba-0358959d34e5",
+    accountID: "ea9f2225-403b-4e2c-93b0-0eda090ffa65",
     createTransfer: {
       source: {
         paymentMethodID: "9506dbf6-4208-44c3-ad8a-e4431660e1f2",
-        cardDetails: {
-          dynamicDescriptor: "WhlBdy *Yoga 11-12",
-        },
-        achDetails: {
-          companyEntryDescription: "Gym dues",
-          originatingCompanyName: "Whole Body Fit",
-          debitHoldPeriod: "2-days",
-        },
       },
       destination: {
         paymentMethodID: "3f9969cf-a1f3-4d83-8ddc-229a506651cf",
-        cardDetails: {
-          dynamicDescriptor: "WhlBdy *Yoga 11-12",
-        },
-        achDetails: {
-          companyEntryDescription: "Gym dues",
-          originatingCompanyName: "Whole Body Fit",
-        },
       },
       amount: {
         currency: "USD",
-        value: 1204,
+        value: 32945,
       },
-      facilitatorFee: {
-        totalDecimal: "12.987654321",
-        markupDecimal: "0.987654321",
-      },
-      description: "Pay Instructor for May 15 Class",
+      description: "Transfer from card to wallet",
       metadata: {
         "optional": "metadata",
       },
-      salesTaxAmount: {
-        currency: "USD",
-        value: 1204,
-      },
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -156,6 +133,7 @@ import { transfersCreate } from "@moovio/sdk/funcs/transfersCreate.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: "",
@@ -164,57 +142,31 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersCreate(moov, {
-    xIdempotencyKey: "080a8e77-4c2b-4ecc-9376-91775e024985",
-    accountID: "7a621cf0-21cd-49cf-8540-3315211a509a",
+    xIdempotencyKey: "d6903402-776f-48d6-8fba-0358959d34e5",
+    accountID: "ea9f2225-403b-4e2c-93b0-0eda090ffa65",
     createTransfer: {
       source: {
         paymentMethodID: "9506dbf6-4208-44c3-ad8a-e4431660e1f2",
-        cardDetails: {
-          dynamicDescriptor: "WhlBdy *Yoga 11-12",
-        },
-        achDetails: {
-          companyEntryDescription: "Gym dues",
-          originatingCompanyName: "Whole Body Fit",
-          debitHoldPeriod: "2-days",
-        },
       },
       destination: {
         paymentMethodID: "3f9969cf-a1f3-4d83-8ddc-229a506651cf",
-        cardDetails: {
-          dynamicDescriptor: "WhlBdy *Yoga 11-12",
-        },
-        achDetails: {
-          companyEntryDescription: "Gym dues",
-          originatingCompanyName: "Whole Body Fit",
-        },
       },
       amount: {
         currency: "USD",
-        value: 1204,
-      },
-      facilitatorFee: {
-        totalDecimal: "12.987654321",
-        markupDecimal: "0.987654321",
+        value: 32945,
       },
-      description: "Pay Instructor for May 15 Class",
+      description: "Transfer from card to wallet",
       metadata: {
         "optional": "metadata",
       },
-      salesTaxAmount: {
-        currency: "USD",
-        value: 1204,
-      },
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersCreate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -262,6 +214,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: "",
@@ -272,10 +225,9 @@ async function run() {
   const result = await moov.transfers.list({
     skip: 60,
     count: 20,
-    accountID: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
+    accountID: "0579c895-4d2b-4024-8092-f71b80ab5d00",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -293,6 +245,7 @@ import { transfersList } from "@moovio/sdk/funcs/transfersList.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: "",
@@ -303,17 +256,14 @@ async function run() {
   const res = await transfersList(moov, {
     skip: 60,
     count: 20,
-    accountID: "c8a232aa-0b11-4b8a-b005-71e9e705d0e6",
+    accountID: "0579c895-4d2b-4024-8092-f71b80ab5d00",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersList failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -354,6 +304,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: "",
@@ -362,11 +313,10 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.get({
-    transferID: "b888f774-3e7c-4135-a18c-6b985523c4bc",
-    accountID: "e50f7622-81da-484b-9c66-1c8a99c6b71b",
+    transferID: "960cf5a2-50a3-4914-ad86-d54c022bf5df",
+    accountID: "31113f7b-9f68-44e9-9338-6d8e655c7c96",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -384,6 +334,7 @@ import { transfersGet } from "@moovio/sdk/funcs/transfersGet.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: "",
@@ -392,18 +343,15 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersGet(moov, {
-    transferID: "b888f774-3e7c-4135-a18c-6b985523c4bc",
-    accountID: "e50f7622-81da-484b-9c66-1c8a99c6b71b",
+    transferID: "960cf5a2-50a3-4914-ad86-d54c022bf5df",
+    accountID: "31113f7b-9f68-44e9-9338-6d8e655c7c96",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersGet failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -443,6 +391,7 @@ you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -451,8 +400,8 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.update({
-    transferID: "d95fa7f0-e743-42ce-b47c-b60cc78135dd",
-    accountID: "b85898c1-25a1-4907-a1c5-562af6646dad",
+    transferID: "de30c075-4245-4d62-bfb3-f76d4d7d3b9c",
+    accountID: "18a7907d-2f89-493a-b15a-3aad91c24496",
     patchTransfer: {
       metadata: {
         "optional": "metadata",
@@ -460,7 +409,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -478,6 +426,7 @@ import { transfersUpdate } from "@moovio/sdk/funcs/transfersUpdate.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: "",
@@ -486,23 +435,20 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersUpdate(moov, {
-    transferID: "d95fa7f0-e743-42ce-b47c-b60cc78135dd",
-    accountID: "b85898c1-25a1-4907-a1c5-562af6646dad",
+    transferID: "de30c075-4245-4d62-bfb3-f76d4d7d3b9c",
+    accountID: "18a7907d-2f89-493a-b15a-3aad91c24496",
     patchTransfer: {
       metadata: {
         "optional": "metadata",
       },
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersUpdate failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -540,6 +486,7 @@ run();
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -548,11 +495,10 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.createCancellation({
-    accountID: "12dbe811-b86d-497b-ae0f-fb7cfda35251",
-    transferID: "6bb9450c-10a9-4c8d-a8d2-d3fa18648706",
+    accountID: "10ae862c-6658-4f87-967d-46e995737204",
+    transferID: "36c80a6c-ceb2-4e5d-a437-8a39afdfdc58",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -570,6 +516,7 @@ import { transfersCreateCancellation } from "@moovio/sdk/funcs/transfersCreateCa
 // 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: "",
@@ -578,18 +525,15 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersCreateCancellation(moov, {
-    accountID: "12dbe811-b86d-497b-ae0f-fb7cfda35251",
-    transferID: "6bb9450c-10a9-4c8d-a8d2-d3fa18648706",
+    accountID: "10ae862c-6658-4f87-967d-46e995737204",
+    transferID: "36c80a6c-ceb2-4e5d-a437-8a39afdfdc58",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersCreateCancellation failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -628,6 +572,7 @@ run();
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -636,12 +581,11 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.getCancellation({
-    accountID: "fe098575-0376-4404-9a9c-6fe55e3766af",
-    transferID: "b3b49c6a-9b74-4a85-9d49-864ada05cbf2",
-    cancellationID: "5848c1db-18ac-41eb-b107-b6499987902c",
+    accountID: "55cb62c2-22e4-4a36-bd53-3b9adc77ee81",
+    transferID: "bc13b680-bac3-432e-bf44-e9aa6426cbb2",
+    cancellationID: "770cb4b5-d5b0-4e8b-995b-86b790296ba5",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -659,6 +603,7 @@ import { transfersGetCancellation } from "@moovio/sdk/funcs/transfersGetCancella
 // 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: "",
@@ -667,19 +612,16 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersGetCancellation(moov, {
-    accountID: "fe098575-0376-4404-9a9c-6fe55e3766af",
-    transferID: "b3b49c6a-9b74-4a85-9d49-864ada05cbf2",
-    cancellationID: "5848c1db-18ac-41eb-b107-b6499987902c",
+    accountID: "55cb62c2-22e4-4a36-bd53-3b9adc77ee81",
+    transferID: "bc13b680-bac3-432e-bf44-e9aa6426cbb2",
+    cancellationID: "770cb4b5-d5b0-4e8b-995b-86b790296ba5",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersGetCancellation failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -720,6 +662,7 @@ you'll need to specify the `/accounts/{accountID}/transfers.write` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -728,15 +671,14 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.initiateRefund({
-    xIdempotencyKey: "bdfa6a76-31f8-4cdf-a007-3d8aac713b91",
-    accountID: "9b1350b2-a5be-41e3-92be-61f5cf4372a8",
-    transferID: "7390ad29-1a0d-4a0c-8c17-da1708ee9ac2",
+    xIdempotencyKey: "8d9af6b8-67e1-4efa-8188-68039f34097d",
+    accountID: "cb6ae9f9-afab-4f06-9eb0-8abf54a3ada2",
+    transferID: "04022119-95be-4ef4-9dd4-b3782f6aa7b9",
     createRefund: {
       amount: 1000,
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -754,6 +696,7 @@ import { transfersInitiateRefund } from "@moovio/sdk/funcs/transfersInitiateRefu
 // 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: "",
@@ -762,22 +705,19 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersInitiateRefund(moov, {
-    xIdempotencyKey: "bdfa6a76-31f8-4cdf-a007-3d8aac713b91",
-    accountID: "9b1350b2-a5be-41e3-92be-61f5cf4372a8",
-    transferID: "7390ad29-1a0d-4a0c-8c17-da1708ee9ac2",
+    xIdempotencyKey: "8d9af6b8-67e1-4efa-8188-68039f34097d",
+    accountID: "cb6ae9f9-afab-4f06-9eb0-8abf54a3ada2",
+    transferID: "04022119-95be-4ef4-9dd4-b3782f6aa7b9",
     createRefund: {
       amount: 1000,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersInitiateRefund failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -818,6 +758,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: "",
@@ -826,11 +767,10 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.listRefunds({
-    accountID: "7d74a845-fe17-4ebe-a05e-71847ef8c510",
-    transferID: "d081988f-448f-492c-8c60-836126fa0dfb",
+    accountID: "03f5baaa-f5d8-44bd-90db-868745fe66e8",
+    transferID: "6b1aa1a1-bff1-43b9-9126-2806fdc9c732",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -848,6 +788,7 @@ import { transfersListRefunds } from "@moovio/sdk/funcs/transfersListRefunds.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: "",
@@ -856,18 +797,15 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersListRefunds(moov, {
-    accountID: "7d74a845-fe17-4ebe-a05e-71847ef8c510",
-    transferID: "d081988f-448f-492c-8c60-836126fa0dfb",
+    accountID: "03f5baaa-f5d8-44bd-90db-868745fe66e8",
+    transferID: "6b1aa1a1-bff1-43b9-9126-2806fdc9c732",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersListRefunds failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -905,6 +843,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: "",
@@ -913,12 +852,11 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.getRefund({
-    transferID: "dbc09cb2-ef99-4553-8501-94323f377dbf",
-    accountID: "7f90bf73-6fb7-41e7-90aa-a9133e7d92c2",
-    refundID: "0f86fa43-1a9b-4a5d-8227-f253063f7fb1",
+    transferID: "e90d3386-c5b2-4e2b-b841-efc590eba6c0",
+    accountID: "bbb69538-edaa-4a0b-b107-f46f2da89864",
+    refundID: "8e12687e-a4e8-46c9-9e11-a57bbd781e44",
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -936,6 +874,7 @@ import { transfersGetRefund } from "@moovio/sdk/funcs/transfersGetRefund.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: "",
@@ -944,19 +883,16 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersGetRefund(moov, {
-    transferID: "dbc09cb2-ef99-4553-8501-94323f377dbf",
-    accountID: "7f90bf73-6fb7-41e7-90aa-a9133e7d92c2",
-    refundID: "0f86fa43-1a9b-4a5d-8227-f253063f7fb1",
+    transferID: "e90d3386-c5b2-4e2b-b841-efc590eba6c0",
+    accountID: "bbb69538-edaa-4a0b-b107-f46f2da89864",
+    refundID: "8e12687e-a4e8-46c9-9e11-a57bbd781e44",
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersGetRefund failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -996,6 +932,7 @@ to specify the `/accounts/{accountID}/transfers.write` scope.
 import { Moov } from "@moovio/sdk";
 
 const moov = new Moov({
+  xMoovVersion: "v2024.01.00",
   security: {
     username: "",
     password: "",
@@ -1004,15 +941,14 @@ const moov = new Moov({
 
 async function run() {
   const result = await moov.transfers.createReversal({
-    xIdempotencyKey: "9d4b2ed0-777b-40e6-ba88-d6ca730c3503",
-    accountID: "16452b89-d33c-4be9-8f92-205130a46467",
-    transferID: "c7f1b114-0545-47ba-9d79-fdba229c3df7",
+    xIdempotencyKey: "b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8",
+    accountID: "f225b49d-911b-440b-baed-6065968b69cb",
+    transferID: "a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad",
     createReversal: {
       amount: 1000,
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -1030,6 +966,7 @@ import { transfersCreateReversal } from "@moovio/sdk/funcs/transfersCreateRevers
 // 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: "",
@@ -1038,22 +975,19 @@ const moov = new MoovCore({
 
 async function run() {
   const res = await transfersCreateReversal(moov, {
-    xIdempotencyKey: "9d4b2ed0-777b-40e6-ba88-d6ca730c3503",
-    accountID: "16452b89-d33c-4be9-8f92-205130a46467",
-    transferID: "c7f1b114-0545-47ba-9d79-fdba229c3df7",
+    xIdempotencyKey: "b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8",
+    accountID: "f225b49d-911b-440b-baed-6065968b69cb",
+    transferID: "a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad",
     createReversal: {
       amount: 1000,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersCreateReversal failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();
@@ -1096,6 +1030,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: "",
@@ -1112,7 +1047,6 @@ async function run() {
     },
   });
 
-  // Handle the result
   console.log(result);
 }
 
@@ -1130,6 +1064,7 @@ import { transfersGenerateOptions } from "@moovio/sdk/funcs/transfersGenerateOpt
 // 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: "",
@@ -1145,15 +1080,12 @@ async function run() {
       value: 1204,
     },
   });
-
-  if (!res.ok) {
-    throw res.error;
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("transfersGenerateOptions failed:", res.error);
   }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
 }
 
 run();