@teemill/inserts 0.2.1 → 0.4.0

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 (43) hide show
  1. package/README.md +55 -2
  2. package/api.ts +257 -1
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +247 -1
  7. package/dist/api.js +17 -2
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +247 -1
  15. package/dist/esm/api.js +16 -1
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/ApiError.md +22 -0
  27. package/docs/CreateInsertRequest.md +26 -0
  28. package/docs/CreateInsertRequestConfig.md +20 -0
  29. package/docs/CreateInsertRequestConfigCoupon.md +34 -0
  30. package/docs/Insert.md +32 -0
  31. package/docs/InsertConfig.md +21 -0
  32. package/docs/InsertConfigCoupon.md +34 -0
  33. package/docs/InsertType.md +26 -0
  34. package/docs/InsertsApi.md +256 -0
  35. package/docs/InsertsTypesApi.md +132 -0
  36. package/docs/ListInsertTypes200Response.md +22 -0
  37. package/docs/ListInserts200Response.md +22 -0
  38. package/docs/UpdateInsertRequest.md +26 -0
  39. package/docs/UpdateInsertRequestConfig.md +20 -0
  40. package/docs/UpdateInsertRequestConfigCoupon.md +34 -0
  41. package/docs/Value.md +19 -0
  42. package/index.ts +1 -1
  43. package/package.json +1 -1
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Inserts API
6
6
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
7
7
  *
8
- * The version of the OpenAPI document: 0.2.1
8
+ * The version of the OpenAPI document: 0.4.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -22,13 +22,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
22
22
  });
23
23
  };
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
- exports.InsertsTypesApi = exports.InsertsTypesApiFactory = exports.InsertsTypesApiFp = exports.InsertsTypesApiAxiosParamCreator = exports.InsertsApi = exports.InsertsApiFactory = exports.InsertsApiFp = exports.InsertsApiAxiosParamCreator = void 0;
25
+ exports.InsertsTypesApi = exports.InsertsTypesApiFactory = exports.InsertsTypesApiFp = exports.InsertsTypesApiAxiosParamCreator = exports.InsertsApi = exports.InsertsApiFactory = exports.InsertsApiFp = exports.InsertsApiAxiosParamCreator = exports.UpdateInsertRequestConfigCouponTypeEnum = exports.InsertConfigCouponTypeEnum = exports.CreateInsertRequestConfigCouponTypeEnum = void 0;
26
26
  const axios_1 = require("axios");
27
27
  // Some imports not used depending on template conditions
28
28
  // @ts-ignore
29
29
  const common_1 = require("./common");
30
30
  // @ts-ignore
31
31
  const base_1 = require("./base");
32
+ exports.CreateInsertRequestConfigCouponTypeEnum = {
33
+ Percentage: 'percentage',
34
+ Fixed: 'fixed',
35
+ Item: 'item'
36
+ };
37
+ exports.InsertConfigCouponTypeEnum = {
38
+ Percentage: 'percentage',
39
+ Fixed: 'fixed',
40
+ Item: 'item'
41
+ };
42
+ exports.UpdateInsertRequestConfigCouponTypeEnum = {
43
+ Percentage: 'percentage',
44
+ Fixed: 'fixed',
45
+ Item: 'item'
46
+ };
32
47
  /**
33
48
  * InsertsApi - axios parameter creator
34
49
  * @export
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Inserts API
6
6
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
7
7
  *
8
- * The version of the OpenAPI document: 0.2.1
8
+ * The version of the OpenAPI document: 0.4.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Inserts API
6
6
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
7
7
  *
8
- * The version of the OpenAPI document: 0.2.1
8
+ * The version of the OpenAPI document: 0.4.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Inserts API
6
6
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
7
7
  *
8
- * The version of the OpenAPI document: 0.2.1
8
+ * The version of the OpenAPI document: 0.4.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -56,7 +56,87 @@ export interface CreateInsertRequest {
56
56
  * @memberof CreateInsertRequest
57
57
  */
