@moovio/node - npm Package Compare versions

Comparing version 1.2.1 to 1.2.2

dist/cjs/moov.js

@@ -42,3 +42,3 @@ "use strict";
     /**
-     * Access to view Moov accounts
+     * List connected accounts -- see also PROFILE_READ
      * @tag Authentication
@@ -96,5 +96,5 @@ */
      */
-    PROFILE_ENRICHMENT_READ: "/accounts/{accountID}/profile-enrichment.read",
+    PROFILE_ENRICHMENT_READ: "/profile-enrichment.read",
     /**
-     * Access to view details associated with a Moov account
+     * Access to view details associated with a Moov account -- see also ACCOUNTS_READ
      * @tag Authentication
@@ -101,0 +101,0 @@ */

dist/cjs/transfers.d.ts

@@ -355,3 +355,6 @@ /**
      * try {
-     *   const { transferID } = moov.transfers.refund("...");
+     *   const { transferID } = moov.transfers.refund(
+     *    "...",
+     *    { amount: 200 } // omit if creating a refund for the full amount
+     *  );
      * } catch (err) {
@@ -361,3 +364,3 @@ *   // ...
      */
-    refund(transferID: string, idempotencyKey?: string | undefined): Promise<TransferResponse>;
+    refund(transferID: string, idempotencyKey?: string | undefined, refund: any): Promise<TransferResponse>;
     /**
@@ -364,0 +367,0 @@ * List refunds for a card transfer.

dist/cjs/transfers.js

@@ -455,3 +455,6 @@ "use strict";
      * try {
-     *   const { transferID } = moov.transfers.refund("...");
+     *   const { transferID } = moov.transfers.refund(
+     *    "...",
+     *    { amount: 200 } // omit if creating a refund for the full amount
+     *  );
      * } catch (err) {
@@ -461,3 +464,3 @@ *   // ...
      */
-    refund(transferID, idempotencyKey) {
+    refund(transferID, idempotencyKey, refund) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -473,2 +476,3 @@ (0, checks_js_1.checkString)(transferID).or(errors_js_1.Err.MISSING_TRANSFER_ID);
                 },
+                json: refund,
             })
@@ -475,0 +479,0 @@ .json();

dist/mjs/moov.js

@@ -30,3 +30,3 @@ import { got } from "got-cjs";
     /**
-     * Access to view Moov accounts
+     * List connected accounts -- see also PROFILE_READ
      * @tag Authentication
@@ -84,5 +84,5 @@ */
      */
-    PROFILE_ENRICHMENT_READ: "/accounts/{accountID}/profile-enrichment.read",
+    PROFILE_ENRICHMENT_READ: "/profile-enrichment.read",
     /**
-     * Access to view details associated with a Moov account
+     * Access to view details associated with a Moov account -- see also ACCOUNTS_READ
      * @tag Authentication
@@ -89,0 +89,0 @@ */

dist/mjs/transfers.d.ts

@@ -355,3 +355,6 @@ /**
      * try {
-     *   const { transferID } = moov.transfers.refund("...");
+     *   const { transferID } = moov.transfers.refund(
+     *    "...",
+     *    { amount: 200 } // omit if creating a refund for the full amount
+     *  );
      * } catch (err) {
@@ -361,3 +364,3 @@ *   // ...
      */
-    refund(transferID: string, idempotencyKey?: string | undefined): Promise<TransferResponse>;
+    refund(transferID: string, idempotencyKey?: string | undefined, refund: any): Promise<TransferResponse>;
     /**
@@ -364,0 +367,0 @@ * List refunds for a card transfer.

dist/mjs/transfers.js

@@ -433,3 +433,6 @@ import { randomUUID } from "crypto";
      * try {
-     *   const { transferID } = moov.transfers.refund("...");
+     *   const { transferID } = moov.transfers.refund(
+     *    "...",
+     *    { amount: 200 } // omit if creating a refund for the full amount
+     *  );
      * } catch (err) {
@@ -439,3 +442,3 @@ *   // ...
      */
-    async refund(transferID, idempotencyKey) {
+    async refund(transferID, idempotencyKey, refund) {
         checkString(transferID).or(Err.MISSING_TRANSFER_ID);
@@ -450,2 +453,3 @@ idempotencyKey = idempotencyKey || randomUUID();
             },
+            json: refund,
         })
@@ -452,0 +456,0 @@ .json();

lib/accounts.js

