@wix/auto_sdk_benefit-programs_transactions 1.0.1 → 1.0.3

package/build/cjs/src/benefit-programs-v1-transaction-transactions.http.d.ts

@@ -4,12 +4,14 @@ export declare function getTransaction(payload: object): RequestOptionsFactory<a
 /**
  * Creates a query to retrieve a list of transactions.
  *
- * The `queryTransactions()` method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
+ * The Query Transactions method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/transactions/transactions-query-builder/find) function.
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
  *
- * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryTransactions()` returns.
+ * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Transactions returns.
  *
- * The following `TransactionsQueryBuilder` functions are supported for `queryTransactions()`. For a full description of the transaction object, see the object returned for the [`items`](/transactions/transactions-query-result/items) property in `TransactionsQueryResult`.
+ * Query Transactions has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `items` property in `TransactionsQueryResult`.
  */
 export declare function queryTransactions(payload: object): RequestOptionsFactory<any>;

package/build/cjs/src/benefit-programs-v1-transaction-transactions.http.js

@@ -116,13 +116,15 @@ exports.getTransaction = getTransaction;
 /**
  * Creates a query to retrieve a list of transactions.
  *
- * The `queryTransactions()` method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
+ * The Query Transactions method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
  *
- * The returned object contains the query definition, which is used to run the query using the [`find()`](/transactions/transactions-query-builder/find) function.
+ * The returned object contains the query definition, which is used to run the query using the `find()` method.
  *
- * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryTransactions()` returns.
+ * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Transactions returns.
  *
- * The following `TransactionsQueryBuilder` functions are supported for `queryTransactions()`. For a full description of the transaction object, see the object returned for the [`items`](/transactions/transactions-query-result/items) property in `TransactionsQueryResult`.
+ * Query Transactions has a default paging limit of 50, which you can override.
+ *
+ *  For a full description of the item object, see the object returned for the `items` property in `TransactionsQueryResult`.
  */
 function queryTransactions(payload) {
     function __queryTransactions({ host }) {

package/build/cjs/src/benefit-programs-v1-transaction-transactions.http.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-transaction-transactions.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,2DAA2D,CAClE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,6CAA6C,CAAC;AAEnE,+BAA+B;AAC/B,SAAgB,cAAc,CAAC,OAAe;IAC5C,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qCAAqC;YACjD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,uEAAuE;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,2DAA2D,CAAC;gBAC/D,SAAS,EAAE,kCAAkC;gBAC7C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,yBAAyB,EAAE;wBACnC,EAAE,IAAI,EAAE,yBAAyB,EAAE;wBACnC,EAAE,IAAI,EAAE,mCAAmC,EAAE;qBAC9C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AA/BD,wCA+BC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAC/C,SAAS,mBAAmB,CAAC,EAAE,IAAI,EAAO;QACxC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qCAAqC;YACjD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0EAA0E;YAC5E,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,2DAA2D,CAAC;gBAC/D,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,oCAAoC,EAAE;qBAC/C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AA/BD,8CA+BC"}
+{"version":3,"file":"benefit-programs-v1-transaction-transactions.http.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.http.ts"],"names":[],"mappings":";;;AAAA,gEAAkE;AAClE,0EAAkG;AAClG,sFAAkF;AAClF,gEAA2D;AAI3D,SAAS,2DAA2D,CAClE,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,EAAE;aACb;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,wCAAwC;gBACjD,QAAQ,EAAE,kBAAkB;aAC7B;YACD;gBACE,OAAO,EAAE,6CAA6C;gBACtD,QAAQ,EAAE,uBAAuB;aAClC;SACF;KACF,CAAC;IAEF,OAAO,IAAA,yBAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,YAAY,GAAG,6CAA6C,CAAC;AAEnE,+BAA+B;AAC/B,SAAgB,cAAc,CAAC,OAAe;IAC5C,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qCAAqC;YACjD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,uEAAuE;YACzE,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,2DAA2D,CAAC;gBAC/D,SAAS,EAAE,kCAAkC;gBAC7C,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,gCAAiB,EAAC,OAAO,CAAC;YAClC,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,yBAAyB,EAAE;wBACnC,EAAE,IAAI,EAAE,yBAAyB,EAAE;wBACnC,EAAE,IAAI,EAAE,mCAAmC,EAAE;qBAC9C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AA/BD,wCA+BC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,iBAAiB,CAAC,OAAe;IAC/C,SAAS,mBAAmB,CAAC,EAAE,IAAI,EAAO;QACxC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,qCAAqC;YACjD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,0EAA0E;YAC5E,WAAW,EAAE,YAAY;YACzB,GAAG,EAAE,2DAA2D,CAAC;gBAC/D,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,OAAO;gBACb,IAAI;aACL,CAAC;YACF,IAAI,EAAE,OAAO;YACb,iBAAiB,EAAE,CAAC,OAAY,EAAE,EAAE,CAClC,IAAA,gCAAc,EAAC,OAAO,EAAE;gBACtB;oBACE,WAAW,EAAE,gDAAoC;oBACjD,KAAK,EAAE;wBACL,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,0BAA0B,EAAE;wBACpC,EAAE,IAAI,EAAE,oCAAoC,EAAE;qBAC/C;iBACF;aACF,CAAC;SACL,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AA/BD,8CA+BC"}

package/build/cjs/src/benefit-programs-v1-transaction-transactions.public.d.ts

@@ -7,7 +7,7 @@ export declare function getTransaction(httpClient: HttpClient): GetTransactionSi
 interface GetTransactionSignature {
     /**
      * Retrieves a transaction.
-     * @param - Id of the transaction to retrieve.
+     * @param - ID of the transaction to retrieve.
      * @returns Retrieved transaction.
      */
     (transactionId: string): Promise<Transaction & TransactionNonNullableFields>;
@@ -17,13 +17,15 @@ interface QueryTransactionsSignature {
     /**
      * Creates a query to retrieve a list of transactions.
      *
-     * The `queryTransactions()` method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
+     * The Query Transactions method builds a query to retrieve a list of transactions and returns a `TransactionsQueryBuilder` object.
      *
-     * The returned object contains the query definition, which is used to run the query using the [`find()`](/transactions/transactions-query-builder/find) function.
+     * The returned object contains the query definition, which is used to run the query using the `find()` method.
      *
-     * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that `queryTransactions()` returns.
+     * You can refine the query by chaining `TransactionsQueryBuilder` methods onto the query. `TransactionsQueryBuilder` methods enable you to filter, sort, and control the results that Query Transactions returns.
      *
-     * The following `TransactionsQueryBuilder` functions are supported for `queryTransactions()`. For a full description of the transaction object, see the object returned for the [`items`](/transactions/transactions-query-result/items) property in `TransactionsQueryResult`.
+     * Query Transactions has a default paging limit of 50, which you can override.
+     *
+     *  For a full description of the item object, see the object returned for the `items` property in `TransactionsQueryResult`.
      */
     (): TransactionsQueryBuilder;
 }

package/build/cjs/src/benefit-programs-v1-transaction-transactions.public.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-transaction-transactions.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.public.ts"],"names":[],"mappings":";;;AACA,2IAMqE;AAExD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,aAAqB,EAAE,EAAE,CAC/B,IAAA,0EAAuB,EACrB,aAAa;IACb,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,wCASC;AAWD,SAAgB,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,6EAA0B;IACxB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8CAQC;AAiBD,yIAmDqE;AAhDnE,wJAAA,WAAW,OAAA;AA2BX,yJAAA,YAAY,OAAA;AAUZ,sJAAA,SAAS,OAAA;AAKT,8JAAA,iBAAiB,OAAA;AAKjB,gKAAA,mBAAmB,OAAA"}
+{"version":3,"file":"benefit-programs-v1-transaction-transactions.public.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.public.ts"],"names":[],"mappings":";;;AACA,2IAMqE;AAExD,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,uBAAuB,EAAE,CAAC;AAEpE,SAAgB,cAAc,CAC5B,UAAsB;IAEtB,OAAO,CAAC,aAAqB,EAAE,EAAE,CAC/B,IAAA,0EAAuB,EACrB,aAAa;IACb,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AATD,wCASC;AAWD,SAAgB,iBAAiB,CAC/B,UAAsB;IAEtB,OAAO,GAAG,EAAE,CACV,IAAA,6EAA0B;IACxB,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8CAQC;AAmBD,yIAmDqE;AAhDnE,wJAAA,WAAW,OAAA;AA2BX,yJAAA,YAAY,OAAA;AAUZ,sJAAA,SAAS,OAAA;AAKT,8JAAA,iBAAiB,OAAA;AAKjB,gKAAA,mBAAmB,OAAA"}

package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.d.ts

@@ -1,6 +1,7 @@
 export interface Transaction {
     /**
      * Transaction ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -20,42 +21,43 @@ export interface Transaction {
      */
     updatedDate?: Date | null;
     /**
-     * The benefit pool associated with the balance object.
+     * Pool associated with this transaction.
      * @readonly
      */
     pool?: PoolInfo;
-    /** Absolute amount to adjust the balance with. This field is determined by the source and target balances. */
+    /**
+     * Amount to adjust the balance in this transaction.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     amount?: string;
-    /** Source balance. */
+    /** Where the credits came from. */
     source?: BalanceType;
-    /** Target balance. */
+    /** Where the credits went to. */
     target?: BalanceType;
     /**
      * Unique identifier, generated by the client.
      * Used to recognize repeated attempts to make the same request.
+     * @maxLength 200
      * @readonly
      */
     idempotencyKey?: string;
     /**
-     * Related transaction ID. For example, in the case of a cancelled reservation, the related transaction is the benefit redemption.
+     * ID of the related transaction. For example, if this transaction is a refund for a benefit redemption, the related transaction is the benefit redemption transaction.
+     * @format GUID
      * @readonly
      */
     relatedTransactionId?: string | null;
     /**
-     * Identity of the individual that enrolled in the program associated with this benefit transaction.
+     * Beneficiary of the pool associated with this transaction.
      * @readonly
      */
     beneficiary?: CommonIdentificationData;
     /**
-     * The identity that created this transaction.
+     * Identity that created the transaction.
      * @readonly
      */
     instructingParty?: CommonIdentificationData;
-    /**
-     * Transaction status.
-     *
-     * `PENDING` is the initial status of a transaction. After the balance is updated, the status changes to `COMPLETED` if the transaction was successful, or `FAILED`, if the balance update fails.
-     */
+    /** Transaction status. */
     status?: TransactionStatus;
     /**
      * Additional transaction details.
@@ -65,60 +67,87 @@ export interface Transaction {
     /**
      * Custom field data for the transaction object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
 }
 export interface PoolInfo {
     /**
-     * Benefit pool ID.
+     * Pool ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
     /**
-     * Pool definition ID from which this benefit pool was instantiated.
+     * ID of the pool definition the pool was created from.
+     * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
-     * ID for the program definition from which this benefit pool was provisioned.
+     * ID of the program definition the pool was created from.
+     * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
-     * ID of the program to which this benefit pool belongs.
+     * ID of the program that contains the pool.
+     * @format GUID
      * @readonly
      */
     programId?: string | null;
-    /** Total amount of credits available for this benefit pool. */
+    /**
+     * Available credits.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     creditAmount?: string | null;
-    /** The external system that is the source of the pool creation. For example, `wix-pricing-plans`, `wix-loyalty`. */
+    /**
+     * Namespace for your app or site's benefit programs.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
 }
 export declare enum BalanceType {
     UNDEFINED = "UNDEFINED",
-    /** Available balance. */
+    /** In a pool's balance. */
     AVAILABLE = "AVAILABLE",
-    /** Reserved balance. */
-    RESERVED = "RESERVED",
-    /** External balance. */
+    /** Outside a pool's balance. */
     EXTERNAL = "EXTERNAL"
 }
 export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
     wixUserId?: string;
 }
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that hasn't logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site member.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user.
+     * @format GUID
+     */
     wixUserId?: string;
 }
 export declare enum IdentityType {
@@ -133,53 +162,61 @@ export declare enum IdentityType {
 }
 export declare enum TransactionStatus {
     UNDEFINED = "UNDEFINED",
-    /** Transaction is pending. */
+    /** Transaction is pending. This is the initial transaction status. */
     PENDING = "PENDING",
-    /** Transaction completed. */
+    /** Transaction completed successfully. */
     COMPLETED = "COMPLETED",
     /** Transaction failed. */
     FAILED = "FAILED"
 }
 export interface TransactionDetails {
     /**
-     * Item associated with the balance change.
-     * The redemption of this item triggered the balance adjustment.
+     * Item associated with the transaction.
      * @readonly
      */
     item?: Item;
-    /** Quantity of an item related to the balance change. */
+    /** Amount of items associated with the transaction. */
     itemCount?: number | null;
     /**
-     * Date and time the transaction was made.
+     * Date and time the transaction was created.
      * @readonly
      */
     effectiveDate?: Date | null;
     /**
-     * Reason for the transaction. For example, `Redemption` or `Manual adjustment`.
+     * Reason for the transaction. For example, `Redemption`.
      * @readonly
+     * @maxLength 256
      */
     reason?: string | null;
 }
 export interface Item {
     /**
      * Item ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
     /**
-     * External item ID.
+     * Item external ID.
+     * @format GUID
      * @readonly
      */
     externalId?: string | null;
     /**
-     * Item category. Distinguishes between different types of items. For example, `posts`, `groups`, `events`.
+     * Item category.
+     * @maxLength 20
      * @readonly
      */
     category?: string | null;
-    /** @readonly */
+    /**
+     * Item set ID.
+     * @format GUID
+     * @readonly
+     */
     itemSetId?: string | null;
     /**
-     * Item display name.
+     * Item name.
+     * @maxLength 64
      * @readonly
      */
     displayName?: string | null;
@@ -204,7 +241,11 @@ export interface CreateTransactionResponse {
     transaction?: Transaction;
 }
 export interface BulkCreateTransactionsRequest {
-    /** Transactions to be created. */
+    /**
+     * Transactions to be created.
+     * @minSize 1
+     * @maxSize 100
+     */
     transactions?: Transaction[];
     /**
      * Whether to return the full item entities.
@@ -218,6 +259,8 @@ export interface BulkCreateTransactionsResponse {
      * List of results for each transaction.
      *
      * Includes the transaction and whether the operation was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkTransactionResult[];
     /** Bulk action metadata. */
@@ -230,7 +273,10 @@ export interface BulkTransactionResult {
     transaction?: Transaction;
 }
 export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
     id?: string | null;
     /** Index of the item within the request array. Allows for correlation between request and response items. */
     originalIndex?: number;
@@ -264,7 +310,11 @@ export interface UpdateTransactionResponse {
     transaction?: Transaction;
 }
 export interface BulkUpdateTransactionsRequest {
-    /** Transactions to update. */
+    /**
+     * Transactions to update.
+     * @minSize 1
+     * @maxSize 100
+     */
     transactions?: MaskedTransaction[];
     /**
      * Whether to return full transaction entities.
@@ -284,13 +334,18 @@ export interface BulkUpdateTransactionsResponse {
      * List of results for each Transaction.
      *
      * Includes the Transaction and whether the update was successful.
+     * @minSize 1
+     * @maxSize 100
      */
     results?: BulkTransactionResult[];
     /** Bulk action metadata. */
     bulkActionMetadata?: BulkActionMetadata;
 }
 export interface GetTransactionRequest {
-    /** Id of the transaction to retrieve. */
+    /**
+     * ID of the transaction to retrieve.
+     * @format GUID
+     */
     transactionId: string;
 }
 export interface GetTransactionResponse {
@@ -298,7 +353,7 @@ export interface GetTransactionResponse {
     transaction?: Transaction;
 }
 export interface QueryTransactionsRequest {
-    /** Query to select transactions. */
+    /** Filter, sort, and paging to apply to the query. */
     query: CursorQuery;
 }
 export interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -316,6 +371,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 5
      */
     sort?: Sorting[];
 }
@@ -325,7 +381,10 @@ export interface CursorQueryPagingMethodOneOf {
     cursorPaging?: CursorPaging;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -337,18 +396,22 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
 export interface QueryTransactionsResponse {
-    /** The retrieved transactions. */
+    /** List of retrieved transactions. */
     transactions?: Transaction[];
     /** Metadata for paginated results. */
     metadata?: CursorPagingMetadata;
@@ -367,9 +430,15 @@ export interface CursorPagingMetadata {
     hasNext?: boolean | null;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
 export interface DomainEvent extends DomainEventBodyOneOf {
@@ -445,9 +514,15 @@ export interface ActionEvent {
     bodyAsJson?: string;
 }
 export interface MessageEnvelope {
-    /** App instance ID. */
+    /**
+     * App instance ID.
+     * @format GUID
+     */
     instanceId?: string | null;
-    /** Event type. */
+    /**
+     * Event type.
+     * @maxLength 150
+     */
     eventType?: string;
     /** The identification type and identity data. */
     identity?: IdentificationData;
@@ -455,26 +530,50 @@ export interface MessageEnvelope {
     data?: string;
 }
 export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
     /** @readonly */
     identityType?: WebhookIdentityType;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
     anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
     memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
     wixUserId?: string;
-    /** ID of an app. */
+    /**
+     * ID of an app.
+     * @format GUID
+     */
     appId?: string;
 }
 export declare enum WebhookIdentityType {

package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.js

@@ -4,11 +4,9 @@ exports.WebhookIdentityType = exports.SortOrder = exports.TransactionStatus = ex
 var BalanceType;
 (function (BalanceType) {
     BalanceType["UNDEFINED"] = "UNDEFINED";
-    /** Available balance. */
+    /** In a pool's balance. */
     BalanceType["AVAILABLE"] = "AVAILABLE";
-    /** Reserved balance. */
-    BalanceType["RESERVED"] = "RESERVED";
-    /** External balance. */
+    /** Outside a pool's balance. */
     BalanceType["EXTERNAL"] = "EXTERNAL";
 })(BalanceType || (exports.BalanceType = BalanceType = {}));
 var IdentityType;
@@ -25,9 +23,9 @@ var IdentityType;
 var TransactionStatus;
 (function (TransactionStatus) {
     TransactionStatus["UNDEFINED"] = "UNDEFINED";
-    /** Transaction is pending. */
+    /** Transaction is pending. This is the initial transaction status. */
     TransactionStatus["PENDING"] = "PENDING";
-    /** Transaction completed. */
+    /** Transaction completed successfully. */
     TransactionStatus["COMPLETED"] = "COMPLETED";
     /** Transaction failed. */
     TransactionStatus["FAILED"] = "FAILED";

package/build/cjs/src/benefit-programs-v1-transaction-transactions.types.js.map

@@ -1 +1 @@
-{"version":3,"file":"benefit-programs-v1-transaction-transactions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.types.ts"],"names":[],"mappings":";;;AAmGA,IAAY,WAQX;AARD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,yBAAyB;IACzB,sCAAuB,CAAA;IACvB,wBAAwB;IACxB,oCAAqB,CAAA;IACrB,wBAAwB;IACxB,oCAAqB,CAAA;AACvB,CAAC,EARW,WAAW,2BAAX,WAAW,QAQtB;AAsBD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAED,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,8BAA8B;IAC9B,wCAAmB,CAAA;IACnB,6BAA6B;IAC7B,4CAAuB,CAAA;IACvB,0BAA0B;IAC1B,sCAAiB,CAAA;AACnB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAsND,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA6JD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
+{"version":3,"file":"benefit-programs-v1-transaction-transactions.types.js","sourceRoot":"","sources":["../../../src/benefit-programs-v1-transaction-transactions.types.ts"],"names":[],"mappings":";;;AAgHA,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,2BAA2B;IAC3B,sCAAuB,CAAA;IACvB,gCAAgC;IAChC,oCAAqB,CAAA;AACvB,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AAwCD,IAAY,YASX;AATD,WAAY,YAAY;IACtB,4CAA4C;IAC5C,mCAAmB,CAAA;IACnB,4CAA4C;IAC5C,uDAAuC,CAAA;IACvC,+BAA+B;IAC/B,iCAAiB,CAAA;IACjB,iEAAiE;IACjE,qCAAqB,CAAA;AACvB,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AAED,IAAY,iBAQX;AARD,WAAY,iBAAiB;IAC3B,4CAAuB,CAAA;IACvB,sEAAsE;IACtE,wCAAmB,CAAA;IACnB,0CAA0C;IAC1C,4CAAuB,CAAA;IACvB,0BAA0B;IAC1B,sCAAiB,CAAA;AACnB,CAAC,EARW,iBAAiB,iCAAjB,iBAAiB,QAQ5B;AAoPD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,4BAA4B;IAC5B,wBAAW,CAAA;IACX,6BAA6B;IAC7B,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AAqMD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}