58
58
  'typeRef': string;
59
+ /**
60
+ *
61
+ * @type {CreateInsertRequestConfig}
62
+ * @memberof CreateInsertRequest
63
+ */
64
+ 'config'?: CreateInsertRequestConfig;
59
65
  }
66
+ /**
67
+ *
68
+ * @export
69
+ * @interface CreateInsertRequestConfig
70
+ */
71
+ export interface CreateInsertRequestConfig {
72
+ /**
73
+ *
74
+ * @type {CreateInsertRequestConfigCoupon}
75
+ * @memberof CreateInsertRequestConfig
76
+ */
77
+ 'coupon'?: CreateInsertRequestConfigCoupon;
78
+ }
79
+ /**
80
+ *
81
+ * @export
82
+ * @interface CreateInsertRequestConfigCoupon
83
+ */
84
+ export interface CreateInsertRequestConfigCoupon {
85
+ /**
86
+ * The prefix of the coupon code to apply to the insert
87
+ * @type {string}
88
+ * @memberof CreateInsertRequestConfigCoupon
89
+ */
90
+ 'prefix': string;
91
+ /**
92
+ * The type of coupon to apply to the insert
93
+ * @type {string}
94
+ * @memberof CreateInsertRequestConfigCoupon
95
+ */
96
+ 'type': CreateInsertRequestConfigCouponTypeEnum;
97
+ /**
98
+ * The number of hours after creation which the coupon will expire
99
+ * @type {number}
100
+ * @memberof CreateInsertRequestConfigCoupon
101
+ */
102
+ 'expiryHours': number;
103
+ /**
104
+ * The number of times the coupon can be used
105
+ * @type {number}
106
+ * @memberof CreateInsertRequestConfigCoupon
107
+ */
108
+ 'numberOfUses': number;
109
+ /**
110
+ *
111
+ * @type {Value}
112
+ * @memberof CreateInsertRequestConfigCoupon
113
+ */
114
+ 'value': Value;
115
+ /**
116
+ * The minimum order value to apply the coupon to
117
+ * @type {number}
118
+ * @memberof CreateInsertRequestConfigCoupon
119
+ */
120
+ 'minimumOrderValue': number;
121
+ /**
122
+ * A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project.
123
+ * @type {Array<string>}
124
+ * @memberof CreateInsertRequestConfigCoupon
125
+ */
126
+ 'freeDeliveryMethods'?: Array<string>;
127
+ /**
128
+ * The description of the coupon to apply to the insert
129
+ * @type {string}
130
+ * @memberof CreateInsertRequestConfigCoupon
131
+ */
132
+ 'description': string;
133
+ }
134
+ export declare const CreateInsertRequestConfigCouponTypeEnum: {
135
+ readonly Percentage: "percentage";
136
+ readonly Fixed: "fixed";
137
+ readonly Item: "item";
138
+ };
139
+ export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
60
140
  /**
61
141
  *
62
142
  * @export
@@ -87,6 +167,12 @@ export interface Insert {
87
167
  * @memberof Insert
88
168
  */
89
169
  'typeRef': string;
170
+ /**
171
+ *
172
+ * @type {InsertConfig}
173
+ * @memberof Insert
174
+ */
175
+ 'config': InsertConfig | null;
90
176
  /**
91
177
  * ISO 8601 Timestamp
92
178
  * @type {string}
@@ -100,6 +186,80 @@ export interface Insert {
100
186
  */
101
187
  'updatedAt': string | null;
102
188
  }
