@deliverart/sdk-js-email-notification-configuration 2.13.0 → 2.13.2

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.
package/README.md CHANGED
@@ -25,6 +25,9 @@ Available email template keys:
25
25
  - `order_delivered` - Notification when order is delivered
26
26
  - `order_in_preparation` - Notification when order enters preparation
27
27
  - `order_preparation_done` - Notification when order preparation is complete
28
+ - `subscription_expiring` - Reminder when a time-based subscription is close to expiration
29
+ - `subscription_low_credits` - Reminder when a consumption subscription is low on credits
30
+ - `subscription_pending_renewal` - Reminder when a subscription has a pending renewal
28
31
 
29
32
  ### Order Sources
30
33
  Configuration supports the following order sources:
@@ -37,18 +40,26 @@ Configuration supports the following order sources:
37
40
 
38
41
  ## Configuration Structure
39
42
 
40
- Each email notification configuration contains a `config` object with template-specific settings. The configuration structure is designed to be extensible for future template-specific fields.
43
+ Each email notification configuration contains a `config` object with template-specific settings. The structure depends on the template key.
41
44
 
42
45
  ### Config Object
43
46
 
47
+ Order and delivery templates use:
48
+
44
49
  ```typescript
45
50
  {
46
- sourcesEnabled: string[] // Array of enabled order sources
51
+ sourcesEnabled: string[]
47
52
  }
48
53
  ```
49
54
 
55
+ Subscription reminder templates use:
56
+
57
+ ```typescript
58
+ {}
59
+ ```
60
+
50
61
  **Fields:**
51
- - `sourcesEnabled?: string[]` - Array of order sources for which the notification should be sent
62
+ - `sourcesEnabled?: string[]` - Array of order sources for which the notification should be sent on order and delivery templates
52
63
 
53
64
  ## Available Requests
54
65
 
@@ -66,6 +77,17 @@ const config = await sdk.call(new CreateEmailNotificationConfiguration({
66
77
  }));