@@ -207,3 +207,3 @@ import { check, checkString } from "./helpers/checks.js";
 /**
- * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser.  See https://docs.moov.io/moovjs/ for more details.
+ * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See https://docs.moov.io/moovjs/ for more details.
  * @typedef TermsOfServiceToken
@@ -210,0 +210,0 @@ * @property {string} token - An encrypted value used to record acceptance of Moov's Terms of Service

lib/capabilities.js

@@ -364,3 +364,3 @@ import { check, checkString } from "./helpers/checks.js";
    *
-   * @param {string} accountID - Account on which to request capabilites
+   * @param {string} accountID - Account on which to request capabilities
    * @param {CAPABILITIES[]} capabilities - One or more capability to request
@@ -389,3 +389,3 @@ * @returns {Promise<Capability[]>}
    *
-   * @param {string} accountID - Account on which to request capabilites
+   * @param {string} accountID - Account on which to request capabilities
    * @param {CAPABILITIES} capability - Capability to retrieve
@@ -413,3 +413,3 @@ * @returns {Promise<Capability>}
    *
-   * @param {string} accountID - Account on which to request capabilites
+   * @param {string} accountID - Account on which to request capabilities
    * @returns {Promise<Capability[]>}
@@ -435,3 +435,3 @@ *
    *
-   * @param {string} accountID - Account on which to request capabilites
+   * @param {string} accountID - Account on which to request capabilities
    * @param {CAPABILITIES} capability - Capability to retrieve
@@ -438,0 +438,0 @@ * @returns {Promise<void>}

lib/enrichedAddress.js

@@ -22,7 +22,7 @@ import { check, checkString } from "./helpers/checks.js";
  * @property {string} [includeStates] - Optional Limits results to a list of given states. Example: "illinois;hawaii;oregon"
- * @property {string} [includeZipcodes] - Optional Limits results to a list of given zipcodes. Example: "60412;96818;97209"
- * @property {string} [excludeStates] - Optional Exclude list of states from results. No include pararmeters may be used with this parameter. Example: "AZ;WA;SC"
+ * @property {string} [includeZipcodes] - Optional Limits results to a list of given ZIP codes. Example: "60412;96818;97209"
+ * @property {string} [excludeStates] - Optional Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC"
  * @property {string} [preferCities] - Optional Display results with the listed cities at the top. Example: "denver;aurora;omaha"
  * @property {string} [preferStates] - Optional Display results with the listed states at the top. Example: "CO;MN;WI"
- * @property {string} [preferZipcodes] - Optional Display results with the listed zipcodes at the top. Example: "60412;96818;97209"
+ * @property {string} [preferZipcodes] - Optional Display results with the listed ZIP codes at the top. Example: "60412;96818;97209"
  * @property {number} [preferRatio] - Optional Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.
@@ -29,0 +29,0 @@ * @property {"none"|"city"} [preferGeolocation] - Optional If omitted or set to city it uses the sender's IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. Example: "city"

lib/moov.js

@@ -38,3 +38,3 @@ import { got } from "got-cjs";
   /**
-   * Access to view Moov accounts
+   * List connected accounts -- see also PROFILE_READ
    * @tag Authentication
@@ -92,5 +92,5 @@ */
    */
-  PROFILE_ENRICHMENT_READ: "/accounts/{accountID}/profile-enrichment.read",
+  PROFILE_ENRICHMENT_READ: "/profile-enrichment.read",
   /**
-   * Access to view details associated with a Moov account
+   * Access to view details associated with a Moov account -- see also ACCOUNTS_READ
    * @tag Authentication
@@ -248,3 +248,3 @@ */
    * @param {SCOPES[]} scopes - One or more permissions to request
-   * @param {string} [accountID] - Account on which to request permissions, default is faciliator account ID
+   * @param {string} [accountID] - Account on which to request permissions, default is facilitator account ID
    * @returns {Promise<Token>}
@@ -251,0 +251,0 @@ * @tag Authentication

lib/transfers.js

@@ -475,3 +475,6 @@ import { randomUUID } from "crypto";
    * try {
-   *   const { transferID } = moov.transfers.refund("...");
+   *   const { transferID } = moov.transfers.refund(
+   *    "...",
+   *    { amount: 200 } // omit if creating a refund for the full amount
+   *  );
    * } catch (err) {
@@ -481,3 +484,3 @@ *   // ...
    */
-  async refund(transferID, idempotencyKey) {
+  async refund(transferID, idempotencyKey, refund) {
     checkString(transferID).or(Err.MISSING_TRANSFER_ID);
@@ -494,2 +497,3 @@
         },
+        json: refund,
       })
@@ -496,0 +500,0 @@ .json();

lib/types/accounts.d.ts

@@ -200,3 +200,3 @@ /** @external Promise */
 /**
- * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser.  See https://docs.moov.io/moovjs/ for more details.
+ * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See https://docs.moov.io/moovjs/ for more details.
  * @typedef TermsOfServiceToken
@@ -477,3 +477,3 @@ * @property {string} token - An encrypted value used to record acceptance of Moov's Terms of Service
 /**
- * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser.  See https://docs.moov.io/moovjs/ for more details.
+ * A token that can then be used to accept Moov's Terms of Service. Must be generated from a web browser. See https://docs.moov.io/moovjs/ for more details.
  */
