@wix/auto_sdk_benefit-programs_program-definitions 1.0.3 → 1.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
@@ -133,17 +133,13 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
133
133
  /** 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`. */
134
134
  cursorPaging?: CursorPaging;
135
135
  /**
136
- * Filter object in the following format:
137
- * `"filter" : {
138
- * "fieldName1": "value1",
139
- * "fieldName2":{"$operator":"value2"}
140
- * }`
141
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
136
+ * Filter object.
137
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
138
+ * for more information.
142
139
  */
143
140
  filter?: Record<string, any> | null;
144
141
  /**
145
- * Sort object in the following format:
146
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
142
+ * List of sort objects.
147
143
  * @maxSize 5
148
144
  */
149
145
  sort?: Sorting[];
@@ -155,11 +151,15 @@ export interface CursorQueryPagingMethodOneOf {
155
151
  }
156
152
  export interface Sorting {
157
153
  /**
158
- * Name of the field to sort by.
154
+ * Field to sort by.
159
155
  * @maxLength 512
160
156
  */
161
157
  fieldName?: string;
162
- /** Sort order. */
158
+ /**
159
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
160
+ *
161
+ * Default: `ASC`
162
+ */
163
163
  order?: SortOrder;
164
164
  }
165
165
  export declare enum SortOrder {
@@ -170,7 +170,7 @@ export declare enum SortOrder {
170
170
  }
171
171
  export interface CursorPaging {
172
172
  /**
173
- * Maximum number of items to return in the results.
173
+ * Maximum number of items to return.
174
174
  * @max 100
175
175
  */
176
176
  limit?: number | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_benefit-programs_program-definitions",
3
- "version": "1.0.3",
3
+ "version": "1.0.5",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -28,8 +28,8 @@
28
28
  "service-plugins"
29
29
  ],
30
30
  "dependencies": {
31
- "@wix/sdk-runtime": "^0.3.35",
32
- "@wix/sdk-types": "^1.12.4"
31
+ "@wix/sdk-runtime": "^0.3.42",
32
+ "@wix/sdk-types": "^1.13.9"
33
33
  },
34
34
  "devDependencies": {
35
35
  "typescript": "^5.3.2"
@@ -48,5 +48,5 @@
48
48
  "fqdn": "wix.benefit_programs.v1.program_definition"
49
49
  }
50
50
  },
51
- "falconPackageHash": "aaafaa50ab0594992aa0a1f7be9340f40d8e367dbcf6f03d18859f5c"
51
+ "falconPackageHash": "18215a212ddfeea514c084fb56eaa4b7e1747879fb9e69d18d98b630"
52
52
  }