67
78
  ```
68
79
 
80
+ Subscription reminder example:
81
+
82
+ ```typescript
83
+ const config = await sdk.call(new CreateEmailNotificationConfiguration({
84
+ pointOfSale: '/point_of_sales/123',
85
+ templateKey: 'subscription_low_credits',
86
+ isActive: true,
87
+ config: {}
88
+ }));
89
+ ```
90
+
69
91
  **Input Parameters:**
70
92
  - `pointOfSale: string` (required) - Point of sale IRI
71
93
  - `templateKey: string` (required) - Email template key
@@ -125,7 +147,8 @@ const updated = await sdk.call(new UpdateEmailNotificationConfiguration('config-
125
147
  - `templateKey: string` (required) - Email template key
126
148
  - `isActive: boolean` (required) - Enable/disable notification
127
149
  - `config: object` (required) - Configuration object
128
- - `sourcesEnabled: string[]` - Array of enabled order sources
150
+ - order/delivery templates: `sourcesEnabled: string[]`
151
+ - subscription reminder templates: empty object `{}`
129
152
 
130
153
  ---
131
154
 
package/dist/index.cjs CHANGED
@@ -36,6 +36,7 @@ __export(index_exports, {
36
36
  emailNotificationConfigurationSchema: () => emailNotificationConfigurationSchema,
37
37
  emailNotificationConfigurationSchemaListItem: () => emailNotificationConfigurationSchemaListItem,
38
38
  emailNotificationConfigurationsQuerySchema: () => emailNotificationConfigurationsQuerySchema,
39
+ emptyEmailNotificationConfigurationConfigSchema: () => emptyEmailNotificationConfigurationConfigSchema,
39
40
  getEmailNotificationConfigurationDetailsInputSchema: () => getEmailNotificationConfigurationDetailsInputSchema,
40
41
  getEmailNotificationConfigurationDetailsResponseSchema: () => getEmailNotificationConfigurationDetailsResponseSchema,
41
42
  getEmailNotificationConfigurationsFromPointOfSaleInputSchema: () => getEmailNotificationConfigurationsFromPointOfSaleInputSchema,
@@ -44,6 +45,7 @@ __export(index_exports, {
44
45
  getEmailNotificationConfigurationsInputSchema: () => getEmailNotificationConfigurationsInputSchema,
45
46
  getEmailNotificationConfigurationsQuerySchema: () => getEmailNotificationConfigurationsQuerySchema,
46
47
  getEmailNotificationConfigurationsResponseSchema: () => getEmailNotificationConfigurationsResponseSchema,
48
+ orderEmailNotificationConfigurationConfigSchema: () => orderEmailNotificationConfigurationConfigSchema,
47
49
  updateEmailNotificationConfigurationInputSchema: () => updateEmailNotificationConfigurationInputSchema,
48
50
  updateEmailNotificationConfigurationResponseSchema: () => updateEmailNotificationConfigurationResponseSchema,
49
51
  writableCreateEmailNotificationConfigurationSchema: () => writableCreateEmailNotificationConfigurationSchema,
@@ -13824,15 +13826,20 @@ function date4(params) {
13824
13826
  config(en_default());
13825
13827
 
13826
13828
  // src/models.ts
13827
- var emailNotificationConfigurationConfigSchema = external_exports.object({
13829
+ var orderEmailNotificationConfigurationConfigSchema = external_exports.object({
13828
13830
  sourcesEnabled: external_exports.array(import_sdk_js_global_types.orderSourceSchema)
13829
13831
  });
13832
+ var emptyEmailNotificationConfigurationConfigSchema = external_exports.object({});
13833
+ var emailNotificationConfigurationConfigSchema = external_exports.union([
13834
+ orderEmailNotificationConfigurationConfigSchema,
13835
+ emptyEmailNotificationConfigurationConfigSchema
13836
+ ]);
13830
13837
  var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("templateKey", [
13831
13838
  external_exports.object({
13832
13839
  id: external_exports.string(),
13833
13840
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13834
13841
  templateKey: external_exports.literal("delivery_started"),
13835
- config: emailNotificationConfigurationConfigSchema,
13842
+ config: orderEmailNotificationConfigurationConfigSchema,
13836
13843
  isActive: external_exports.boolean(),
13837
13844
  createdAt: import_sdk_js_global_types.datetimeSchema,
13838
13845
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13841,7 +13848,7 @@ var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("
13841
13848
  id: external_exports.string(),
13842
13849
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13843
13850
  templateKey: external_exports.literal("delivery_taken_over"),
13844
- config: emailNotificationConfigurationConfigSchema,
13851
+ config: orderEmailNotificationConfigurationConfigSchema,
13845
13852
  isActive: external_exports.boolean(),
13846
13853
  createdAt: import_sdk_js_global_types.datetimeSchema,
13847
13854
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13850,7 +13857,7 @@ var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("
13850
13857
  id: external_exports.string(),
13851
13858
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13852
13859
  templateKey: external_exports.literal("order_created"),
13853
- config: emailNotificationConfigurationConfigSchema,
13860
+ config: orderEmailNotificationConfigurationConfigSchema,
13854
13861
  isActive: external_exports.boolean(),
13855
13862
  createdAt: import_sdk_js_global_types.datetimeSchema,
13856
13863
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13859,7 +13866,7 @@ var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("
13859
13866
  id: external_exports.string(),
13860
13867
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13861
13868
  templateKey: external_exports.literal("order_delivered"),
13862
- config: emailNotificationConfigurationConfigSchema,
13869
+ config: orderEmailNotificationConfigurationConfigSchema,
13863
13870
  isActive: external_exports.boolean(),
13864
13871
  createdAt: import_sdk_js_global_types.datetimeSchema,
13865
13872
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13868,7 +13875,7 @@ var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("
13868
13875
  id: external_exports.string(),
13869
13876
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13870
13877
  templateKey: external_exports.literal("order_in_preparation"),
13871
- config: emailNotificationConfigurationConfigSchema,
13878
+ config: orderEmailNotificationConfigurationConfigSchema,
13872
13879
  isActive: external_exports.boolean(),
13873
13880
  createdAt: import_sdk_js_global_types.datetimeSchema,
13874
13881
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13877,7 +13884,34 @@ var emailNotificationConfigurationSchema = external_exports.discriminatedUnion("
13877
13884
  id: external_exports.string(),
13878
13885
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13879
13886
  templateKey: external_exports.literal("order_preparation_done"),
13880
- config: emailNotificationConfigurationConfigSchema,
13887
+ config: orderEmailNotificationConfigurationConfigSchema,
13888
+ isActive: external_exports.boolean(),
13889
+ createdAt: import_sdk_js_global_types.datetimeSchema,
13890
+ updatedAt: import_sdk_js_global_types.datetimeSchema
13891
+ }),
13892
+ external_exports.object({
13893
+ id: external_exports.string(),
13894
+ pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13895
+ templateKey: external_exports.literal("subscription_expiring"),
13896
+ config: emptyEmailNotificationConfigurationConfigSchema,
13897
+ isActive: external_exports.boolean(),
13898
+ createdAt: import_sdk_js_global_types.datetimeSchema,
13899
+ updatedAt: import_sdk_js_global_types.datetimeSchema
13900
+ }),
13901
+ external_exports.object({
13902
+ id: external_exports.string(),
13903
+ pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13904
+ templateKey: external_exports.literal("subscription_low_credits"),
13905
+ config: emptyEmailNotificationConfigurationConfigSchema,
13906
+ isActive: external_exports.boolean(),
13907
+ createdAt: import_sdk_js_global_types.datetimeSchema,
13908
+ updatedAt: import_sdk_js_global_types.datetimeSchema
13909
+ }),
13910
+ external_exports.object({
13911
+ id: external_exports.string(),
13912
+ pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13913
+ templateKey: external_exports.literal("subscription_pending_renewal"),
13914
+ config: emptyEmailNotificationConfigurationConfigSchema,
13881
13915
  isActive: external_exports.boolean(),
13882
13916
  createdAt: import_sdk_js_global_types.datetimeSchema,
13883
13917
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13887,7 +13921,7 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13887
13921
  external_exports.object({
13888
13922
  id: external_exports.string(),
13889
13923
  templateKey: external_exports.literal("delivery_started"),
13890
- config: emailNotificationConfigurationConfigSchema,
13924
+ config: orderEmailNotificationConfigurationConfigSchema,
13891
13925
  isActive: external_exports.boolean(),
13892
13926
  createdAt: import_sdk_js_global_types.datetimeSchema,
13893
13927
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13895,7 +13929,7 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13895
13929
  external_exports.object({
13896
13930
  id: external_exports.string(),
13897
13931
  templateKey: external_exports.literal("delivery_taken_over"),
13898
- config: emailNotificationConfigurationConfigSchema,
13932
+ config: orderEmailNotificationConfigurationConfigSchema,
13899
13933
  isActive: external_exports.boolean(),
13900
13934
  createdAt: import_sdk_js_global_types.datetimeSchema,
13901
13935
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13903,7 +13937,7 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13903
13937
  external_exports.object({
13904
13938
  id: external_exports.string(),
13905
13939
  templateKey: external_exports.literal("order_created"),
13906
- config: emailNotificationConfigurationConfigSchema,
13940
+ config: orderEmailNotificationConfigurationConfigSchema,
13907
13941
  isActive: external_exports.boolean(),
13908
13942
  createdAt: import_sdk_js_global_types.datetimeSchema,
13909
13943
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13911,7 +13945,7 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13911
13945
  external_exports.object({
13912
13946
  id: external_exports.string(),
13913
13947
  templateKey: external_exports.literal("order_delivered"),
13914
- config: emailNotificationConfigurationConfigSchema,
13948
+ config: orderEmailNotificationConfigurationConfigSchema,
13915
13949
  isActive: external_exports.boolean(),
13916
13950
  createdAt: import_sdk_js_global_types.datetimeSchema,
13917
13951
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13919,7 +13953,7 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13919
13953
  external_exports.object({
13920
13954
  id: external_exports.string(),
13921
13955
  templateKey: external_exports.literal("order_in_preparation"),
13922
- config: emailNotificationConfigurationConfigSchema,
13956
+ config: orderEmailNotificationConfigurationConfigSchema,
13923
13957
  isActive: external_exports.boolean(),
13924
13958
  createdAt: import_sdk_js_global_types.datetimeSchema,
13925
13959
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13927,7 +13961,31 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13927
13961
  external_exports.object({
13928
13962
  id: external_exports.string(),
13929
13963
  templateKey: external_exports.literal("order_preparation_done"),
13930
- config: emailNotificationConfigurationConfigSchema,
13964
+ config: orderEmailNotificationConfigurationConfigSchema,
13965
+ isActive: external_exports.boolean(),
13966
+ createdAt: import_sdk_js_global_types.datetimeSchema,
13967
+ updatedAt: import_sdk_js_global_types.datetimeSchema
13968
+ }),
13969
+ external_exports.object({
13970
+ id: external_exports.string(),
13971
+ templateKey: external_exports.literal("subscription_expiring"),
13972
+ config: emptyEmailNotificationConfigurationConfigSchema,
13973
+ isActive: external_exports.boolean(),
13974
+ createdAt: import_sdk_js_global_types.datetimeSchema,
13975
+ updatedAt: import_sdk_js_global_types.datetimeSchema
13976
+ }),
13977
+ external_exports.object({
13978
+ id: external_exports.string(),
13979
+ templateKey: external_exports.literal("subscription_low_credits"),
13980
+ config: emptyEmailNotificationConfigurationConfigSchema,
13981
+ isActive: external_exports.boolean(),
13982
+ createdAt: import_sdk_js_global_types.datetimeSchema,
13983
+ updatedAt: import_sdk_js_global_types.datetimeSchema
13984
+ }),
13985
+ external_exports.object({
13986
+ id: external_exports.string(),
13987
+ templateKey: external_exports.literal("subscription_pending_renewal"),
13988
+ config: emptyEmailNotificationConfigurationConfigSchema,
13931
13989
  isActive: external_exports.boolean(),
13932
13990
  createdAt: import_sdk_js_global_types.datetimeSchema,
13933
13991
  updatedAt: import_sdk_js_global_types.datetimeSchema
@@ -13936,32 +13994,47 @@ var emailNotificationConfigurationSchemaListItem = external_exports.discriminate
13936
13994
  var writableUpdateEmailNotificationConfigurationSchema = external_exports.union([
13937
13995
  external_exports.object({
13938
13996
  templateKey: external_exports.literal("delivery_started"),
13939
- config: emailNotificationConfigurationConfigSchema.optional(),
13997
+ config: orderEmailNotificationConfigurationConfigSchema.optional(),
13940
13998
  isActive: external_exports.boolean().optional()
13941
13999
  }),
13942
14000
  external_exports.object({
13943
14001
  templateKey: external_exports.literal("delivery_taken_over"),
13944
- config: emailNotificationConfigurationConfigSchema.optional(),
14002
+ config: orderEmailNotificationConfigurationConfigSchema.optional(),
13945
14003
  isActive: external_exports.boolean().optional()
13946
14004
  }),
13947
14005
  external_exports.object({
13948
14006
  templateKey: external_exports.literal("order_created"),
13949
- config: emailNotificationConfigurationConfigSchema.optional(),
14007
+ config: orderEmailNotificationConfigurationConfigSchema.optional(),
13950
14008
  isActive: external_exports.boolean().optional()
13951
14009
  }),
13952
14010
  external_exports.object({
13953
14011
  templateKey: external_exports.literal("order_delivered"),
13954
- config: emailNotificationConfigurationConfigSchema.optional(),
14012
+ config: orderEmailNotificationConfigurationConfigSchema.optional(),
13955
14013
  isActive: external_exports.boolean().optional()
13956
14014
  }),
13957
14015
  external_exports.object({
13958
14016
  templateKey: external_exports.literal("order_in_preparation"),
13959
- config: emailNotificationConfigurationConfigSchema.optional(),
14017
+ config: orderEmailNotificationConfigurationConfigSchema.optional(),
13960
14018
  isActive: external_exports.boolean().optional()
13961
14019
  }),
13962
14020
  external_exports.object({
13963
14021
  templateKey: external_exports.literal("order_preparation_done"),
13964
- config: emailNotificationConfigurationConfigSchema.optional(),
14022
+ config: orderEmailNotificationConfigurationConfigSchema.optional(),
14023
+ isActive: external_exports.boolean().optional()
14024
+ }),
14025
+ external_exports.object({
14026
+ templateKey: external_exports.literal("subscription_expiring"),
14027
+ config: emptyEmailNotificationConfigurationConfigSchema.optional(),
14028
+ isActive: external_exports.boolean().optional()
14029
+ }),
14030
+ external_exports.object({
14031
+ templateKey: external_exports.literal("subscription_low_credits"),
14032
+ config: emptyEmailNotificationConfigurationConfigSchema.optional(),
14033
+ isActive: external_exports.boolean().optional()
14034
+ }),
14035
+ external_exports.object({
14036
+ templateKey: external_exports.literal("subscription_pending_renewal"),
14037
+ config: emptyEmailNotificationConfigurationConfigSchema.optional(),
13965
14038
  isActive: external_exports.boolean().optional()
13966
14039
  })
13967
14040
  ]);
@@ -13969,37 +14042,55 @@ var writableCreateEmailNotificationConfigurationSchema = external_exports.union(
13969
14042
  external_exports.object({
13970
14043
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13971
14044
  templateKey: external_exports.literal("delivery_started"),
13972
- config: emailNotificationConfigurationConfigSchema,
14045
+ config: orderEmailNotificationConfigurationConfigSchema,
13973
14046
  isActive: external_exports.boolean()
13974
14047
  }),
13975
14048
  external_exports.object({
13976
14049
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13977
14050
  templateKey: external_exports.literal("delivery_taken_over"),
13978
- config: emailNotificationConfigurationConfigSchema,
14051
+ config: orderEmailNotificationConfigurationConfigSchema,
13979
14052
  isActive: external_exports.boolean()
13980
14053
  }),
13981
14054
  external_exports.object({
13982
14055
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13983
14056
  templateKey: external_exports.literal("order_created"),
13984
- config: emailNotificationConfigurationConfigSchema,
14057
+ config: orderEmailNotificationConfigurationConfigSchema,
13985
14058
  isActive: external_exports.boolean()
13986
14059
  }),
13987
14060
  external_exports.object({
13988
14061
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13989
14062
  templateKey: external_exports.literal("order_delivered"),
13990
- config: emailNotificationConfigurationConfigSchema,
14063
+ config: orderEmailNotificationConfigurationConfigSchema,
13991
14064
  isActive: external_exports.boolean()
13992
14065
  }),
13993
14066
  external_exports.object({
13994
14067
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
13995
14068
  templateKey: external_exports.literal("order_in_preparation"),
13996
- config: emailNotificationConfigurationConfigSchema,
14069
+ config: orderEmailNotificationConfigurationConfigSchema,
13997
14070
  isActive: external_exports.boolean()
13998
14071
  }),
13999
14072
  external_exports.object({
14000
14073
  pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
14001
14074
  templateKey: external_exports.literal("order_preparation_done"),
14002
- config: emailNotificationConfigurationConfigSchema,
14075
+ config: orderEmailNotificationConfigurationConfigSchema,
14076
+ isActive: external_exports.boolean()
14077
+ }),
14078
+ external_exports.object({
14079
+ pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
14080
+ templateKey: external_exports.literal("subscription_expiring"),
14081
+ config: emptyEmailNotificationConfigurationConfigSchema,
14082
+ isActive: external_exports.boolean()
14083
+ }),
14084
+ external_exports.object({
14085
+ pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
14086
+ templateKey: external_exports.literal("subscription_low_credits"),
14087
+ config: emptyEmailNotificationConfigurationConfigSchema,
14088
+ isActive: external_exports.boolean()
14089
+ }),
14090
+ external_exports.object({
14091
+ pointOfSale: import_sdk_js_point_of_sale.pointOfSaleIriSchema,
14092
+ templateKey: external_exports.literal("subscription_pending_renewal"),
14093
+ config: emptyEmailNotificationConfigurationConfigSchema,
14003
14094
  isActive: external_exports.boolean()
14004
14095
  })
14005
14096
  ]);
@@ -14173,6 +14264,7 @@ var emailNotificationConfigurationNullableIriSchema = (0, import_sdk_js_global_t
14173
14264
  emailNotificationConfigurationSchema,
14174
14265
  emailNotificationConfigurationSchemaListItem,
14175
14266
  emailNotificationConfigurationsQuerySchema,
14267
+ emptyEmailNotificationConfigurationConfigSchema,
14176
14268
  getEmailNotificationConfigurationDetailsInputSchema,
14177
14269
  getEmailNotificationConfigurationDetailsResponseSchema,
14178
14270
  getEmailNotificationConfigurationsFromPointOfSaleInputSchema,
@@ -14181,6 +14273,7 @@ var emailNotificationConfigurationNullableIriSchema = (0, import_sdk_js_global_t
14181
14273
  getEmailNotificationConfigurationsInputSchema,
14182
14274
  getEmailNotificationConfigurationsQuerySchema,
14183
14275
  getEmailNotificationConfigurationsResponseSchema,
14276
+ orderEmailNotificationConfigurationConfigSchema,
14184
14277
  updateEmailNotificationConfigurationInputSchema,
14185
14278
  updateEmailNotificationConfigurationResponseSchema,
14186
14279
  writableCreateEmailNotificationConfigurationSchema,