@@ -480,0 +480,0 @@ export type TermsOfServiceToken = {

lib/types/address.d.ts

@@ -1,2 +0,2 @@
-export const unused: {};
+export var unused: {};
 export type Address = {
@@ -3,0 +3,0 @@ addressLine1: string;

lib/types/capabilities.d.ts

@@ -166,3 +166,3 @@ /**
      *
-     * @param {string} accountID - Account on which to request capabilites
+     * @param {string} accountID - Account on which to request capabilities
      * @param {CAPABILITIES[]} capabilities - One or more capability to request
@@ -177,3 +177,3 @@ * @returns {Promise<Capability[]>}
      *
-     * @param {string} accountID - Account on which to request capabilites
+     * @param {string} accountID - Account on which to request capabilities
      * @param {CAPABILITIES} capability - Capability to retrieve
@@ -188,3 +188,3 @@ * @returns {Promise<Capability>}
      *
-     * @param {string} accountID - Account on which to request capabilites
+     * @param {string} accountID - Account on which to request capabilities
      * @returns {Promise<Capability[]>}
@@ -198,3 +198,3 @@ *
      *
-     * @param {string} accountID - Account on which to request capabilites
+     * @param {string} accountID - Account on which to request capabilities
      * @param {CAPABILITIES} capability - Capability to retrieve
@@ -201,0 +201,0 @@ * @returns {Promise<void>}

lib/types/cardDetails.d.ts

@@ -1,2 +0,2 @@
-export const unused: {};
+export var unused: {};
 export type CardDetails = {
@@ -3,0 +3,0 @@ /**

lib/types/enrichedAddress.d.ts

@@ -18,7 +18,7 @@ /**
  * @property {string} [includeStates] - Optional Limits results to a list of given states. Example: "illinois;hawaii;oregon"
- * @property {string} [includeZipcodes] - Optional Limits results to a list of given zipcodes. Example: "60412;96818;97209"
- * @property {string} [excludeStates] - Optional Exclude list of states from results. No include pararmeters may be used with this parameter. Example: "AZ;WA;SC"
+ * @property {string} [includeZipcodes] - Optional Limits results to a list of given ZIP codes. Example: "60412;96818;97209"
+ * @property {string} [excludeStates] - Optional Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC"
  * @property {string} [preferCities] - Optional Display results with the listed cities at the top. Example: "denver;aurora;omaha"
  * @property {string} [preferStates] - Optional Display results with the listed states at the top. Example: "CO;MN;WI"
- * @property {string} [preferZipcodes] - Optional Display results with the listed zipcodes at the top. Example: "60412;96818;97209"
+ * @property {string} [preferZipcodes] - Optional Display results with the listed ZIP codes at the top. Example: "60412;96818;97209"
  * @property {number} [preferRatio] - Optional Specifies the percentage of address suggestions that should be preferred and will appear at the top of the results.
@@ -89,7 +89,7 @@ * @property {"none"|"city"} [preferGeolocation] - Optional If omitted or set to city it uses the sender's IP address to determine location, then automatically adds the city and state to the preferCities value. This parameter takes precedence over other include or exclude parameters meaning that if it is not set to none you may see addresses from areas you do not wish to see. Example: "city"
     /**
-     * - Optional Limits results to a list of given zipcodes. Example: "60412;96818;97209"
+     * - Optional Limits results to a list of given ZIP codes. Example: "60412;96818;97209"
      */
     includeZipcodes?: string;
     /**
-     * - Optional Exclude list of states from results. No include pararmeters may be used with this parameter. Example: "AZ;WA;SC"
+     * - Optional Exclude list of states from results. No include parameters may be used with this parameter. Example: "AZ;WA;SC"
      */
@@ -106,3 +106,3 @@ excludeStates?: string;
     /**
-     * - Optional Display results with the listed zipcodes at the top. Example: "60412;96818;97209"
+     * - Optional Display results with the listed ZIP codes at the top. Example: "60412;96818;97209"
      */
@@ -109,0 +109,0 @@ preferZipcodes?: string;

lib/types/moov.d.ts

@@ -91,3 +91,3 @@ /**
      * @param {SCOPES[]} scopes - One or more permissions to request
-     * @param {string} [accountID] - Account on which to request permissions, default is faciliator account ID
+     * @param {string} [accountID] - Account on which to request permissions, default is facilitator account ID
      * @returns {Promise<Token>}
@@ -94,0 +94,0 @@ * @tag Authentication

package.json

 {
     "name": "@moovio/node",
-    "version": "1.2.1",
+    "version": "1.2.2",
     "description": "Node SDK for the Moov API and Dashboard",
@@ -52,3 +52,3 @@ "module": "dist/mjs/index.js",
         "handlebars-helpers": "^0.9.8",
-        "jsdoc": "^3.6.7",
+        "jsdoc": "^4.0.2",
         "lodash": "^4.17.21",
@@ -55,0 +55,0 @@ "prettier": "^2.5.1",

No alert changes

Improved metrics

Total package byte prevSize

738536

increased by0.09%

Lines of code

22438

increased by0.08%

No dependency changes