rebilly-js-sdk 56.33.0 → 56.34.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-## [56.33.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v56.32.0...rebilly-js-sdk-v56.33.0) (2024-05-30)
+## [56.34.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v56.33.1...rebilly-js-sdk-v56.34.0) (2024-06-04)
 
 
 ### Features
 
-* **recomm:** Add `v-copy-samp` component ([#5626](https://github.com/Rebilly/rebilly/issues/5626)) ([968d99d](https://github.com/Rebilly/rebilly/commit/968d99dd396b6b2b499a9eaf9df832fe437e1e94))
+* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#5593](https://github.com/Rebilly/rebilly/issues/5593)) ([bf05c5e](https://github.com/Rebilly/rebilly/commit/bf05c5e942c1d81c41a12654e4f73768df891f7c))

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

@@ -1775,6 +1775,28 @@ declare namespace rebilly {
   type PutRiskScoreBlocklistRulesResponse = operations['PutRiskScoreBlocklistRules']['responses']['201']['content']['application/json']
   type PutRiskScoreBlocklistRulesResponsePromise = Promise<{fields: PutRiskScoreBlocklistRulesResponse}>
   
+  type GetRiskScoreSimulationJobCollectionRequest = operations['GetRiskScoreSimulationJobCollection']['parameters']["query"] & (operations['GetRiskScoreSimulationJobCollection']['parameters'] extends {path: {}} ? operations['GetRiskScoreSimulationJobCollection']['parameters']["path"] : {})
+  
+  type GetRiskScoreSimulationJobCollectionResponse = operations['GetRiskScoreSimulationJobCollection']['responses']['200']['content']['application/json'][0]
+  type GetRiskScoreSimulationJobCollectionResponsePromise = Promise<{ items: {fields: GetRiskScoreSimulationJobCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
+  type PostRiskScoreSimulationJobRequest = operations['PostRiskScoreSimulationJob']['requestBody']['content']['application/json']
+  type CreateRiskScoreSimulationJobRequest = { id?: string,  data: PostRiskScoreSimulationJobRequest, expand?: string }
+  type PostRiskScoreSimulationJobResponse = operations['PostRiskScoreSimulationJob']['responses']['201']['content']['application/json']
+  type PostRiskScoreSimulationJobResponsePromise = Promise<{fields: PostRiskScoreSimulationJobResponse}>
+  
+  type GetRiskScoreSimulationJobRequest = { id: string }
+
+  type GetRiskScoreSimulationJobResponse = operations['GetRiskScoreSimulationJob']['responses']['200']['content']['application/json']
+  type GetRiskScoreSimulationJobResponsePromise = Promise<{fields: GetRiskScoreSimulationJobResponse}>
+  
+  type PostRiskScoreSimulationJobStopResponse = operations['PostRiskScoreSimulationJobStop']['responses']['200']['content']['application/json']
+  type PostRiskScoreSimulationJobStopResponsePromise = Promise<{fields: PostRiskScoreSimulationJobStopResponse}>
+  
+  type GetRiskScoreSimulatedTransactionCollectionRequest = operations['GetRiskScoreSimulatedTransactionCollection']['parameters']["query"] & (operations['GetRiskScoreSimulatedTransactionCollection']['parameters'] extends {path: {}} ? operations['GetRiskScoreSimulatedTransactionCollection']['parameters']["path"] : {}) & { id: string }
+  
+  type GetRiskScoreSimulatedTransactionCollectionResponse = operations['GetRiskScoreSimulatedTransactionCollection']['responses']['200']['content']['application/json'][0]
+  type GetRiskScoreSimulatedTransactionCollectionResponsePromise = Promise<{ items: {fields: GetRiskScoreSimulatedTransactionCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
+  
   type GetAllowlistCollectionRequest = operations['GetAllowlistCollection']['parameters']["query"] & (operations['GetAllowlistCollection']['parameters'] extends {path: {}} ? operations['GetAllowlistCollection']['parameters']["path"] : {})
   
   type GetAllowlistCollectionResponse = operations['GetAllowlistCollection']['responses']['200']['content']['application/json'][0]
@@ -5176,6 +5198,42 @@ export interface corePaths {
     /** Modifies risk score blocklist rules. */
     put: operations["PutRiskScoreBlocklistRules"];
   };
+  "/risk-score-simulation-jobs": {
+    /** Retrieves a list of simulation jobs. */
+    get: operations["GetRiskScoreSimulationJobCollection"];
+    /** Creates a new risk score simulation job. */
+    post: operations["PostRiskScoreSimulationJob"];
+  };
+  "/risk-score-simulation-jobs/{id}": {
+    /** Retrieves a specified risk score simulation job. */
+    get: operations["GetRiskScoreSimulationJob"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/risk-score-simulation-jobs/{id}/stop": {
+    /** Stops an active risk score simulation job. */
+    post: operations["PostRiskScoreSimulationJobStop"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/risk-score-simulation-jobs/{id}/transactions": {
+    /** Retrieves a list of affected transactions for a specified risk score simulation. */
+    get: operations["GetRiskScoreSimulatedTransactionCollection"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
   "/allowlists": {
     /** Retrieves allowlist collection. */
     get: operations["GetAllowlistCollection"];
@@ -19913,6 +19971,8 @@ export interface coreComponents {
       status?: "ok";
       /** Current date and time. */
       time?: coreComponents["schemas"]["ServerTimestamp"];
+      /** Current release version of the API. */
+      release?: string;
     };
     /** API request tracking. */
     ApiTracking: {
@@ -22374,6 +22434,12 @@ export interface coreComponents {
        * Subscriptions cannot be changed in the preview.
        */
       preview?: boolean;
+      /**
+       * Specifies if payment attempts for the related subscription are made automatically.
+       * If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
+       * or the default payment instrument on the subscription.
+       */
+      autopay?: boolean;
     };
     StorefrontQuoteChangeOrder: {
       /** ID of the quote. */
@@ -24045,6 +24111,66 @@ export interface coreComponents {
       /** Payment card number being charged. */
       "payment-card"?: coreComponents["schemas"]["RiskScoreBlocklistType"];
     };
+    /** Resource to simulate a risk score calculation given a set of risk score settings. */
+    RiskScoreSimulationJob: {
+      /** ID of the job. */
+      id?: string;
+      /** Status of the job. */
+      status?: "pending" | "processing" | "completed" | "failed" | "stopped";
+      /** Summary of the simulation. */
+      summary?: {
+        metric?:
+          | "processedTransactions"
+          | "affectedTransactions"
+          | "declinedToCanceledTransactions"
+          | "canceledToApprovedTransactions"
+          | "approvedToCanceledTransactions";
+        count?: number;
+        amount?: coreComponents["schemas"]["Money"];
+      }[];
+      /** Risk score rules. */
+      rules: coreComponents["schemas"]["RiskScoreRules"];
+      /** Full period of the simulation. */
+      period: {
+        startDate?: string;
+        endDate?: string;
+      };
+      createdTime?: coreComponents["schemas"]["CreatedTime"];
+      updatedTime?: coreComponents["schemas"]["UpdatedTime"];
+      /** Date and time when the simulation job started. */
+      startedTime?: coreComponents["schemas"]["ServerTimestamp"];
+      /** Date and time when the simulation job finished. */
+      finishedTime?: coreComponents["schemas"]["ServerTimestamp"];
+      _links?: coreComponents["schemas"]["SelfLink"];
+      _embedded?: {
+        /** Transactions of the simulation. */
+        transactions?: any[];
+      };
+    };
+    /** Transaction affected in risk score simulation. */
+    RiskScoreSimulationTransaction: {
+      /** ID of the transaction. */
+      transactionId?: string;
+      /** ID of the customer. */
+      customerId?: string;
+      /** ID of the simulation job. */
+      simulationJobId?: string;
+      /** Amount of the transaction. */
+      amount?: coreComponents["schemas"]["Money"];
+      /** Pre-simulation state of the transaction. */
+      preResult?: "canceled" | "declined" | "approved";
+      /** Result of the simulation. */
+      result?: "blocked" | "approved";
+      /** Date of the transaction. */
+      date?: string;
+      /** Related links. */
+      _links?: {
+        /** Link URL. */
+        href?: string;
+        /** Type of link. */
+        rel?: "customer" | "transaction";
+      }[];
+    };
     /** Risk score allowlist record. */
     Allowlist: {
       /** ID of the allowlist record. */
@@ -37968,6 +38094,128 @@ export interface operations {
       };
     };
   };
+  /** Retrieves a list of simulation jobs. */
+  GetRiskScoreSimulationJobCollection: {
+    parameters: {
+      query: {
+        /**
+         * 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://www.rebilly.com/docs/dev-docs/search-filters).
+         */
+        filter?: coreComponents["parameters"]["collectionFilter"];
+        /**
+         * Sorts and orders the collection of items. To sort in descending
+         * order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
+         */
+        sort?: coreComponents["parameters"]["collectionSort"];
+        /** Limits the number of collection items to be returned. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** Specifies the starting point within the collection of items to be returned. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+      };
+    };
+    responses: {
+      /** List of risk score simulation jobs retrieved. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["RiskScoreSimulationJob"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
+  /** Creates a new risk score simulation job. */
+  PostRiskScoreSimulationJob: {
+    responses: {
+      /** Risk score simulation job created. */
+      201: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["RiskScoreSimulationJob"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      422: coreComponents["responses"]["ValidationError"];
+    };
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["RiskScoreSimulationJob"];
+      };
+    };
+  };
+  /** Retrieves a specified risk score simulation job. */
+  GetRiskScoreSimulationJob: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Risk score simulation job retrieved. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["RiskScoreSimulationJob"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Stops an active risk score simulation job. */
+  PostRiskScoreSimulationJobStop: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Risk score simulation job stopped. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["RiskScoreSimulationJob"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
+  /** Retrieves a list of affected transactions for a specified risk score simulation. */
+  GetRiskScoreSimulatedTransactionCollection: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+      query: {
+        /** Limits the number of collection items to be returned. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** Specifies the starting point within the collection of items to be returned. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+      };
+    };
+    responses: {
+      /** List of affected transactions retrieved. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["RiskScoreSimulationTransaction"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
   /** Retrieves allowlist collection. */
   GetAllowlistCollection: {
     parameters: {
@@ -53433,6 +53681,8 @@ export interface storefrontComponents {
       status?: "ok";
       /** Current date and time. */
       time?: storefrontComponents["schemas"]["ServerTimestamp"];
+      /** Current release version of the API. */
+      release?: string;
     };
     /** API request tracking. */
     ApiTracking: {
@@ -55894,6 +56144,12 @@ export interface storefrontComponents {
        * Subscriptions cannot be changed in the preview.
        */
       preview?: boolean;
+      /**
+       * Specifies if payment attempts for the related subscription are made automatically.
+       * If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
+       * or the default payment instrument on the subscription.
+       */
+      autopay?: boolean;
     };
     StorefrontQuoteChangeOrder: {
       /** ID of the quote. */
@@ -57565,6 +57821,66 @@ export interface storefrontComponents {
       /** Payment card number being charged. */
       "payment-card"?: storefrontComponents["schemas"]["RiskScoreBlocklistType"];
     };
+    /** Resource to simulate a risk score calculation given a set of risk score settings. */
+    RiskScoreSimulationJob: {
+      /** ID of the job. */
+      id?: string;
+      /** Status of the job. */
+      status?: "pending" | "processing" | "completed" | "failed" | "stopped";
+      /** Summary of the simulation. */
+      summary?: {
+        metric?:
+          | "processedTransactions"
+          | "affectedTransactions"
+          | "declinedToCanceledTransactions"
+          | "canceledToApprovedTransactions"
+          | "approvedToCanceledTransactions";
+        count?: number;
+        amount?: storefrontComponents["schemas"]["Money"];
+      }[];
+      /** Risk score rules. */
+      rules: storefrontComponents["schemas"]["RiskScoreRules"];
+      /** Full period of the simulation. */
+      period: {
+        startDate?: string;
+        endDate?: string;
+      };
+      createdTime?: storefrontComponents["schemas"]["CreatedTime"];
+      updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
+      /** Date and time when the simulation job started. */
+      startedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
+      /** Date and time when the simulation job finished. */
+      finishedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
+      _links?: storefrontComponents["schemas"]["SelfLink"];
+      _embedded?: {
+        /** Transactions of the simulation. */
+        transactions?: any[];
+      };
+    };
+    /** Transaction affected in risk score simulation. */
+    RiskScoreSimulationTransaction: {
+      /** ID of the transaction. */
+      transactionId?: string;
+      /** ID of the customer. */
+      customerId?: string;
+      /** ID of the simulation job. */
+      simulationJobId?: string;
+      /** Amount of the transaction. */
+      amount?: storefrontComponents["schemas"]["Money"];
+      /** Pre-simulation state of the transaction. */
+      preResult?: "canceled" | "declined" | "approved";
+      /** Result of the simulation. */
+      result?: "blocked" | "approved";
+      /** Date of the transaction. */
+      date?: string;
+      /** Related links. */
+      _links?: {
+        /** Link URL. */
+        href?: string;
+        /** Type of link. */
+        rel?: "customer" | "transaction";
+      }[];
+    };
     /** Risk score allowlist record. */
     Allowlist: {
       /** ID of the allowlist record. */
@@ -75992,6 +76308,8 @@ export interface reportsComponents {
       status?: "ok";
       /** Current date and time. */
       time?: reportsComponents["schemas"]["ServerTimestamp"];
+      /** Current release version of the API. */
+      release?: string;
     };
     /** API request tracking. */
     ApiTracking: {
@@ -78453,6 +78771,12 @@ export interface reportsComponents {
        * Subscriptions cannot be changed in the preview.
        */
       preview?: boolean;
+      /**
+       * Specifies if payment attempts for the related subscription are made automatically.
+       * If autopay is enabled, the payment is retrieved from the customer on the renewal date using the payment instrument that is set at `paymentInstrumentId`,
+       * or the default payment instrument on the subscription.
+       */
+      autopay?: boolean;
     };
     StorefrontQuoteChangeOrder: {
       /** ID of the quote. */
@@ -80124,6 +80448,66 @@ export interface reportsComponents {
       /** Payment card number being charged. */
       "payment-card"?: reportsComponents["schemas"]["RiskScoreBlocklistType"];
     };
+    /** Resource to simulate a risk score calculation given a set of risk score settings. */
+    RiskScoreSimulationJob: {
+      /** ID of the job. */
+      id?: string;
+      /** Status of the job. */
+      status?: "pending" | "processing" | "completed" | "failed" | "stopped";
+      /** Summary of the simulation. */
+      summary?: {
+        metric?:
+          | "processedTransactions"
+          | "affectedTransactions"
+          | "declinedToCanceledTransactions"
+          | "canceledToApprovedTransactions"
+          | "approvedToCanceledTransactions";
+        count?: number;
+        amount?: reportsComponents["schemas"]["Money"];
+      }[];
+      /** Risk score rules. */
+      rules: reportsComponents["schemas"]["RiskScoreRules"];
+      /** Full period of the simulation. */
+      period: {
+        startDate?: string;
+        endDate?: string;
+      };
+      createdTime?: reportsComponents["schemas"]["CreatedTime"];
+      updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
+      /** Date and time when the simulation job started. */
+      startedTime?: reportsComponents["schemas"]["ServerTimestamp"];
+      /** Date and time when the simulation job finished. */
+      finishedTime?: reportsComponents["schemas"]["ServerTimestamp"];
+      _links?: reportsComponents["schemas"]["SelfLink"];
+      _embedded?: {
+        /** Transactions of the simulation. */
+        transactions?: any[];
+      };
+    };
+    /** Transaction affected in risk score simulation. */
+    RiskScoreSimulationTransaction: {
+      /** ID of the transaction. */
+      transactionId?: string;
+      /** ID of the customer. */
+      customerId?: string;
+      /** ID of the simulation job. */
+      simulationJobId?: string;
+      /** Amount of the transaction. */
+      amount?: reportsComponents["schemas"]["Money"];
+      /** Pre-simulation state of the transaction. */
+      preResult?: "canceled" | "declined" | "approved";
+      /** Result of the simulation. */
+      result?: "blocked" | "approved";
+      /** Date of the transaction. */
+      date?: string;
+      /** Related links. */
+      _links?: {
+        /** Link URL. */
+        href?: string;
+        /** Type of link. */
+        rel?: "customer" | "transaction";
+      }[];
+    };
     /** Risk score allowlist record. */
     Allowlist: {
       /** ID of the allowlist record. */
@@ -84803,6 +85187,23 @@ declare module "resources/risk-score-rules-resource" {
         }): rebilly.PutRiskScoreBlocklistRulesResponsePromise;
     };
 }
+declare module "resources/risk-score-simulation-jobs-resource" {
+    export default function RiskScoreSimulationJobsResource({ apiHandler }: {
+        apiHandler: any;
+    }): {
+        getAll({ filter, sort, limit, offset }?: rebilly.GetRiskScoreSimulationJobCollectionRequest): rebilly.GetRiskScoreSimulationJobCollectionResponsePromise;
+        create({ data }: {
+            data: any;
+        }): any;
+        get({ id }: {
+            id: any;
+        }): rebilly.GetRiskScoreSimulationJobResponsePromise;
+        stop({ id }: {
+            id: any;
+        }): any;
+        getTransactions({ id, limit, offset }: rebilly.GetRiskScoreSimulatedTransactionCollectionRequest): rebilly.GetRiskScoreSimulatedTransactionCollectionResponsePromise;
+    };
+}
 declare module "resources/roles-resource" {
     export default function RolesResource({ apiHandler }: {
         apiHandler: any;
@@ -86655,6 +87056,24 @@ declare module "resources/api-instance" {
                 data: any;
             }): rebilly.PutRiskScoreBlocklistRulesResponsePromise;
         };
+        riskScoreSimulationJobs: {
+            getAll({ filter, sort, limit, offset }?: {
+                filter?: string;
+                sort?: string[];
+                limit?: number;
+                offset?: number;
+            }): rebilly.GetRiskScoreSimulationJobCollectionResponsePromise;
+            create({ data }: {
+                data: any;
+            }): any;
+            get({ id }: {
+                id: any;
+            }): rebilly.GetRiskScoreSimulationJobResponsePromise;
+            stop({ id }: {
+                id: any;
+            }): any;
+            getTransactions({ id, limit, offset }: rebilly.GetRiskScoreSimulatedTransactionCollectionRequest): rebilly.GetRiskScoreSimulatedTransactionCollectionResponsePromise;
+        };
         roles: {
             getAll({ limit, offset, filter, sort, q, expand, }?: {
                 limit?: number;