@wix/auto_sdk_benefit-programs_program-definitions 1.0.52 → 1.0.54

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.
Files changed (42) hide show
  1. package/build/cjs/index.js +2 -4
  2. package/build/cjs/index.js.map +1 -1
  3. package/build/cjs/index.typings.d.ts +1 -9
  4. package/build/cjs/index.typings.js +1 -3
  5. package/build/cjs/index.typings.js.map +1 -1
  6. package/build/cjs/meta.js.map +1 -1
  7. package/build/es/index.mjs +2 -4
  8. package/build/es/index.mjs.map +1 -1
  9. package/build/es/index.typings.d.mts +1 -9
  10. package/build/es/index.typings.mjs +1 -3
  11. package/build/es/index.typings.mjs.map +1 -1
  12. package/build/es/meta.mjs.map +1 -1
  13. package/build/internal/cjs/index.typings.d.ts +39 -9
  14. package/build/internal/cjs/meta.d.ts +72 -0
  15. package/build/internal/es/index.typings.d.mts +39 -9
  16. package/build/internal/es/meta.d.mts +72 -0
  17. package/package.json +5 -12
  18. package/build/cjs/schemas.d.ts +0 -203
  19. package/build/cjs/schemas.js +0 -394
  20. package/build/cjs/schemas.js.map +0 -1
  21. package/build/es/schemas.d.mts +0 -203
  22. package/build/es/schemas.mjs +0 -346
  23. package/build/es/schemas.mjs.map +0 -1
  24. package/build/internal/cjs/index.js +0 -677
  25. package/build/internal/cjs/index.js.map +0 -1
  26. package/build/internal/cjs/index.typings.js +0 -603
  27. package/build/internal/cjs/index.typings.js.map +0 -1
  28. package/build/internal/cjs/meta.js +0 -495
  29. package/build/internal/cjs/meta.js.map +0 -1
  30. package/build/internal/cjs/schemas.d.ts +0 -203
  31. package/build/internal/cjs/schemas.js +0 -394
  32. package/build/internal/cjs/schemas.js.map +0 -1
  33. package/build/internal/es/index.mjs +0 -644
  34. package/build/internal/es/index.mjs.map +0 -1
  35. package/build/internal/es/index.typings.mjs +0 -569
  36. package/build/internal/es/index.typings.mjs.map +0 -1
  37. package/build/internal/es/meta.mjs +0 -460
  38. package/build/internal/es/meta.mjs.map +0 -1
  39. package/build/internal/es/schemas.d.mts +0 -203
  40. package/build/internal/es/schemas.mjs +0 -346
  41. package/build/internal/es/schemas.mjs.map +0 -1
  42. package/schemas/package.json +0 -3
