@wix/auto_sdk_benefit-programs_transactions 1.0.1 → 1.0.2

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;
@@ -24,7 +25,10 @@ export interface Transaction {
      * @readonly
      */
     pool?: PoolInfo;
-    /** Absolute amount to adjust the balance with. This field is determined by the source and target balances. */
+    /**
+     * Absolute amount to adjust the balance with. This field is determined by the source and target balances.
+     * @decimalValue options { gte:0, maxScale:4 }
+     */
     amount?: string;
     /** Source balance. */
     source?: BalanceType;
@@ -33,11 +37,13 @@ export interface Transaction {
     /**
      * 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.
+     * @format GUID
      * @readonly
      */
     relatedTransactionId?: string | null;
@@ -72,27 +78,38 @@ export interface Transaction {
 export interface PoolInfo {
     /**
      * Benefit pool ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
     /**
      * Pool definition ID from which this benefit pool was instantiated.
+     * @format GUID
      * @readonly
      */
     poolDefinitionId?: string | null;
     /**
      * ID for the program definition from which this benefit pool was provisioned.
+     * @format GUID
      * @readonly
      */
     programDefinitionId?: string | null;
     /**
      * ID of the program to which this benefit pool belongs.
+     * @format GUID
      * @readonly
      */
     programId?: string | null;
-    /** Total amount of credits available for this benefit pool. */
+    /**
+     * Total amount of credits available for this benefit pool.
+     * @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`. */
+    /**
+     * The external system that is the source of the pool creation. For example, `wix-pricing-plans`, `wix-loyalty`.
+     * @minLength 1
+     * @maxLength 50
+     */
     namespace?: string | null;
 }
 export declare enum BalanceType {
@@ -105,20 +122,38 @@ export declare enum BalanceType {
     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 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;
 }
 /** @oneof */
 export interface CommonIdentificationDataIdOneOf {
-    /** 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;
 }
 export declare enum IdentityType {
@@ -157,29 +192,37 @@ export interface TransactionDetails {
     /**
      * Reason for the transaction. For example, `Redemption` or `Manual adjustment`.
      * @readonly
+     * @maxLength 256
      */
     reason?: string | null;
 }
 export interface Item {
     /**
      * Item ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
     /**
      * External item ID.
+     * @format GUID
      * @readonly
      */
     externalId?: string | null;
     /**
      * Item category. Distinguishes between different types of items. For example, `posts`, `groups`, `events`.
+     * @maxLength 20
      * @readonly
      */
     category?: string | null;
-    /** @readonly */
+    /**
+     * @format GUID
+     * @readonly
+     */
     itemSetId?: string | null;
     /**
      * Item display name.
+     * @maxLength 64
      * @readonly
      */
     displayName?: string | null;
@@ -204,7 +247,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 +265,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 +279,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 +316,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 +340,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 {
@@ -316,6 +377,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 +387,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,13 +402,17 @@ 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;
 }
@@ -367,9 +436,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 +520,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 +536,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.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":";;;AAoHA,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;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,8BAA8B;IAC9B,wCAAmB,CAAA;IACnB,6BAA6B;IAC7B,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"}