189
+ /**
190
+ * The configuration of the insert
191
+ * @export
192
+ * @interface InsertConfig
193
+ */
194
+ export interface InsertConfig {
195
+ /**
196
+ *
197
+ * @type {InsertConfigCoupon}
198
+ * @memberof InsertConfig
199
+ */
200
+ 'coupon'?: InsertConfigCoupon | null;
201
+ }
202
+ /**
203
+ *
204
+ * @export
205
+ * @interface InsertConfigCoupon
206
+ */
207
+ export interface InsertConfigCoupon {
208
+ /**
209
+ * The prefix of the coupon code to apply to the insert
210
+ * @type {string}
211
+ * @memberof InsertConfigCoupon
212
+ */
213
+ 'prefix': string;
214
+ /**
215
+ * The type of coupon to apply to the insert
216
+ * @type {string}
217
+ * @memberof InsertConfigCoupon
218
+ */
219
+ 'type': InsertConfigCouponTypeEnum;
220
+ /**
221
+ * The number of hours after creation which the coupon will expire
222
+ * @type {number}
223
+ * @memberof InsertConfigCoupon
224
+ */
225
+ 'expiryHours': number;
226
+ /**
227
+ * The number of times the coupon can be used
228
+ * @type {number}
229
+ * @memberof InsertConfigCoupon
230
+ */
231
+ 'numberOfUses': number;
232
+ /**
233
+ * A list of delivery methods for the discount.
234
+ * @type {Array<string>}
235
+ * @memberof InsertConfigCoupon
236
+ */
237
+ 'freeDeliveryMethods'?: Array<string> | null;
238
+ /**
239
+ *
240
+ * @type {Value}
241
+ * @memberof InsertConfigCoupon
242
+ */
243
+ 'value': Value;
244
+ /**
245
+ * The minimum order value to apply the coupon to
246
+ * @type {number}
247
+ * @memberof InsertConfigCoupon
248
+ */
249
+ 'minimumOrderValue': number;
250
+ /**
251
+ *
252
+ * @type {string}
253
+ * @memberof InsertConfigCoupon
254
+ */
255
+ 'description': string;
256
+ }
257
+ export declare const InsertConfigCouponTypeEnum: {
258
+ readonly Percentage: "percentage";
259
+ readonly Fixed: "fixed";
260
+ readonly Item: "item";
261
+ };
262
+ export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
103
263
  /**
104
264
  *
105
265
  * @export
@@ -193,7 +353,93 @@ export interface UpdateInsertRequest {
193
353
  * @memberof UpdateInsertRequest
194
354
  */
195
355
  'typeRef'?: string;
356
+ /**
357
+ *
358
+ * @type {UpdateInsertRequestConfig}
359
+ * @memberof UpdateInsertRequest
360
+ */
361
+ 'config'?: UpdateInsertRequestConfig | null;
362
+ }
363
+ /**
364
+ *
365
+ * @export
366
+ * @interface UpdateInsertRequestConfig
367
+ */
368
+ export interface UpdateInsertRequestConfig {
369
+ /**
370
+ *
371
+ * @type {UpdateInsertRequestConfigCoupon}
372
+ * @memberof UpdateInsertRequestConfig
373
+ */
374
+ 'coupon'?: UpdateInsertRequestConfigCoupon;
375
+ }
376
+ /**
377
+ *
378
+ * @export
379
+ * @interface UpdateInsertRequestConfigCoupon
380
+ */
381
+ export interface UpdateInsertRequestConfigCoupon {
382
+ /**
383
+ * The prefix of the coupon code to apply to the insert
384
+ * @type {string}
385
+ * @memberof UpdateInsertRequestConfigCoupon
386
+ */
387
+ 'prefix': string;
388
+ /**
389
+ * The number of times the coupon can be used
390
+ * @type {number}
391
+ * @memberof UpdateInsertRequestConfigCoupon
392
+ */
393
+ 'numberOfUses': number;
394
+ /**
395
+ * The number of hours after creation which the coupon will expire
396
+ * @type {number}
397
+ * @memberof UpdateInsertRequestConfigCoupon
398
+ */
399
+ 'expiryHours': number;
400
+ /**
401
+ * The type of coupon to apply to the insert
402
+ * @type {string}
403
+ * @memberof UpdateInsertRequestConfigCoupon
404
+ */
405
+ 'type': UpdateInsertRequestConfigCouponTypeEnum;
406
+ /**
407
+ *
408
+ * @type {Value}
409
+ * @memberof UpdateInsertRequestConfigCoupon
410
+ */
411
+ 'value': Value;
412
+ /**
413
+ * The minimum order value to apply the coupon to
414
+ * @type {number}
415
+ * @memberof UpdateInsertRequestConfigCoupon
416
+ */
417
+ 'minimumOrderValue': number;
418
+ /**
419
+ * A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project.
420
+ * @type {Array<string>}
421
+ * @memberof UpdateInsertRequestConfigCoupon
422
+ */
423
+ 'freeDeliveryMethods'?: Array<string> | null;
424
+ /**
425
+ * The description of the coupon to apply to the insert
426
+ * @type {string}
427
+ * @memberof UpdateInsertRequestConfigCoupon
428
+ */
429
+ 'description': string;
196
430
  }