@@ -105,6 +105,11 @@ interface CreateProgramDefinitionResponse {
105
105
  interface UpdateProgramDefinitionRequest {
106
106
  /** Program definition to update. */
107
107
  programDefinition: ProgramDefinition;
108
+ /**
109
+ * Explicit list of fields to update.
110
+ * @internal
111
+ */
112
+ fieldMask?: string[];
108
113
  }
109
114
  interface UpdateProgramDefinitionResponse {
110
115
  /** Updated program definition. */
@@ -197,6 +202,20 @@ interface Sorting {
197
202
  * Default: `ASC`
198
203
  */
199
204
  order?: SortOrderWithLiterals;
205
+ /**
206
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
207
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
208
+ *
209
+ * If multiple filters are provided, they are combined with AND operator.
210
+ *
211
+ * Example:
212
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
213
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
214
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
215
+ * @internal
216
+ * @maxSize 10
217
+ */
218
+ selectItemsBy?: Record<string, any>[] | null;
200
219
  }
201
220
  declare enum SortOrder {
202
221
  /** Ascending sort order. */
@@ -255,6 +274,11 @@ interface Cursors {
255
274
  interface UpsertProgramDefinitionRequest {
256
275
  /** Program definition to be created or updated. */
257
276
  programDefinition?: ProgramDefinition;
277
+ /**
278
+ * Explicit list of fields to update
279
+ * @internal
280
+ */
281
+ fieldMask?: string[];
258
282
  }
259
283
  interface UpsertProgramDefinitionResponse {
260
284
  /** Created or updated program definition. */
@@ -625,10 +649,6 @@ interface ProgramDefinitionsQueryBuilder {
625
649
  * @param string - String to compare against. Case-insensitive.
626
650
  */
627
651
  startsWith: (propertyName: '_id' | 'namespace' | 'externalId', value: string) => ProgramDefinitionsQueryBuilder;
628
- /** @param propertyName - Property whose value is compared with `values`.
629
- * @param values - List of values to compare against.
630
- */
631
- hasSome: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any[]) => ProgramDefinitionsQueryBuilder;
632
652
  in: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any) => ProgramDefinitionsQueryBuilder;
633
653
  exists: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: boolean) => ProgramDefinitionsQueryBuilder;
634
654
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -699,14 +719,24 @@ type ProgramDefinitionQuery = {
699
719
  Default: `ASC`
700
720
  */
701
721
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
722
+ /**
723
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
724
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
725
+
726
+ If multiple filters are provided, they are combined with AND operator.
727
+
728
+ Example:
729
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
730
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
731
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
732
+ @internal: undefined,
733
+ @maxSize: 10
734
+ */
735
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
702
736
  }[];
703
737
  };
704
738
  declare const utils: {
705
- query: {
706
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<ProgramDefinition, ProgramDefinitionQuerySpec, ProgramDefinitionQuery>;
707
- Filter: _wix_sdk_types.FilterFactory<ProgramDefinition, ProgramDefinitionQuerySpec>;
708
- Sort: _wix_sdk_types.SortFactory<ProgramDefinitionQuerySpec>;
709
- };
739
+ query: _wix_sdk_types.QueryHelpers<ProgramDefinition, ProgramDefinitionQuerySpec, ProgramDefinitionQuery>;
710
740
  };
711
741
 
712
742
  export { type AccountInfo, type ActionEvent, Cascade, type CascadeWithLiterals, type CommonQueryWithEntityContext, type CreateProgramDefinitionRequest, type CreateProgramDefinitionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteProgramDefinitionOptions, type DeleteProgramDefinitionRequest, type DeleteProgramDefinitionResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetOrCreateProgramDefinitionRequest, type GetOrCreateProgramDefinitionResponse, type GetProgramDefinitionByExternalIdAndNamespaceOptions, type GetProgramDefinitionByExternalIdAndNamespaceRequest, type GetProgramDefinitionByExternalIdAndNamespaceResponse, type GetProgramDefinitionRequest, type GetProgramDefinitionResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type ProgramDefinition, type ProgramDefinitionQuery, type ProgramDefinitionQuerySpec, type ProgramDefinitionTranslated, type ProgramDefinitionTranslationDeleted, type ProgramDefinitionsQueryBuilder, type ProgramDefinitionsQueryResult, type QueryProgramDefinitionsRequest, type QueryProgramDefinitionsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type UpdateProgramDefinition, type UpdateProgramDefinitionRequest, type UpdateProgramDefinitionResponse, type UpsertProgramDefinitionRequest, type UpsertProgramDefinitionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createProgramDefinition, deleteProgramDefinition, getProgramDefinition, getProgramDefinitionByExternalIdAndNamespace, queryProgramDefinitions, typedQueryProgramDefinitions, updateProgramDefinition, utils };
@@ -32,6 +32,12 @@ interface ProgramDefinition {
32
32
  * @maxLength 64
33
33
  */
34
34
  displayName?: string | null;
35
+ /**
36
+ * Program definition description.
37
+ * @internal
38
+ * @maxLength 450
39
+ */
40
+ description?: string | null;
35
41
  /**
36
42
  * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
37
43
  * @immutable
@@ -99,6 +105,11 @@ interface CreateProgramDefinitionResponse {
99
105
  interface UpdateProgramDefinitionRequest {
100
106
  /** Program definition to update. */
101
107
  programDefinition: ProgramDefinition;
108
+ /**
109
+ * Explicit list of fields to update.
110
+ * @internal
111
+ */
112
+ fieldMask?: string[];
102
113
  }
103
114
  interface UpdateProgramDefinitionResponse {
104
115
  /** Updated program definition. */
@@ -191,6 +202,20 @@ interface Sorting {
191
202
  * Default: `ASC`
192
203
  */
193
204
  order?: SortOrderWithLiterals;
205
+ /**
206
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
207
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
208
+ *
209
+ * If multiple filters are provided, they are combined with AND operator.
210
+ *
211
+ * Example:
212
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
213
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
214
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
215
+ * @internal
216
+ * @maxSize 10
217
+ */
218
+ selectItemsBy?: Record<string, any>[] | null;
194
219
  }
195
220
  declare enum SortOrder {
196
221
  /** Ascending sort order. */
@@ -249,6 +274,11 @@ interface Cursors {
249
274
  interface UpsertProgramDefinitionRequest {
250
275
  /** Program definition to be created or updated. */
251
276
  programDefinition?: ProgramDefinition;
277
+ /**
278
+ * Explicit list of fields to update
279
+ * @internal
280
+ */
281
+ fieldMask?: string[];
252
282
  }
253
283
  interface UpsertProgramDefinitionResponse {
254
284
  /** Created or updated program definition. */
@@ -314,8 +344,18 @@ interface DomainEventBodyOneOf {
314
344
  }
315
345
  interface EntityCreatedEvent {
316
346
  entityAsJson?: string;
347
+ /**
348
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
349
+ * @internal
350
+ */
351
+ triggeredByUndelete?: boolean | null;
317
352
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
318
353
  restoreInfo?: RestoreInfo;
354
+ /**
355
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
356
+ * @internal
357
+ */
358
+ additionalMetadataAsJson?: string | null;
319
359
  }
320
360
  interface RestoreInfo {
321
361
  deletedDate?: Date | null;
@@ -327,10 +367,42 @@ interface EntityUpdatedEvent {
327
367
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
328
368
  */
329
369
  currentEntityAsJson?: string;
370
+ /**
371
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
372
+ * wont populate it / have any reference to it in the API.
373
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
374
+ * the developer should send only the new (current) entity.
375
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
376
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
377
+ * @internal
378
+ * @deprecated
379
+ */
380
+ previousEntityAsJson?: string | null;
381
+ /**
382
+ * Map of fully qualified field paths to their previous values for fields that changed.
383
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
384
+ * @internal
385
+ */
386
+ modifiedFields?: Record<string, any>;
387
+ /**
388
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
389
+ * @internal
390
+ */
391
+ additionalMetadataAsJson?: string | null;
330
392
  }
331
393
  interface EntityDeletedEvent {
394
+ /**
395
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
396
+ * @internal
397
+ */
398
+ movedToTrash?: boolean | null;
332
399
  /** Entity that was deleted. */
333
400
  deletedEntityAsJson?: string | null;
401
+ /**
402
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
403
+ * @internal
404
+ */
405
+ additionalMetadataAsJson?: string | null;
334
406
  }
335
407
  interface ActionEvent {
336
408
  bodyAsJson?: string;
@@ -105,6 +105,11 @@ interface CreateProgramDefinitionResponse {
105
105
  interface UpdateProgramDefinitionRequest {
106
106
  /** Program definition to update. */
107
107
  programDefinition: ProgramDefinition;
108
+ /**
109
+ * Explicit list of fields to update.
110
+ * @internal
111
+ */
112
+ fieldMask?: string[];
108
113
  }
109
114
  interface UpdateProgramDefinitionResponse {
110
115
  /** Updated program definition. */
@@ -197,6 +202,20 @@ interface Sorting {
197
202
  * Default: `ASC`
198
203
  */
199
204
  order?: SortOrderWithLiterals;
205
+ /**
206
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
207
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
208
+ *
209
+ * If multiple filters are provided, they are combined with AND operator.
210
+ *
211
+ * Example:
212
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
213
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
214
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
215
+ * @internal
216
+ * @maxSize 10
217
+ */
218
+ selectItemsBy?: Record<string, any>[] | null;
200
219
  }
201
220
  declare enum SortOrder {
202
221
  /** Ascending sort order. */
@@ -255,6 +274,11 @@ interface Cursors {
255
274
  interface UpsertProgramDefinitionRequest {
256
275
  /** Program definition to be created or updated. */
257
276
  programDefinition?: ProgramDefinition;
277
+ /**
278
+ * Explicit list of fields to update
279
+ * @internal
280
+ */
281
+ fieldMask?: string[];
258
282
  }
259
283
  interface UpsertProgramDefinitionResponse {
260
284
  /** Created or updated program definition. */
@@ -625,10 +649,6 @@ interface ProgramDefinitionsQueryBuilder {
625
649
  * @param string - String to compare against. Case-insensitive.
626
650
  */
627
651
  startsWith: (propertyName: '_id' | 'namespace' | 'externalId', value: string) => ProgramDefinitionsQueryBuilder;
628
- /** @param propertyName - Property whose value is compared with `values`.
629
- * @param values - List of values to compare against.
630
- */
631
- hasSome: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any[]) => ProgramDefinitionsQueryBuilder;
632
652
  in: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: any) => ProgramDefinitionsQueryBuilder;
633
653
  exists: (propertyName: '_id' | '_createdDate' | 'namespace' | 'externalId', value: boolean) => ProgramDefinitionsQueryBuilder;
634
654
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -699,14 +719,24 @@ type ProgramDefinitionQuery = {
699
719
  Default: `ASC`
700
720
  */
701
721
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
722
+ /**
723
+ When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
724
+ a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
725
+
726
+ If multiple filters are provided, they are combined with AND operator.
727
+
728
+ Example:
729
+ Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
730
+ and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
731
+ { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
732
+ @internal: undefined,
733
+ @maxSize: 10
734
+ */
735
+ selectItemsBy?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['selectItemsBy'] | null;
702
736
  }[];
703
737
  };
704
738
  declare const utils: {
705
- query: {
706
- QueryBuilder: () => _wix_sdk_types.QueryBuilder<ProgramDefinition, ProgramDefinitionQuerySpec, ProgramDefinitionQuery>;
707
- Filter: _wix_sdk_types.FilterFactory<ProgramDefinition, ProgramDefinitionQuerySpec>;
708
- Sort: _wix_sdk_types.SortFactory<ProgramDefinitionQuerySpec>;
709
- };
739
+ query: _wix_sdk_types.QueryHelpers<ProgramDefinition, ProgramDefinitionQuerySpec, ProgramDefinitionQuery>;
710
740
  };
711
741
 
712
742
  export { type AccountInfo, type ActionEvent, Cascade, type CascadeWithLiterals, type CommonQueryWithEntityContext, type CreateProgramDefinitionRequest, type CreateProgramDefinitionResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteProgramDefinitionOptions, type DeleteProgramDefinitionRequest, type DeleteProgramDefinitionResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetOrCreateProgramDefinitionRequest, type GetOrCreateProgramDefinitionResponse, type GetProgramDefinitionByExternalIdAndNamespaceOptions, type GetProgramDefinitionByExternalIdAndNamespaceRequest, type GetProgramDefinitionByExternalIdAndNamespaceResponse, type GetProgramDefinitionRequest, type GetProgramDefinitionResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type ProgramDefinition, type ProgramDefinitionQuery, type ProgramDefinitionQuerySpec, type ProgramDefinitionTranslated, type ProgramDefinitionTranslationDeleted, type ProgramDefinitionsQueryBuilder, type ProgramDefinitionsQueryResult, type QueryProgramDefinitionsRequest, type QueryProgramDefinitionsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type UpdateProgramDefinition, type UpdateProgramDefinitionRequest, type UpdateProgramDefinitionResponse, type UpsertProgramDefinitionRequest, type UpsertProgramDefinitionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createProgramDefinition, deleteProgramDefinition, getProgramDefinition, getProgramDefinitionByExternalIdAndNamespace, queryProgramDefinitions, typedQueryProgramDefinitions, updateProgramDefinition, utils };
@@ -32,6 +32,12 @@ interface ProgramDefinition {
32
32
  * @maxLength 64
33
33
  */
34
34
  displayName?: string | null;
35
+ /**
36
+ * Program definition description.
37
+ * @internal
38
+ * @maxLength 450
39
+ */
40
+ description?: string | null;
35
41
  /**
36
42
  * Namespace for your app or site's benefit programs. Namespaces allow you to distinguish between entities that you created and entities that other apps created.
37
43
  * @immutable
@@ -99,6 +105,11 @@ interface CreateProgramDefinitionResponse {
99
105
  interface UpdateProgramDefinitionRequest {
100
106
  /** Program definition to update. */
101
107
  programDefinition: ProgramDefinition;
108
+ /**
109
+ * Explicit list of fields to update.
110
+ * @internal
111
+ */
112
+ fieldMask?: string[];
102
113
  }
103
114
  interface UpdateProgramDefinitionResponse {
104
115
  /** Updated program definition. */
@@ -191,6 +202,20 @@ interface Sorting {
191
202
  * Default: `ASC`
192
203
  */
193
204
  order?: SortOrderWithLiterals;
205
+ /**
206
+ * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
207
+ * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
208
+ *
209
+ * If multiple filters are provided, they are combined with AND operator.
210
+ *
211
+ * Example:
212
+ * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
213
+ * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
214
+ * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
215
+ * @internal
216
+ * @maxSize 10
217
+ */
218
+ selectItemsBy?: Record<string, any>[] | null;
194
219
  }
195
220
  declare enum SortOrder {
196
221
  /** Ascending sort order. */
@@ -249,6 +274,11 @@ interface Cursors {
249
274
  interface UpsertProgramDefinitionRequest {
250
275
  /** Program definition to be created or updated. */
251
276
  programDefinition?: ProgramDefinition;
277
+ /**
278
+ * Explicit list of fields to update
279
+ * @internal
280
+ */
281
+ fieldMask?: string[];
252
282
  }
253
283
  interface UpsertProgramDefinitionResponse {
254
284
  /** Created or updated program definition. */
@@ -314,8 +344,18 @@ interface DomainEventBodyOneOf {
314
344
  }
315
345
  interface EntityCreatedEvent {
316
346
  entityAsJson?: string;
347
+ /**
348
+ * Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
349
+ * @internal
350
+ */
351
+ triggeredByUndelete?: boolean | null;
317
352
  /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
318
353
  restoreInfo?: RestoreInfo;
354
+ /**
355
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
356
+ * @internal
357
+ */
358
+ additionalMetadataAsJson?: string | null;
319
359
  }
320
360
  interface RestoreInfo {
321
361
  deletedDate?: Date | null;
@@ -327,10 +367,42 @@ interface EntityUpdatedEvent {
327
367
  * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
328
368
  */
329
369
  currentEntityAsJson?: string;
370
+ /**
371
+ * This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
372
+ * wont populate it / have any reference to it in the API.
373
+ * The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
374
+ * the developer should send only the new (current) entity.
375
+ * An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
376
+ * Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
377
+ * @internal
378
+ * @deprecated
379
+ */
380
+ previousEntityAsJson?: string | null;
381
+ /**
382
+ * Map of fully qualified field paths to their previous values for fields that changed.
383
+ * For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
384
+ * @internal
385
+ */
386
+ modifiedFields?: Record<string, any>;
387
+ /**
388
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
389
+ * @internal
390
+ */
391
+ additionalMetadataAsJson?: string | null;
330
392
  }
331
393
  interface EntityDeletedEvent {
394
+ /**
395
+ * Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
396
+ * @internal
397
+ */
398
+ movedToTrash?: boolean | null;
332
399
  /** Entity that was deleted. */
333
400
  deletedEntityAsJson?: string | null;
401
+ /**
402
+ * Optional domain-specific metadata defined by the API owner, encoded as JSON.
403
+ * @internal
404
+ */
405
+ additionalMetadataAsJson?: string | null;
334
406
  }
335
407
  interface ActionEvent {
336
408
  bodyAsJson?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_benefit-programs_program-definitions",
3
- "version": "1.0.52",
3
+ "version": "1.0.54",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -21,23 +21,16 @@
21
21
  "import": "./build/es/meta.mjs",
22
22
  "require": "./build/cjs/meta.js",
23
23
  "types": "./build/es/meta.d.mts"
24
- },
25
- "./schemas": {
26
- "import": "./build/es/schemas.mjs",
27
- "require": "./build/cjs/schemas.js",
28
- "types": "./build/es/schemas.d.mts"
29
24
  }
30
25
  },
31
26
  "files": [
32
27
  "build",
33
28
  "meta",
34
- "service-plugins",
35
- "schemas"
29
+ "service-plugins"
36
30
  ],
37
31
  "dependencies": {
38
- "@wix/sdk-runtime": "^1.0.12",
39
- "@wix/sdk-types": "^1.17.7",
40
- "zod": "^4.3.6"
32
+ "@wix/sdk-runtime": "^1.0.24",
33
+ "@wix/sdk-types": "^1.17.11"
41
34
  },
42
35
  "devDependencies": {
43
36
  "tsup": "^8.4.0",
@@ -57,5 +50,5 @@
57
50
  "fqdn": "wix.benefit_programs.v1.program_definition"
58
51
  }
59
52
  },
60
- "falconPackageHash": "1252b6b8059c1722d14ddc3a7bb2bf78cd56f4d51bcf5f3da636cf58"
53
+ "falconPackageHash": "de8297275b0fa19bb4cbdfac8c3724873c1a1db23ed178d3026405da"
61
54
  }
@@ -1,203 +0,0 @@
1
- import * as z from 'zod';
2
-
3
- declare const CreateProgramDefinitionRequest: z.ZodObject<{
4
- programDefinition: z.ZodObject<{
5
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
6
- revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
7
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
8
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
9
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
10
- namespace: z.ZodString;
11
- extendedFields: z.ZodOptional<z.ZodObject<{
12
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
13
- }, z.core.$strip>>;
14
- externalId: z.ZodString;
15
- }, z.core.$strip>;
16
- }, z.core.$strip>;
17
- declare const CreateProgramDefinitionResponse: z.ZodObject<{
18
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
19
- revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
20
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
21
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
22
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
23
- namespace: z.ZodNullable<z.ZodOptional<z.ZodString>>;
24
- extendedFields: z.ZodOptional<z.ZodObject<{
25
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
26
- }, z.core.$strip>>;
27
- externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
28
- }, z.core.$strip>;
29
- declare const UpdateProgramDefinitionRequest: z.ZodObject<{
30
- _id: z.ZodString;
31
- programDefinition: z.ZodObject<{
32
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
33
- revision: z.ZodString;
34
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
35
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
36
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
37
- namespace: z.ZodNullable<z.ZodOptional<z.ZodString>>;
38
- extendedFields: z.ZodOptional<z.ZodObject<{
39
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
40
- }, z.core.$strip>>;
41
- externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
42
- }, z.core.$strip>;
43
- }, z.core.$strip>;
44
- declare const UpdateProgramDefinitionResponse: z.ZodObject<{
45
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
46
- revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
47
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
48
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
49
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
50
- namespace: z.ZodNullable<z.ZodOptional<z.ZodString>>;
51
- extendedFields: z.ZodOptional<z.ZodObject<{
52
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
53
- }, z.core.$strip>>;
54
- externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
55
- }, z.core.$strip>;
56
- declare const DeleteProgramDefinitionRequest: z.ZodObject<{
57
- programDefinitionId: z.ZodString;
58
- options: z.ZodOptional<z.ZodObject<{
59
- cascadeType: z.ZodOptional<z.ZodEnum<{
60
- UNKNOWN_CASCADE: "UNKNOWN_CASCADE";
61
- NEXT_RENEWAL: "NEXT_RENEWAL";
62
- IMMEDIATELY: "IMMEDIATELY";
63
- FUTURE_PROVISIONS: "FUTURE_PROVISIONS";
64
- }>>;
65
- }, z.core.$strip>>;
66
- }, z.core.$strip>;
67
- declare const DeleteProgramDefinitionResponse: z.ZodObject<{}, z.core.$strip>;
68
- declare const GetProgramDefinitionRequest: z.ZodObject<{
69
- programDefinitionId: z.ZodString;
70
- }, z.core.$strip>;
71
- declare const GetProgramDefinitionResponse: z.ZodObject<{
72
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
73
- revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
74
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
75
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
76
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
77
- namespace: z.ZodNullable<z.ZodOptional<z.ZodString>>;
78
- extendedFields: z.ZodOptional<z.ZodObject<{
79
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
80
- }, z.core.$strip>>;
81
- externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
82
- }, z.core.$strip>;
83
- declare const GetProgramDefinitionByExternalIdAndNamespaceRequest: z.ZodObject<{
84
- namespace: z.ZodString;
85
- options: z.ZodObject<{
86
- externalId: z.ZodString;
87
- }, z.core.$strip>;
88
- }, z.core.$strip>;
89
- declare const GetProgramDefinitionByExternalIdAndNamespaceResponse: z.ZodObject<{
90
- programDefinition: z.ZodOptional<z.ZodObject<{
91
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
92
- revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
93
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
94
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
95
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
96
- namespace: z.ZodNullable<z.ZodOptional<z.ZodString>>;
97
- extendedFields: z.ZodOptional<z.ZodObject<{
98
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
99
- }, z.core.$strip>>;
100
- externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
101
- }, z.core.$strip>>;
102
- }, z.core.$strip>;
103
- declare const QueryProgramDefinitionsRequest: z.ZodObject<{
104
- query: z.ZodObject<{
105
- filter: z.ZodOptional<z.ZodObject<{
106
- _id: z.ZodOptional<z.ZodObject<{
107
- $eq: z.ZodOptional<z.ZodString>;
108
- $exists: z.ZodOptional<z.ZodBoolean>;
109
- $gt: z.ZodOptional<z.ZodString>;
110
- $gte: z.ZodOptional<z.ZodString>;
111
- $hasAll: z.ZodOptional<z.ZodArray<z.ZodString>>;
112
- $hasSome: z.ZodOptional<z.ZodArray<z.ZodString>>;
113
- $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
114
- $lt: z.ZodOptional<z.ZodString>;
115
- $lte: z.ZodOptional<z.ZodString>;
116
- $ne: z.ZodOptional<z.ZodString>;
117
- $nin: z.ZodOptional<z.ZodArray<z.ZodString>>;
118
- $startsWith: z.ZodOptional<z.ZodString>;
119
- }, z.core.$strict>>;
120
- namespace: z.ZodOptional<z.ZodObject<{
121
- $eq: z.ZodOptional<z.ZodString>;
122
- $exists: z.ZodOptional<z.ZodBoolean>;
123
- $gt: z.ZodOptional<z.ZodString>;
124
- $gte: z.ZodOptional<z.ZodString>;
125
- $hasAll: z.ZodOptional<z.ZodArray<z.ZodString>>;
126
- $hasSome: z.ZodOptional<z.ZodArray<z.ZodString>>;
127
- $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
128
- $lt: z.ZodOptional<z.ZodString>;
129
- $lte: z.ZodOptional<z.ZodString>;
130
- $ne: z.ZodOptional<z.ZodString>;
131
- $nin: z.ZodOptional<z.ZodArray<z.ZodString>>;
132
- $startsWith: z.ZodOptional<z.ZodString>;
133
- }, z.core.$strict>>;
134
- externalId: z.ZodOptional<z.ZodObject<{
135
- $eq: z.ZodOptional<z.ZodString>;
136
- $exists: z.ZodOptional<z.ZodBoolean>;
137
- $gt: z.ZodOptional<z.ZodString>;
138
- $gte: z.ZodOptional<z.ZodString>;
139
- $hasAll: z.ZodOptional<z.ZodArray<z.ZodString>>;
140
- $hasSome: z.ZodOptional<z.ZodArray<z.ZodString>>;
141
- $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
142
- $lt: z.ZodOptional<z.ZodString>;
143
- $lte: z.ZodOptional<z.ZodString>;
144
- $ne: z.ZodOptional<z.ZodString>;
145
- $nin: z.ZodOptional<z.ZodArray<z.ZodString>>;
146
- $startsWith: z.ZodOptional<z.ZodString>;
147
- }, z.core.$strict>>;
148
- _createdDate: z.ZodOptional<z.ZodObject<{
149
- $eq: z.ZodOptional<z.ZodString>;
150
- $exists: z.ZodOptional<z.ZodBoolean>;
151
- $gt: z.ZodOptional<z.ZodString>;
152
- $gte: z.ZodOptional<z.ZodString>;
153
- $hasAll: z.ZodOptional<z.ZodArray<z.ZodString>>;
154
- $hasSome: z.ZodOptional<z.ZodArray<z.ZodString>>;
155
- $in: z.ZodOptional<z.ZodArray<z.ZodString>>;
156
- $lt: z.ZodOptional<z.ZodString>;
157
- $lte: z.ZodOptional<z.ZodString>;
158
- $ne: z.ZodOptional<z.ZodString>;
159
- $nin: z.ZodOptional<z.ZodArray<z.ZodString>>;
160
- $startsWith: z.ZodOptional<z.ZodString>;
161
- }, z.core.$strict>>;
162
- $and: z.ZodOptional<z.ZodArray<z.ZodAny>>;
163
- $or: z.ZodOptional<z.ZodArray<z.ZodAny>>;
164
- $not: z.ZodOptional<z.ZodAny>;
165
- }, z.core.$strict>>;
166
- sort: z.ZodOptional<z.ZodArray<z.ZodObject<{
167
- fieldName: z.ZodOptional<z.ZodEnum<{
168
- externalId: "externalId";
169
- namespace: "namespace";
170
- _id: "_id";
171
- _createdDate: "_createdDate";
172
- }>>;
173
- order: z.ZodOptional<z.ZodEnum<{
174
- ASC: "ASC";
175
- DESC: "DESC";
176
- }>>;
177
- }, z.core.$strip>>>;
178
- }, z.core.$catchall<z.ZodAny>>;
179
- }, z.core.$strip>;
180
- declare const QueryProgramDefinitionsResponse: z.ZodObject<{
181
- programDefinitions: z.ZodOptional<z.ZodArray<z.ZodObject<{
182
- _id: z.ZodNullable<z.ZodOptional<z.ZodString>>;
183
- revision: z.ZodNullable<z.ZodOptional<z.ZodString>>;
184
- _createdDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
185
- _updatedDate: z.ZodNullable<z.ZodOptional<z.ZodDate>>;
186
- displayName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
187
- namespace: z.ZodNullable<z.ZodOptional<z.ZodString>>;
188
- extendedFields: z.ZodOptional<z.ZodObject<{
189
- namespaces: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>>>;
190
- }, z.core.$strip>>;
191
- externalId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
192
- }, z.core.$strip>>>;
193
- metadata: z.ZodOptional<z.ZodObject<{
194
- count: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
195
- cursors: z.ZodOptional<z.ZodObject<{
196
- next: z.ZodNullable<z.ZodOptional<z.ZodString>>;
197
- prev: z.ZodNullable<z.ZodOptional<z.ZodString>>;
198
- }, z.core.$strip>>;
199
- hasNext: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
200
- }, z.core.$strip>>;
201
- }, z.core.$strip>;
202
-
203
- export { CreateProgramDefinitionRequest, CreateProgramDefinitionResponse, DeleteProgramDefinitionRequest, DeleteProgramDefinitionResponse, GetProgramDefinitionByExternalIdAndNamespaceRequest, GetProgramDefinitionByExternalIdAndNamespaceResponse, GetProgramDefinitionRequest, GetProgramDefinitionResponse, QueryProgramDefinitionsRequest, QueryProgramDefinitionsResponse, UpdateProgramDefinitionRequest, UpdateProgramDefinitionResponse };