rebilly-js-sdk 50.3.0 → 50.3.3

package/CHANGELOG.md

@@ -1,3 +1,31 @@
+## [50.3.3](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v50.3.2...rebilly-js-sdk-v50.3.3) (2023-05-05)
+
+
+### Bug Fixes
+
+* **js-sdk:** use folder name as nx project name ([#219](https://github.com/Rebilly/rebilly/issues/219)) ([089887d](https://github.com/Rebilly/rebilly/commit/089887d6a4fcfe608dbfec298ea633ad0851904f))
+
+## [50.3.2](https://github.com/Rebilly/rebilly/compare/js-sdk-v50.3.1...js-sdk-v50.3.2) (2023-05-05)
+
+
+### Bug Fixes
+
+* **js-sdk:** remove dead link from readme ([#218](https://github.com/Rebilly/rebilly/issues/218)) ([49756bf](https://github.com/Rebilly/rebilly/commit/49756bfaec0eacabe5c1d3d944e5c2cbd962e909))
+
+## [50.3.1](https://github.com/Rebilly/rebilly/compare/js-sdk-v50.3.0...js-sdk-v50.3.1) (2023-05-05)
+
+
+### Bug Fixes
+
+* **rebilly-js-sdk:** add missing parameters to fees and balance transactions, add delete fees ([#212](https://github.com/Rebilly/rebilly/issues/212)) ([e8cbb12](https://github.com/Rebilly/rebilly/commit/e8cbb1223a53ba8bfae70ac9851e9e4b2821b2f2))
+
+## 1.0.0 (2023-05-04)
+
+
+### Features
+
+* Migrate kyc-document-gatherer-vue3 ([#99](https://github.com/Rebilly/rebilly/issues/99)) ([06596dc](https://github.com/Rebilly/rebilly/commit/06596dce43efda66b7945dfcd88b20da617622d4)), closes [#48](https://github.com/Rebilly/rebilly/issues/48) [#45](https://github.com/Rebilly/rebilly/issues/45)
+
 ## [50.3.0](https://github.com/Rebilly/rebilly/compare/js-sdk-v50.2.0...js-sdk-v50.3.0) (2023-04-28)
 
 

package/README.md

@@ -2,7 +2,6 @@
 The Rebilly JS SDK library allows you to consume the Rebilly API using either Node or the browser.
 
 [![npm](https://img.shields.io/npm/v/rebilly-js-sdk.svg)](https://www.npmjs.com/package/rebilly-js-sdk)
-![GitHub release](https://github.com/rebilly/rebilly-js-sdk/actions/workflows/publish.yaml/badge.svg)
 [![Try rebilly-js-sdk on RunKit](https://badge.runkitcdn.com/rebilly-js-sdk.svg)](https://npm.runkit.com/rebilly-js-sdk)
 
 ### PCI Compliance note

package/dist/rebilly-js-sdk.d.ts

@@ -930,6 +930,8 @@ declare module rebilly {
   type PatchFeeRequest = operations['PatchFee']['requestBody']['content']['application/json']
   type PatchFeeResponse = operations['PatchFee']['responses']['200']['content']['application/json']
   type PatchFeeResponsePromise = Promise<{fields: PatchFeeResponse}>
+  type DeleteFeeResponse = operations['DeleteFee']['responses']['204']
+  type DeleteFeeResponsePromise = Promise<{fields: DeleteFeeResponse}>
   
   type GetCashierRequestCollectionRequest = operations['GetCashierRequestCollection']['parameters']["query"] & (operations['GetCashierRequestCollection']['parameters'] extends {path: {}} ? operations['GetCashierRequestCollection']['parameters']["path"] : {})
   
@@ -3723,6 +3725,12 @@ export interface corePaths {
      * > **Important:** This operation is experimental and may not be backward compatible.
      */
     put: operations["PutFee"];
+    /**
+     * Deletes a fee entry.
+     *
+     * > **Important:** This operation is experimental and may not be backward compatible.
+     */
+    delete: operations["DeleteFee"];
     /**
      * Patches a fee entry.
      *
@@ -4835,6 +4843,7 @@ export interface coreComponents {
       | "UPI"
       | "USD-coin"
       | "VCreditos"
+      | "VegaWallet"
       | "VenusPoint"
       | "voucher"
       | "voucher-2"
@@ -5338,13 +5347,15 @@ export interface coreComponents {
       occurredTime?: coreComponents["schemas"]["ServerTimestamp"];
       _links?: coreComponents["schemas"]["SelfLink"];
     };
+    /** ID of the transaction. */
+    TransactionId: string;
     Dispute: {
       /** ID of the dispute. */
       id?: string;
       /** ID of the customer who is disputing a transaction. */
       customerId?: string;
       /** ID of the disputed transaction. */
-      transactionId: string;
+      transactionId: coreComponents["schemas"]["TransactionId"];
       currency: coreComponents["schemas"]["CurrencyCode"];
       /** Dispute amount. */
       amount: number;
@@ -6073,6 +6084,7 @@ export interface coreComponents {
           | "VantivLitle"
           | "vegaaH"
           | "VCreditos"
+          | "VegaWallet"
           | "Wallet88"
           | "Walpay"
           | "WesternUnion"
@@ -6086,8 +6098,7 @@ export interface coreComponents {
       | null;
     /** Transaction information. */
     CommonTransaction: {
-      /** ID of the transaction. */
-      id?: coreComponents["schemas"]["ResourceId"];
+      id?: coreComponents["schemas"]["TransactionId"];
       websiteId?: coreComponents["schemas"]["WebsiteId"];
       customerId?: coreComponents["schemas"]["CustomerId"];
       /** Type of transaction. */
@@ -6136,7 +6147,7 @@ export interface coreComponents {
       requestAmount?: number;
       requestCurrency?: coreComponents["schemas"]["CurrencyCode"];
       /** ID of the parent transaction. */
-      parentTransactionId?: string | null;
+      parentTransactionId?: coreComponents["schemas"]["TransactionId"];
       /** IDs of child transactions. */
       childTransactions?: coreComponents["schemas"]["ResourceId"][];
       /** Related invoice IDs. */
@@ -6385,6 +6396,7 @@ export interface coreComponents {
           | "UPayCard"
           | "Vantiv"
           | "VCreditos"
+          | "VegaWallet"
           | "VoicePay"
           | "Wallet88"
           | "WeChat Pay"
@@ -6531,7 +6543,7 @@ export interface coreComponents {
       /** ID of the gateway account that processed the transaction. */
       gatewayAccountId?: string;
       /** ID of the gateway transaction. */
-      gatewayTransactionId?: coreComponents["schemas"]["ResourceId"];
+      gatewayTransactionId?: coreComponents["schemas"]["TransactionId"];
       /** Related gateway information. */
       gateway?: {
         /** Gateway response. */
@@ -6921,7 +6933,7 @@ export interface coreComponents {
     InvoiceTransactionAllocation: {
       /** Unique resource ID. */
       invoiceId?: string;
-      transactionId?: coreComponents["schemas"]["ResourceId"];
+      transactionId?: coreComponents["schemas"]["TransactionId"];
       amount?: number;
       currency?: coreComponents["schemas"]["CurrencyCode"];
       /** Related links. */
@@ -6934,7 +6946,7 @@ export interface coreComponents {
     };
     InvoiceTransaction: {
       /** ID of the transaction to apply to the invoice. */
-      transactionId: string;
+      transactionId: coreComponents["schemas"]["TransactionId"];
       /**
        * Amount to be applied to the invoice. This value must not exceed the transaction amount.
        * If omitted, the lesser of the unused transaction amount or the invoice due amount is used.
@@ -7001,7 +7013,7 @@ export interface coreComponents {
          */
         transactions?: {
           /** ID of the transaction to which the credit memo is allocated. */
-          transactionId?: coreComponents["schemas"]["ResourceId"];
+          transactionId?: coreComponents["schemas"]["TransactionId"];
           /**
            * Amount of credit that is allocated from the credit memo to the transaction.
            * If the `amount` value is not supplied or exceeds the unused amount of the credit memo or the transaction amount, the lesser of the following two values is used:
@@ -7442,6 +7454,8 @@ export interface coreComponents {
       documentSubtype?: string | null;
       /** Specifies if an identity document has matching face proof. */
       hasMatchingFaceProof?: boolean;
+      /** Specifies if an identity document has been tampered with. */
+      isTampered?: boolean;
       /** Use `expirationDate` field instead. */
       expiryDate?: string | null;
     };
@@ -7485,6 +7499,8 @@ export interface coreComponents {
         nationality?: number;
         /** Weight added if the document is not one of the recognized document subtypes. */
         documentSubtype?: number;
+        /** Weight added if the document has been tampered with. */
+        isTampered?: number;
       };
       /** Pass and fail threshold definition for the document verification process. */
       thresholds?: {
@@ -7568,6 +7584,8 @@ export interface coreComponents {
       phone?: string | null;
       /** Interpreted subtype of the uploaded document. */
       documentSubtype?: string | null;
+      /** Specifies if an address proof document has been tampered with. */
+      isTampered?: boolean;
     };
     /** Address proof settings. */
     KycSettingsAddress: {
@@ -7598,6 +7616,8 @@ export interface coreComponents {
         phone?: number;
         /** Weight added if the document is not one of the recognized document subtypes. */
         documentSubtype?: number;
+        /** Weight added if the document has been tampered with. */
+        isTampered?: number;
       };
       /** Pass and fail threshold definition for the document verification process. */
       thresholds?: {
@@ -9623,7 +9643,7 @@ export interface coreComponents {
     };
     SubscriptionInvoice: {
       /** If present, applies a payment to the invoice created. If the payment is for the invoice total, it would be marked as paid. */
-      transactionId?: coreComponents["schemas"]["ResourceId"];
+      transactionId?: coreComponents["schemas"]["TransactionId"];
     };
     /** Subscription pause details. */
     SubscriptionPause: {
@@ -10287,7 +10307,7 @@ export interface coreComponents {
       payoutRequestId?: string;
     };
     TransactionQuery: {
-      transactionId?: coreComponents["schemas"]["ResourceId"];
+      transactionId?: coreComponents["schemas"]["TransactionId"];
       /** Result of the transaction. */
       result?: "abandoned" | "approved" | "canceled" | "declined" | "unknown";
       /** Status of the transaction. */
@@ -10445,7 +10465,6 @@ export interface coreComponents {
       _links?: coreComponents["schemas"]["SelfLink"];
     };
     Fee: coreComponents["schemas"]["BaseFee"] & { [key: string]: any };
-    FeePatch: coreComponents["schemas"]["BaseFee"];
     /**
      * Custom amount restrictions.
      * If this value is `null`,  custom amounts are prohibited.
@@ -10605,7 +10624,7 @@ export interface coreComponents {
       /** List of credit transactions that are allocated to reduce the available amount of a payout request. */
       allocations?: {
         /** ID of the transaction to which the payout request is allocated. */
-        transactionId?: coreComponents["schemas"]["ResourceId"];
+        transactionId?: coreComponents["schemas"]["TransactionId"];
         /** Result of a transaction. */
         transactionResult?:
           | "abandoned"
@@ -11299,8 +11318,7 @@ export interface coreComponents {
     CustomerRedirect: {
       content: {
         "application/json": {
-          /** ID of the transaction. */
-          transactionId?: string;
+          transactionId?: coreComponents["schemas"]["TransactionId"];
           /** URL customer redirected to. */
           redirectUrl?: string;
           /** Customer's IP address. */
@@ -11402,8 +11420,7 @@ export interface coreComponents {
     TransactionWebhook: {
       content: {
         "application/json": {
-          /** ID of the transaction. */
-          transactionId?: string;
+          transactionId?: coreComponents["schemas"]["TransactionId"];
           /** Type of webhook event. */
           eventType?:
             | "gateway-account-requested"
@@ -11638,8 +11655,7 @@ export interface coreComponents {
     InvoiceAndTransaction: {
       content: {
         "application/json": {
-          /** ID of the transaction. */
-          transactionId?: string;
+          transactionId?: coreComponents["schemas"]["TransactionId"];
           /** ID of the invoice. */
           invoiceId?: string;
           /** Type of webhook event. */
@@ -17842,6 +17858,19 @@ export interface operations {
         limit?: coreComponents["parameters"]["collectionLimit"];
         /** Specifies the starting point within the collection of items to be returned. */
         offset?: coreComponents["parameters"]["collectionOffset"];
+        /**
+         * Filters the collection items. This field requires
+         * a special format. Use `,` for multiple allowed values.  Use `;` for multiple fields.
+         *
+         * For more information, see
+         * [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+         */
+        filter?: coreComponents["parameters"]["collectionFilter"];
+        /**
+         * Sorts and orders the collection of items. To sort in descending
+         * order, prefix with `-`.
+         */
+        sort?: coreComponents["parameters"]["collectionSort"];
       };
     };
     responses: {
@@ -17940,6 +17969,26 @@ export interface operations {
       };
     };
   };
+  /**
+   * Deletes a fee entry.
+   *
+   * > **Important:** This operation is experimental and may not be backward compatible.
+   */
+  DeleteFee: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Fee deleted. */
+      204: never;
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
   /**
    * Patches a fee entry.
    *
@@ -17965,7 +18014,7 @@ export interface operations {
     };
     requestBody: {
       content: {
-        "application/json": coreComponents["schemas"]["FeePatch"];
+        "application/json": coreComponents["schemas"]["BaseFee"];
       };
     };
   };
@@ -20250,6 +20299,7 @@ export interface usersComponents {
       | "UPI"
       | "USD-coin"
       | "VCreditos"
+      | "VegaWallet"
       | "VenusPoint"
       | "voucher"
       | "voucher-2"
@@ -20467,6 +20517,8 @@ export interface usersComponents {
     };
     /** Read-only timestamp in ISO 8601 date-time format. */
     ServerTimestamp: string;
+    /** ID of the transaction. */
+    TransactionId: string;
     /** Application instance object. */
     ApplicationInstance: {
       /** Status of the application instance. */
@@ -20997,6 +21049,7 @@ export interface usersComponents {
           | "VantivLitle"
           | "vegaaH"
           | "VCreditos"
+          | "VegaWallet"
           | "Wallet88"
           | "Walpay"
           | "WesternUnion"
@@ -21010,8 +21063,7 @@ export interface usersComponents {
       | null;
     /** Transaction information. */
     CommonTransaction: {
-      /** ID of the transaction. */
-      id?: usersComponents["schemas"]["ResourceId"];
+      id?: usersComponents["schemas"]["TransactionId"];
       websiteId?: usersComponents["schemas"]["WebsiteId"];
       customerId?: usersComponents["schemas"]["CustomerId"];
       /** Type of transaction. */
@@ -21060,7 +21112,7 @@ export interface usersComponents {
       requestAmount?: number;
       requestCurrency?: usersComponents["schemas"]["CurrencyCode"];
       /** ID of the parent transaction. */
-      parentTransactionId?: string | null;
+      parentTransactionId?: usersComponents["schemas"]["TransactionId"];
       /** IDs of child transactions. */
       childTransactions?: usersComponents["schemas"]["ResourceId"][];
       /** Related invoice IDs. */
@@ -21309,6 +21361,7 @@ export interface usersComponents {
           | "UPayCard"
           | "Vantiv"
           | "VCreditos"
+          | "VegaWallet"
           | "VoicePay"
           | "Wallet88"
           | "WeChat Pay"
@@ -21455,7 +21508,7 @@ export interface usersComponents {
       /** ID of the gateway account that processed the transaction. */
       gatewayAccountId?: string;
       /** ID of the gateway transaction. */
-      gatewayTransactionId?: usersComponents["schemas"]["ResourceId"];
+      gatewayTransactionId?: usersComponents["schemas"]["TransactionId"];
       /** Related gateway information. */
       gateway?: {
         /** Gateway response. */
@@ -22088,7 +22141,7 @@ export interface usersComponents {
        */
       parentId?: usersComponents["schemas"]["ResourceId"];
       /** ID of the related transaction. */
-      transactionId?: usersComponents["schemas"]["ResourceId"];
+      transactionId?: usersComponents["schemas"]["TransactionId"];
       settlementCurrency?: usersComponents["schemas"]["CurrencyCode"];
       /** Amount of the settlement. */
       settlementAmount?: number;
@@ -26392,6 +26445,16 @@ export interface usersComponents {
         merchantWebsiteLoginDescription?: string;
       };
     };
+    /** VegaWallet gateway configuration. */
+    VegaWallet: usersComponents["schemas"]["GatewayAccount"] & {
+      /** VegaWallet credentials object. */
+      credentials: {
+        /** ID of the VegaWallet merchant. */
+        merchantId: string;
+        /** VegaWallet merchant password. */
+        password: string;
+      };
+    };
     /** Wallet88 gateway configuration. */
     Wallet88: usersComponents["schemas"]["GatewayAccount"] & {
       /** Wallet88 credentials object. */
@@ -27635,7 +27698,7 @@ export interface usersComponents {
       /** IDs of related resources. */
       relatedIds?: {
         customerId?: usersComponents["schemas"]["CustomerId"];
-        transactionId?: usersComponents["schemas"]["ResourceId"];
+        transactionId?: usersComponents["schemas"]["TransactionId"];
         tokenId?: usersComponents["schemas"]["ResourceId"];
       };
       /** Request duration in milliseconds. */
@@ -28570,6 +28633,19 @@ export interface operations {
         limit?: usersComponents["parameters"]["collectionLimit"];
         /** Specifies the starting point within the collection of items to be returned. */
         offset?: usersComponents["parameters"]["collectionOffset"];
+        /**
+         * Filters the collection items. This field requires
+         * a special format. Use `,` for multiple allowed values.  Use `;` for multiple fields.
+         *
+         * For more information, see
+         * [Using filter with collections](https://all-rebilly.redoc.ly/#section/Using-filter-with-collections).
+         */
+        filter?: usersComponents["parameters"]["collectionFilter"];
+        /**
+         * Sorts and orders the collection of items. To sort in descending
+         * order, prefix with `-`.
+         */
+        sort?: usersComponents["parameters"]["collectionSort"];
       };
     };
     responses: {
@@ -33065,6 +33141,7 @@ export interface storefrontComponents {
       | "UPI"
       | "USD-coin"
       | "VCreditos"
+      | "VegaWallet"
       | "VenusPoint"
       | "voucher"
       | "voucher-2"
@@ -33190,6 +33267,8 @@ export interface storefrontComponents {
     };
     /** Read-only timestamp in ISO 8601 date-time format. */
     ServerTimestamp: string;
+    /** ID of the transaction. */
+    TransactionId: string;
     /** Manually set shipping amount. */
     ManualShipping: {
       /** Shipping amount. */
@@ -33614,6 +33693,7 @@ export interface storefrontComponents {
           | "VantivLitle"
           | "vegaaH"
           | "VCreditos"
+          | "VegaWallet"
           | "Wallet88"
           | "Walpay"
           | "WesternUnion"
@@ -33627,8 +33707,7 @@ export interface storefrontComponents {
       | null;
     /** Transaction information. */
     CommonTransaction: {
-      /** ID of the transaction. */
-      id?: storefrontComponents["schemas"]["ResourceId"];
+      id?: storefrontComponents["schemas"]["TransactionId"];
       websiteId?: storefrontComponents["schemas"]["WebsiteId"];
       customerId?: storefrontComponents["schemas"]["CustomerId"];
       /** Type of transaction. */
@@ -33677,7 +33756,7 @@ export interface storefrontComponents {
       requestAmount?: number;
       requestCurrency?: storefrontComponents["schemas"]["CurrencyCode"];
       /** ID of the parent transaction. */
-      parentTransactionId?: string | null;
+      parentTransactionId?: storefrontComponents["schemas"]["TransactionId"];
       /** IDs of child transactions. */
       childTransactions?: storefrontComponents["schemas"]["ResourceId"][];
       /** Related invoice IDs. */
@@ -34041,6 +34120,8 @@ export interface storefrontComponents {
       documentSubtype?: string | null;
       /** Specifies if an identity document has matching face proof. */
       hasMatchingFaceProof?: boolean;
+      /** Specifies if an identity document has been tampered with. */
+      isTampered?: boolean;
       /** Use `expirationDate` field instead. */
       expiryDate?: string | null;
     };
@@ -34089,6 +34170,8 @@ export interface storefrontComponents {
       phone?: string | null;
       /** Interpreted subtype of the uploaded document. */
       documentSubtype?: string | null;
+      /** Specifies if an address proof document has been tampered with. */
+      isTampered?: boolean;
     };
     PurchaseMatches: {
       /**
@@ -36406,7 +36489,7 @@ export interface storefrontComponents {
               | storefrontComponents["schemas"]["PaymentInstructionsToken"]
               | storefrontComponents["schemas"]["PaymentInstructionsInstrument"]
             ) & {
-              transactionId: storefrontComponents["schemas"]["ResourceId"];
+              transactionId: storefrontComponents["schemas"]["TransactionId"];
               riskMetadata?: storefrontComponents["schemas"]["RiskMetadata"];
               redirectUrl?: storefrontComponents["schemas"]["StorefrontTransactionRedirectUrl"];
             })
@@ -40554,7 +40637,7 @@ declare module "resources/balance-transactions-resource" {
     export default function BalanceTransactionsResource({ apiHandler }: {
         apiHandler: any;
     }): {
-        getAll({ limit, offset }?: rebilly.GetBalanceTransactionCollectionRequest): rebilly.GetBalanceTransactionCollectionResponsePromise;
+        getAll({ limit, offset, filter, sort }?: rebilly.GetBalanceTransactionCollectionRequest): rebilly.GetBalanceTransactionCollectionResponsePromise;
         get({ id }: {
             id: any;
         }): rebilly.GetBalanceTransactionResponsePromise;
@@ -41075,7 +41158,7 @@ declare module "resources/fees-resource" {
     export default function FeesResource({ apiHandler }: {
         apiHandler: any;
     }): {
-        getAll({ limit, offset }?: rebilly.GetFeeCollectionRequest): rebilly.GetFeeCollectionResponsePromise;
+        getAll({ limit, offset, filter, sort }?: rebilly.GetFeeCollectionRequest): rebilly.GetFeeCollectionResponsePromise;
         create({ id, data }: rebilly.CreateFeeRequest): rebilly.PostFeeResponsePromise;
         get({ id }: {
             id: any;
@@ -41084,6 +41167,9 @@ declare module "resources/fees-resource" {
             id: any;
             data: any;
         }): rebilly.PutFeeResponsePromise;
+        delete({ id }: {
+            id: any;
+        }): any;
         patch({ id, data }: {
             id: any;
             data: any;
@@ -42268,9 +42354,11 @@ declare module "resources/api-instance" {
             }): rebilly.GetApplicationInstanceByOrganizationResponsePromise;
         };
         balanceTransactions: {
-            getAll({ limit, offset }?: {
+            getAll({ limit, offset, filter, sort }?: {
                 limit?: number;
                 offset?: number;
+                filter?: string;
+                sort?: string[];
             }): rebilly.GetBalanceTransactionCollectionResponsePromise;
             get({ id }: {
                 id: any;
@@ -42813,9 +42901,11 @@ declare module "resources/api-instance" {
             }): any;
         };
         fees: {
-            getAll({ limit, offset }?: {
+            getAll({ limit, offset, filter, sort }?: {
                 limit?: number;
                 offset?: number;
+                filter?: string;
+                sort?: string[];
             }): rebilly.GetFeeCollectionResponsePromise;
             create({ id, data }: rebilly.CreateFeeRequest): rebilly.PostFeeResponsePromise;
             get({ id }: {
@@ -42825,6 +42915,9 @@ declare module "resources/api-instance" {
                 id: any;
                 data: any;
             }): rebilly.PutFeeResponsePromise;
+            delete({ id }: {
+                id: any;
+            }): any;
             patch({ id, data }: {
                 id: any;
                 data: any;