431
+ export declare const UpdateInsertRequestConfigCouponTypeEnum: {
432
+ readonly Percentage: "percentage";
433
+ readonly Fixed: "fixed";
434
+ readonly Item: "item";
435
+ };
436
+ export type UpdateInsertRequestConfigCouponTypeEnum = typeof UpdateInsertRequestConfigCouponTypeEnum[keyof typeof UpdateInsertRequestConfigCouponTypeEnum];
437
+ /**
438
+ * @type Value
439
+ * The value of the discount. For percentage discounts, this is the percentage (0-100). For fixed discounts, this is the fixed amount. For item discounts, this is the product reference.
440
+ * @export
441
+ */
442
+ export type Value = number | string;
197
443
  /**
198
444
  * InsertsApi - axios parameter creator
199
445
  * @export
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Inserts API
5
5
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
6
6
  *
7
- * The version of the OpenAPI document: 0.2.1
7
+ * The version of the OpenAPI document: 0.4.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,6 +26,21 @@ import globalAxios from 'axios';
26
26
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
27
27
  // @ts-ignore
28
28
  import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
+ export const CreateInsertRequestConfigCouponTypeEnum = {
30
+ Percentage: 'percentage',
31
+ Fixed: 'fixed',
32
+ Item: 'item'
33
+ };
34
+ export const InsertConfigCouponTypeEnum = {
35
+ Percentage: 'percentage',
36
+ Fixed: 'fixed',
37
+ Item: 'item'
38
+ };
39
+ export const UpdateInsertRequestConfigCouponTypeEnum = {
40
+ Percentage: 'percentage',
41
+ Fixed: 'fixed',
42
+ Item: 'item'
43
+ };
29
44
  /**
30
45
  * InsertsApi - axios parameter creator
31
46
  * @export
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Inserts API
5
5
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
6
6
  *
7
- * The version of the OpenAPI document: 0.2.1
7
+ * The version of the OpenAPI document: 0.4.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Inserts API
5
5
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
6
6
  *
7
- * The version of the OpenAPI document: 0.2.1
7
+ * The version of the OpenAPI document: 0.4.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Inserts API
5
5
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
6
6
  *
7
- * The version of the OpenAPI document: 0.2.1
7
+ * The version of the OpenAPI document: 0.4.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Inserts API
5
5
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
6
6
  *
7
- * The version of the OpenAPI document: 0.2.1
7
+ * The version of the OpenAPI document: 0.4.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Inserts API
3
3
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
4
4
  *
5
- * The version of the OpenAPI document: 0.2.1
5
+ * The version of the OpenAPI document: 0.4.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Inserts API
6
6
  * An API for managing order inserts in PodOS that automatically adds a free item to a customer\'s order when specific conditions are met, such as a first-time purchase.
7
7
  *
8
- * The version of the OpenAPI document: 0.2.1
8
+ * The version of the OpenAPI document: 0.4.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,22 @@
1
+ # ApiError
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **message** | **string** | | [default to undefined]
9
+ **code** | **string** | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ApiError } from '@teemill/inserts';
15
+
16
+ const instance: ApiError = {
17
+ message,
18
+ code,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,26 @@
1
+ # CreateInsertRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **enabled** | **boolean** | Whether the insert is enabled | [default to undefined]
9
+ **variantRef** | **string** | A reference to the variant that will be inserted into the order when this insert rule is triggered | [default to undefined]
10
+ **typeRef** | **string** | A reference to the insert type that will be inserted into the order when this insert rule is triggered | [default to undefined]
11
+ **config** | [**CreateInsertRequestConfig**](CreateInsertRequestConfig.md) | | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { CreateInsertRequest } from '@teemill/inserts';
17
+
18
+ const instance: CreateInsertRequest = {
19
+ enabled,
20
+ variantRef,
21
+ typeRef,
22
+ config,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,20 @@
1
+ # CreateInsertRequestConfig
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **coupon** | [**CreateInsertRequestConfigCoupon**](CreateInsertRequestConfigCoupon.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CreateInsertRequestConfig } from '@teemill/inserts';
14
+
15
+ const instance: CreateInsertRequestConfig = {
16
+ coupon,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,34 @@
1
+ # CreateInsertRequestConfigCoupon
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **prefix** | **string** | The prefix of the coupon code to apply to the insert | [default to undefined]
9
+ **type** | **string** | The type of coupon to apply to the insert | [default to undefined]
10
+ **expiryHours** | **number** | The number of hours after creation which the coupon will expire | [default to undefined]
11
+ **numberOfUses** | **number** | The number of times the coupon can be used | [default to undefined]
12
+ **value** | [**Value**](Value.md) | | [default to undefined]
13
+ **minimumOrderValue** | **number** | The minimum order value to apply the coupon to | [default to undefined]
14
+ **freeDeliveryMethods** | **Array&lt;string&gt;** | A list of delivery methods that will be used for the discount. **Note:** Adding delivery methods requires the delivery integration to be installed on your project. | [optional] [default to undefined]
15
+ **description** | **string** | The description of the coupon to apply to the insert | [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { CreateInsertRequestConfigCoupon } from '@teemill/inserts';
21
+
22
+ const instance: CreateInsertRequestConfigCoupon = {
23
+ prefix,
24
+ type,
25
+ expiryHours,
26
+ numberOfUses,
27
+ value,
28
+ minimumOrderValue,
29
+ freeDeliveryMethods,
30
+ description,
31
+ };
32
+ ```
33
+
34
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/docs/Insert.md ADDED
@@ -0,0 +1,32 @@
1
+ # Insert
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | Unique object identifier | [default to undefined]
9
+ **enabled** | **boolean** | Whether the insert is enabled | [default to undefined]
10
+ **variantRef** | **string** | A reference to the variant that will be inserted into the order when this insert rule is triggered | [default to undefined]
11
+ **typeRef** | **string** | A reference to the insert type that will be inserted into the order when this insert rule is triggered | [default to undefined]
12
+ **config** | [**InsertConfig**](InsertConfig.md) | | [default to undefined]
13
+ **createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
14
+ **updatedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { Insert } from '@teemill/inserts';
20
+
21
+ const instance: Insert = {
22
+ id,
23
+ enabled,
24
+ variantRef,
25
+ typeRef,
26
+ config,
27
+ createdAt,
28
+ updatedAt,
29
+ };
30
+ ```
31
+
32
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,21 @@
1
+ # InsertConfig
2
+
3
+ The configuration of the insert
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **coupon** | [**InsertConfigCoupon**](InsertConfigCoupon.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { InsertConfig } from '@teemill/inserts';
15
+
16
+ const instance: InsertConfig = {
17
+ coupon,
18
+ };
19
+ ```
20
+
21
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)