@wix/auto_sdk_benefit-programs_transactions 1.0.3 → 1.0.5

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

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

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

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

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

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

package/build/es/src/benefit-programs-v1-transaction-transactions.universal.d.ts

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

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

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

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

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

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

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

package/build/internal/es/src/benefit-programs-v1-transaction-transactions.universal.d.ts

@@ -26,7 +26,7 @@ export interface Transaction {
      */
     pool?: PoolInfo;
     /**
-     * Amount to adjust the balance in this transaction.
+     * Amount the balance was adjusted in this transaction.
      * @decimalValue options { gte:0, maxScale:4 }
      */
     amount?: string;
@@ -85,7 +85,7 @@ export interface PoolInfo {
      */
     poolDefinitionId?: string | null;
     /**
-     * ID of the program definition the pool was created from.
+     * ID of the program definition containing the pool definition the pool was created from.
      * @format GUID
      * @readonly
      */
@@ -360,17 +360,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
+     * for more information.
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * List of sort objects.
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -382,11 +378,15 @@ export interface CursorQueryPagingMethodOneOf {
 }
 export interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrder;
 }
 export declare enum SortOrder {
@@ -397,7 +397,7 @@ export declare enum SortOrder {
 }
 export interface CursorPaging {
     /**
-     * Maximum number of items to return in the results.
+     * Maximum number of items to return.
      * @max 100
      */
     limit?: number | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/auto_sdk_benefit-programs_transactions",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -28,8 +28,8 @@
     "service-plugins"
   ],
   "dependencies": {
-    "@wix/sdk-runtime": "^0.3.35",
-    "@wix/sdk-types": "^1.12.4"
+    "@wix/sdk-runtime": "^0.3.42",
+    "@wix/sdk-types": "^1.13.9"
   },
   "devDependencies": {
     "typescript": "^5.3.2"
@@ -48,5 +48,5 @@
       "fqdn": "wix.benefit_programs.v1.transaction"
     }
   },
-  "falconPackageHash": "364098fef34207729b12045ce07360b5af952c871e915912e55e111a"
+  "falconPackageHash": "ec037ae06ffa1c0eaed711b6d09210dee6c978440fad10a565c6bf67"
 }