@teemill/inserts 0.3.0 → 0.4.1
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 +5 -4
- package/api.ts +117 -53
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +115 -52
- package/dist/api.js +7 -4
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +115 -52
- package/dist/esm/api.js +7 -4
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CreateInsertRequestConfigCoupon.md +7 -1
- package/docs/InlineObject.md +22 -0
- package/docs/InlineObject1.md +22 -0
- package/docs/InsertConfigCoupon.md +7 -1
- package/docs/InsertsApi.md +2 -2
- package/docs/InsertsTypesApi.md +2 -2
- package/docs/UpdateInsertRequestConfigCoupon.md +7 -1
- package/docs/Value.md +19 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/inserts@0.
|
|
1
|
+
## @teemill/inserts@0.4.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/inserts@0.
|
|
39
|
+
npm install @teemill/inserts@0.4.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -65,15 +65,16 @@ Class | Method | HTTP request | Description
|
|
|
65
65
|
- [CreateInsertRequest](docs/CreateInsertRequest.md)
|
|
66
66
|
- [CreateInsertRequestConfig](docs/CreateInsertRequestConfig.md)
|
|
67
67
|
- [CreateInsertRequestConfigCoupon](docs/CreateInsertRequestConfigCoupon.md)
|
|
68
|
+
- [InlineObject](docs/InlineObject.md)
|
|
69
|
+
- [InlineObject1](docs/InlineObject1.md)
|
|
68
70
|
- [Insert](docs/Insert.md)
|
|
69
71
|
- [InsertConfig](docs/InsertConfig.md)
|
|
70
72
|
- [InsertConfigCoupon](docs/InsertConfigCoupon.md)
|
|
71
73
|
- [InsertType](docs/InsertType.md)
|
|
72
|
-
- [ListInsertTypes200Response](docs/ListInsertTypes200Response.md)
|
|
73
|
-
- [ListInserts200Response](docs/ListInserts200Response.md)
|
|
74
74
|
- [UpdateInsertRequest](docs/UpdateInsertRequest.md)
|
|
75
75
|
- [UpdateInsertRequestConfig](docs/UpdateInsertRequestConfig.md)
|
|
76
76
|
- [UpdateInsertRequestConfigCoupon](docs/UpdateInsertRequestConfigCoupon.md)
|
|
77
|
+
- [Value](docs/Value.md)
|
|
77
78
|
|
|
78
79
|
|
|
79
80
|
<a id="documentation-for-authorization"></a>
|
package/api.ts
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.
|
|
7
|
+
* The version of the OpenAPI document: 0.4.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -105,17 +105,35 @@ export interface CreateInsertRequestConfigCoupon {
|
|
|
105
105
|
*/
|
|
106
106
|
'type': CreateInsertRequestConfigCouponTypeEnum;
|
|
107
107
|
/**
|
|
108
|
-
* The
|
|
108
|
+
* The number of hours after creation which the coupon will expire
|
|
109
109
|
* @type {number}
|
|
110
110
|
* @memberof CreateInsertRequestConfigCoupon
|
|
111
111
|
*/
|
|
112
|
-
'
|
|
112
|
+
'expiryHours': number;
|
|
113
|
+
/**
|
|
114
|
+
* The number of times the coupon can be used
|
|
115
|
+
* @type {number}
|
|
116
|
+
* @memberof CreateInsertRequestConfigCoupon
|
|
117
|
+
*/
|
|
118
|
+
'numberOfUses': number;
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @type {Value}
|
|
122
|
+
* @memberof CreateInsertRequestConfigCoupon
|
|
123
|
+
*/
|
|
124
|
+
'value': Value;
|
|
113
125
|
/**
|
|
114
126
|
* The minimum order value to apply the coupon to
|
|
115
127
|
* @type {number}
|
|
116
128
|
* @memberof CreateInsertRequestConfigCoupon
|
|
117
129
|
*/
|
|
118
130
|
'minimumOrderValue': number;
|
|
131
|
+
/**
|
|
132
|
+
* 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.
|
|
133
|
+
* @type {Array<string>}
|
|
134
|
+
* @memberof CreateInsertRequestConfigCoupon
|
|
135
|
+
*/
|
|
136
|
+
'freeDeliveryMethods'?: Array<string>;
|
|
119
137
|
/**
|
|
120
138
|
* The description of the coupon to apply to the insert
|
|
121
139
|
* @type {string}
|
|
@@ -126,11 +144,50 @@ export interface CreateInsertRequestConfigCoupon {
|
|
|
126
144
|
|
|
127
145
|
export const CreateInsertRequestConfigCouponTypeEnum = {
|
|
128
146
|
Percentage: 'percentage',
|
|
129
|
-
Fixed: 'fixed'
|
|
147
|
+
Fixed: 'fixed',
|
|
148
|
+
Item: 'item'
|
|
130
149
|
} as const;
|
|
131
150
|
|
|
132
151
|
export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
|
|
133
152
|
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @export
|
|
156
|
+
* @interface InlineObject
|
|
157
|
+
*/
|
|
158
|
+
export interface InlineObject {
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @type {Array<InsertType>}
|
|
162
|
+
* @memberof InlineObject
|
|
163
|
+
*/
|
|
164
|
+
'insertTypes': Array<InsertType>;
|
|
165
|
+
/**
|
|
166
|
+
* The token referencing the next page number
|
|
167
|
+
* @type {number}
|
|
168
|
+
* @memberof InlineObject
|
|
169
|
+
*/
|
|
170
|
+
'nextPageToken': number | null;
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
*
|
|
174
|
+
* @export
|
|
175
|
+
* @interface InlineObject1
|
|
176
|
+
*/
|
|
177
|
+
export interface InlineObject1 {
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @type {Array<Insert>}
|
|
181
|
+
* @memberof InlineObject1
|
|
182
|
+
*/
|
|
183
|
+
'inserts': Array<Insert>;
|
|
184
|
+
/**
|
|
185
|
+
* The token referencing the next page number
|
|
186
|
+
* @type {number}
|
|
187
|
+
* @memberof InlineObject1
|
|
188
|
+
*/
|
|
189
|
+
'nextPageToken': number | null;
|
|
190
|
+
}
|
|
134
191
|
/**
|
|
135
192
|
*
|
|
136
193
|
* @export
|
|
@@ -212,11 +269,29 @@ export interface InsertConfigCoupon {
|
|
|
212
269
|
*/
|
|
213
270
|
'type': InsertConfigCouponTypeEnum;
|
|
214
271
|
/**
|
|
215
|
-
* The
|
|
272
|
+
* The number of hours after creation which the coupon will expire
|
|
273
|
+
* @type {number}
|
|
274
|
+
* @memberof InsertConfigCoupon
|
|
275
|
+
*/
|
|
276
|
+
'expiryHours': number;
|
|
277
|
+
/**
|
|
278
|
+
* The number of times the coupon can be used
|
|
216
279
|
* @type {number}
|
|
217
280
|
* @memberof InsertConfigCoupon
|
|
218
281
|
*/
|
|
219
|
-
'
|
|
282
|
+
'numberOfUses': number;
|
|
283
|
+
/**
|
|
284
|
+
* A list of delivery methods for the discount.
|
|
285
|
+
* @type {Array<string>}
|
|
286
|
+
* @memberof InsertConfigCoupon
|
|
287
|
+
*/
|
|
288
|
+
'freeDeliveryMethods'?: Array<string> | null;
|
|
289
|
+
/**
|
|
290
|
+
*
|
|
291
|
+
* @type {Value}
|
|
292
|
+
* @memberof InsertConfigCoupon
|
|
293
|
+
*/
|
|
294
|
+
'value': Value;
|
|
220
295
|
/**
|
|
221
296
|
* The minimum order value to apply the coupon to
|
|
222
297
|
* @type {number}
|
|
@@ -233,7 +308,8 @@ export interface InsertConfigCoupon {
|
|
|
233
308
|
|
|
234
309
|
export const InsertConfigCouponTypeEnum = {
|
|
235
310
|
Percentage: 'percentage',
|
|
236
|
-
Fixed: 'fixed'
|
|
311
|
+
Fixed: 'fixed',
|
|
312
|
+
Item: 'item'
|
|
237
313
|
} as const;
|
|
238
314
|
|
|
239
315
|
export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
|
|
@@ -269,44 +345,6 @@ export interface InsertType {
|
|
|
269
345
|
*/
|
|
270
346
|
'description': string;
|
|
271
347
|
}
|
|
272
|
-
/**
|
|
273
|
-
*
|
|
274
|
-
* @export
|
|
275
|
-
* @interface ListInsertTypes200Response
|
|
276
|
-
*/
|
|
277
|
-
export interface ListInsertTypes200Response {
|
|
278
|
-
/**
|
|
279
|
-
*
|
|
280
|
-
* @type {Array<InsertType>}
|
|
281
|
-
* @memberof ListInsertTypes200Response
|
|
282
|
-
*/
|
|
283
|
-
'insertTypes': Array<InsertType>;
|
|
284
|
-
/**
|
|
285
|
-
* The token referencing the next page number
|
|
286
|
-
* @type {number}
|
|
287
|
-
* @memberof ListInsertTypes200Response
|
|
288
|
-
*/
|
|
289
|
-
'nextPageToken': number | null;
|
|
290
|
-
}
|
|
291
|
-
/**
|
|
292
|
-
*
|
|
293
|
-
* @export
|
|
294
|
-
* @interface ListInserts200Response
|
|
295
|
-
*/
|
|
296
|
-
export interface ListInserts200Response {
|
|
297
|
-
/**
|
|
298
|
-
*
|
|
299
|
-
* @type {Array<Insert>}
|
|
300
|
-
* @memberof ListInserts200Response
|
|
301
|
-
*/
|
|
302
|
-
'inserts': Array<Insert>;
|
|
303
|
-
/**
|
|
304
|
-
* The token referencing the next page number
|
|
305
|
-
* @type {number}
|
|
306
|
-
* @memberof ListInserts200Response
|
|
307
|
-
*/
|
|
308
|
-
'nextPageToken': number | null;
|
|
309
|
-
}
|
|
310
348
|
/**
|
|
311
349
|
*
|
|
312
350
|
* @export
|
|
@@ -363,6 +401,18 @@ export interface UpdateInsertRequestConfigCoupon {
|
|
|
363
401
|
* @memberof UpdateInsertRequestConfigCoupon
|
|
364
402
|
*/
|
|
365
403
|
'prefix': string;
|
|
404
|
+
/**
|
|
405
|
+
* The number of times the coupon can be used
|
|
406
|
+
* @type {number}
|
|
407
|
+
* @memberof UpdateInsertRequestConfigCoupon
|
|
408
|
+
*/
|
|
409
|
+
'numberOfUses': number;
|
|
410
|
+
/**
|
|
411
|
+
* The number of hours after creation which the coupon will expire
|
|
412
|
+
* @type {number}
|
|
413
|
+
* @memberof UpdateInsertRequestConfigCoupon
|
|
414
|
+
*/
|
|
415
|
+
'expiryHours': number;
|
|
366
416
|
/**
|
|
367
417
|
* The type of coupon to apply to the insert
|
|
368
418
|
* @type {string}
|
|
@@ -370,17 +420,23 @@ export interface UpdateInsertRequestConfigCoupon {
|
|
|
370
420
|
*/
|
|
371
421
|
'type': UpdateInsertRequestConfigCouponTypeEnum;
|
|
372
422
|
/**
|
|
373
|
-
*
|
|
374
|
-
* @type {
|
|
423
|
+
*
|
|
424
|
+
* @type {Value}
|
|
375
425
|
* @memberof UpdateInsertRequestConfigCoupon
|
|
376
426
|
*/
|
|
377
|
-
'value':
|
|
427
|
+
'value': Value;
|
|
378
428
|
/**
|
|
379
429
|
* The minimum order value to apply the coupon to
|
|
380
430
|
* @type {number}
|
|
381
431
|
* @memberof UpdateInsertRequestConfigCoupon
|
|
382
432
|
*/
|
|
383
433
|
'minimumOrderValue': number;
|
|
434
|
+
/**
|
|
435
|
+
* 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.
|
|
436
|
+
* @type {Array<string>}
|
|
437
|
+
* @memberof UpdateInsertRequestConfigCoupon
|
|
438
|
+
*/
|
|
439
|
+
'freeDeliveryMethods'?: Array<string> | null;
|
|
384
440
|
/**
|
|
385
441
|
* The description of the coupon to apply to the insert
|
|
386
442
|
* @type {string}
|
|
@@ -391,11 +447,19 @@ export interface UpdateInsertRequestConfigCoupon {
|
|
|
391
447
|
|
|
392
448
|
export const UpdateInsertRequestConfigCouponTypeEnum = {
|
|
393
449
|
Percentage: 'percentage',
|
|
394
|
-
Fixed: 'fixed'
|
|
450
|
+
Fixed: 'fixed',
|
|
451
|
+
Item: 'item'
|
|
395
452
|
} as const;
|
|
396
453
|
|
|
397
454
|
export type UpdateInsertRequestConfigCouponTypeEnum = typeof UpdateInsertRequestConfigCouponTypeEnum[keyof typeof UpdateInsertRequestConfigCouponTypeEnum];
|
|
398
455
|
|
|
456
|
+
/**
|
|
457
|
+
* @type Value
|
|
458
|
+
* 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.
|
|
459
|
+
* @export
|
|
460
|
+
*/
|
|
461
|
+
export type Value = number | string;
|
|
462
|
+
|
|
399
463
|
|
|
400
464
|
/**
|
|
401
465
|
* InsertsApi - axios parameter creator
|
|
@@ -662,7 +726,7 @@ export const InsertsApiFp = function(configuration?: Configuration) {
|
|
|
662
726
|
* @param {*} [options] Override http request option.
|
|
663
727
|
* @throws {RequiredError}
|
|
664
728
|
*/
|
|
665
|
-
async listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
729
|
+
async listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>> {
|
|
666
730
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listInserts(project, pageToken, pageSize, search, options);
|
|
667
731
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
668
732
|
const localVarOperationServerBasePath = operationServerMap['InsertsApi.listInserts']?.[localVarOperationServerIndex]?.url;
|
|
@@ -720,7 +784,7 @@ export const InsertsApiFactory = function (configuration?: Configuration, basePa
|
|
|
720
784
|
* @param {*} [options] Override http request option.
|
|
721
785
|
* @throws {RequiredError}
|
|
722
786
|
*/
|
|
723
|
-
listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
787
|
+
listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1> {
|
|
724
788
|
return localVarFp.listInserts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
725
789
|
},
|
|
726
790
|
/**
|
|
@@ -1046,7 +1110,7 @@ export const InsertsTypesApiFp = function(configuration?: Configuration) {
|
|
|
1046
1110
|
* @param {*} [options] Override http request option.
|
|
1047
1111
|
* @throws {RequiredError}
|
|
1048
1112
|
*/
|
|
1049
|
-
async listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1113
|
+
async listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>> {
|
|
1050
1114
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listInsertTypes(project, pageToken, pageSize, search, options);
|
|
1051
1115
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1052
1116
|
const localVarOperationServerBasePath = operationServerMap['InsertsTypesApi.listInsertTypes']?.[localVarOperationServerIndex]?.url;
|
|
@@ -1079,7 +1143,7 @@ export const InsertsTypesApiFactory = function (configuration?: Configuration, b
|
|
|
1079
1143
|
* @param {*} [options] Override http request option.
|
|
1080
1144
|
* @throws {RequiredError}
|
|
1081
1145
|
*/
|
|
1082
|
-
listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1146
|
+
listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject> {
|
|
1083
1147
|
return localVarFp.listInsertTypes(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1084
1148
|
},
|
|
1085
1149
|
};
|
package/base.ts
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.
|
|
7
|
+
* The version of the OpenAPI document: 0.4.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
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.
|
|
7
|
+
* The version of the OpenAPI document: 0.4.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
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.
|
|
7
|
+
* The version of the OpenAPI document: 0.4.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/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.
|
|
5
|
+
* The version of the OpenAPI document: 0.4.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -95,17 +95,35 @@ export interface CreateInsertRequestConfigCoupon {
|
|
|
95
95
|
*/
|
|
96
96
|
'type': CreateInsertRequestConfigCouponTypeEnum;
|
|
97
97
|
/**
|
|
98
|
-
* The
|
|
98
|
+
* The number of hours after creation which the coupon will expire
|
|
99
99
|
* @type {number}
|
|
100
100
|
* @memberof CreateInsertRequestConfigCoupon
|
|
101
101
|
*/
|
|
102
|
-
'
|
|
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;
|
|
103
115
|
/**
|
|
104
116
|
* The minimum order value to apply the coupon to
|
|
105
117
|
* @type {number}
|
|
106
118
|
* @memberof CreateInsertRequestConfigCoupon
|
|
107
119
|
*/
|
|
108
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>;
|
|
109
127
|
/**
|
|
110
128
|
* The description of the coupon to apply to the insert
|
|
111
129
|
* @type {string}
|
|
@@ -116,8 +134,47 @@ export interface CreateInsertRequestConfigCoupon {
|
|
|
116
134
|
export declare const CreateInsertRequestConfigCouponTypeEnum: {
|
|
117
135
|
readonly Percentage: "percentage";
|
|
118
136
|
readonly Fixed: "fixed";
|
|
137
|
+
readonly Item: "item";
|
|
119
138
|
};
|
|
120
139
|
export type CreateInsertRequestConfigCouponTypeEnum = typeof CreateInsertRequestConfigCouponTypeEnum[keyof typeof CreateInsertRequestConfigCouponTypeEnum];
|
|
140
|
+
/**
|
|
141
|
+
*
|
|
142
|
+
* @export
|
|
143
|
+
* @interface InlineObject
|
|
144
|
+
*/
|
|
145
|
+
export interface InlineObject {
|
|
146
|
+
/**
|
|
147
|
+
*
|
|
148
|
+
* @type {Array<InsertType>}
|
|
149
|
+
* @memberof InlineObject
|
|
150
|
+
*/
|
|
151
|
+
'insertTypes': Array<InsertType>;
|
|
152
|
+
/**
|
|
153
|
+
* The token referencing the next page number
|
|
154
|
+
* @type {number}
|
|
155
|
+
* @memberof InlineObject
|
|
156
|
+
*/
|
|
157
|
+
'nextPageToken': number | null;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
*
|
|
161
|
+
* @export
|
|
162
|
+
* @interface InlineObject1
|
|
163
|
+
*/
|
|
164
|
+
export interface InlineObject1 {
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @type {Array<Insert>}
|
|
168
|
+
* @memberof InlineObject1
|
|
169
|
+
*/
|
|
170
|
+
'inserts': Array<Insert>;
|
|
171
|
+
/**
|
|
172
|
+
* The token referencing the next page number
|
|
173
|
+
* @type {number}
|
|
174
|
+
* @memberof InlineObject1
|
|
175
|
+
*/
|
|
176
|
+
'nextPageToken': number | null;
|
|
177
|
+
}
|
|
121
178
|
/**
|
|
122
179
|
*
|
|
123
180
|
* @export
|
|
@@ -199,11 +256,29 @@ export interface InsertConfigCoupon {
|
|
|
199
256
|
*/
|
|
200
257
|
'type': InsertConfigCouponTypeEnum;
|
|
201
258
|
/**
|
|
202
|
-
* The
|
|
259
|
+
* The number of hours after creation which the coupon will expire
|
|
260
|
+
* @type {number}
|
|
261
|
+
* @memberof InsertConfigCoupon
|
|
262
|
+
*/
|
|
263
|
+
'expiryHours': number;
|
|
264
|
+
/**
|
|
265
|
+
* The number of times the coupon can be used
|
|
203
266
|
* @type {number}
|
|
204
267
|
* @memberof InsertConfigCoupon
|
|
205
268
|
*/
|
|
206
|
-
'
|
|
269
|
+
'numberOfUses': number;
|
|
270
|
+
/**
|
|
271
|
+
* A list of delivery methods for the discount.
|
|
272
|
+
* @type {Array<string>}
|
|
273
|
+
* @memberof InsertConfigCoupon
|
|
274
|
+
*/
|
|
275
|
+
'freeDeliveryMethods'?: Array<string> | null;
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @type {Value}
|
|
279
|
+
* @memberof InsertConfigCoupon
|
|
280
|
+
*/
|
|
281
|
+
'value': Value;
|
|
207
282
|
/**
|
|
208
283
|
* The minimum order value to apply the coupon to
|
|
209
284
|
* @type {number}
|
|
@@ -220,6 +295,7 @@ export interface InsertConfigCoupon {
|
|
|
220
295
|
export declare const InsertConfigCouponTypeEnum: {
|
|
221
296
|
readonly Percentage: "percentage";
|
|
222
297
|
readonly Fixed: "fixed";
|
|
298
|
+
readonly Item: "item";
|
|
223
299
|
};
|
|
224
300
|
export type InsertConfigCouponTypeEnum = typeof InsertConfigCouponTypeEnum[keyof typeof InsertConfigCouponTypeEnum];
|
|
225
301
|
/**
|
|
@@ -253,44 +329,6 @@ export interface InsertType {
|
|
|
253
329
|
*/
|
|
254
330
|
'description': string;
|
|
255
331
|
}
|
|
256
|
-
/**
|
|
257
|
-
*
|
|
258
|
-
* @export
|
|
259
|
-
* @interface ListInsertTypes200Response
|
|
260
|
-
*/
|
|
261
|
-
export interface ListInsertTypes200Response {
|
|
262
|
-
/**
|
|
263
|
-
*
|
|
264
|
-
* @type {Array<InsertType>}
|
|
265
|
-
* @memberof ListInsertTypes200Response
|
|
266
|
-
*/
|
|
267
|
-
'insertTypes': Array<InsertType>;
|
|
268
|
-
/**
|
|
269
|
-
* The token referencing the next page number
|
|
270
|
-
* @type {number}
|
|
271
|
-
* @memberof ListInsertTypes200Response
|
|
272
|
-
*/
|
|
273
|
-
'nextPageToken': number | null;
|
|
274
|
-
}
|
|
275
|
-
/**
|
|
276
|
-
*
|
|
277
|
-
* @export
|
|
278
|
-
* @interface ListInserts200Response
|
|
279
|
-
*/
|
|
280
|
-
export interface ListInserts200Response {
|
|
281
|
-
/**
|
|
282
|
-
*
|
|
283
|
-
* @type {Array<Insert>}
|
|
284
|
-
* @memberof ListInserts200Response
|
|
285
|
-
*/
|
|
286
|
-
'inserts': Array<Insert>;
|
|
287
|
-
/**
|
|
288
|
-
* The token referencing the next page number
|
|
289
|
-
* @type {number}
|
|
290
|
-
* @memberof ListInserts200Response
|
|
291
|
-
*/
|
|
292
|
-
'nextPageToken': number | null;
|
|
293
|
-
}
|
|
294
332
|
/**
|
|
295
333
|
*
|
|
296
334
|
* @export
|
|
@@ -347,6 +385,18 @@ export interface UpdateInsertRequestConfigCoupon {
|
|
|
347
385
|
* @memberof UpdateInsertRequestConfigCoupon
|
|
348
386
|
*/
|
|
349
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;
|
|
350
400
|
/**
|
|
351
401
|
* The type of coupon to apply to the insert
|
|
352
402
|
* @type {string}
|
|
@@ -354,17 +404,23 @@ export interface UpdateInsertRequestConfigCoupon {
|
|
|
354
404
|
*/
|
|
355
405
|
'type': UpdateInsertRequestConfigCouponTypeEnum;
|
|
356
406
|
/**
|
|
357
|
-
*
|
|
358
|
-
* @type {
|
|
407
|
+
*
|
|
408
|
+
* @type {Value}
|
|
359
409
|
* @memberof UpdateInsertRequestConfigCoupon
|
|
360
410
|
*/
|
|
361
|
-
'value':
|
|
411
|
+
'value': Value;
|
|
362
412
|
/**
|
|
363
413
|
* The minimum order value to apply the coupon to
|
|
364
414
|
* @type {number}
|
|
365
415
|
* @memberof UpdateInsertRequestConfigCoupon
|
|
366
416
|
*/
|
|
367
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;
|
|
368
424
|
/**
|
|
369
425
|
* The description of the coupon to apply to the insert
|
|
370
426
|
* @type {string}
|
|
@@ -375,8 +431,15 @@ export interface UpdateInsertRequestConfigCoupon {
|
|
|
375
431
|
export declare const UpdateInsertRequestConfigCouponTypeEnum: {
|
|
376
432
|
readonly Percentage: "percentage";
|
|
377
433
|
readonly Fixed: "fixed";
|
|
434
|
+
readonly Item: "item";
|
|
378
435
|
};
|
|
379
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;
|
|
380
443
|
/**
|
|
381
444
|
* InsertsApi - axios parameter creator
|
|
382
445
|
* @export
|
|
@@ -455,7 +518,7 @@ export declare const InsertsApiFp: (configuration?: Configuration) => {
|
|
|
455
518
|
* @param {*} [options] Override http request option.
|
|
456
519
|
* @throws {RequiredError}
|
|
457
520
|
*/
|
|
458
|
-
listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
521
|
+
listInserts(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>>;
|
|
459
522
|
/**
|
|
460
523
|
* Update an insert for a project
|
|
461
524
|
* @summary Update an insert
|
|
@@ -495,7 +558,7 @@ export declare const InsertsApiFactory: (configuration?: Configuration, basePath
|
|
|
495
558
|
* @param {*} [options] Override http request option.
|
|
496
559
|
* @throws {RequiredError}
|
|
497
560
|
*/
|
|
498
|
-
listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
561
|
+
listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1>;
|
|
499
562
|
/**
|
|
500
563
|
* Update an insert for a project
|
|
501
564
|
* @summary Update an insert
|
|
@@ -632,7 +695,7 @@ export declare class InsertsApi extends BaseAPI {
|
|
|
632
695
|
* @throws {RequiredError}
|
|
633
696
|
* @memberof InsertsApi
|
|
634
697
|
*/
|
|
635
|
-
listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
698
|
+
listInserts(requestParameters: InsertsApiListInsertsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject1, any>>;
|
|
636
699
|
/**
|
|
637
700
|
* Update an insert for a project
|
|
638
701
|
* @summary Update an insert
|
|
@@ -693,7 +756,7 @@ export declare const InsertsTypesApiFp: (configuration?: Configuration) => {
|
|
|
693
756
|
* @param {*} [options] Override http request option.
|
|
694
757
|
* @throws {RequiredError}
|
|
695
758
|
*/
|
|
696
|
-
listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
759
|
+
listInsertTypes(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
|
|
697
760
|
};
|
|
698
761
|
/**
|
|
699
762
|
* InsertsTypesApi - factory interface
|
|
@@ -715,7 +778,7 @@ export declare const InsertsTypesApiFactory: (configuration?: Configuration, bas
|
|
|
715
778
|
* @param {*} [options] Override http request option.
|
|
716
779
|
* @throws {RequiredError}
|
|
717
780
|
*/
|
|
718
|
-
listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
781
|
+
listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
|
|
719
782
|
};
|
|
720
783
|
/**
|
|
721
784
|
* Request parameters for getInsertType operation in InsertsTypesApi.
|
|
@@ -791,5 +854,5 @@ export declare class InsertsTypesApi extends BaseAPI {
|
|
|
791
854
|
* @throws {RequiredError}
|
|
792
855
|
* @memberof InsertsTypesApi
|
|
793
856
|
*/
|
|
794
|
-
listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
857
|
+
listInsertTypes(requestParameters: InsertsTypesApiListInsertTypesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
|
|
795
858
|
}
|
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.
|
|
8
|
+
* The version of the OpenAPI document: 0.4.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -31,15 +31,18 @@ const common_1 = require("./common");
|
|
|
31
31
|
const base_1 = require("./base");
|
|
32
32
|
exports.CreateInsertRequestConfigCouponTypeEnum = {
|
|
33
33
|
Percentage: 'percentage',
|
|
34
|
-
Fixed: 'fixed'
|
|
34
|
+
Fixed: 'fixed',
|
|
35
|
+
Item: 'item'
|
|
35
36
|
};
|
|
36
37
|
exports.InsertConfigCouponTypeEnum = {
|
|
37
38
|
Percentage: 'percentage',
|
|
38
|
-
Fixed: 'fixed'
|
|
39
|
+
Fixed: 'fixed',
|
|
40
|
+
Item: 'item'
|
|
39
41
|
};
|
|
40
42
|
exports.UpdateInsertRequestConfigCouponTypeEnum = {
|
|
41
43
|
Percentage: 'percentage',
|
|
42
|
-
Fixed: 'fixed'
|
|
44
|
+
Fixed: 'fixed',
|
|
45
|
+
Item: 'item'
|
|
43
46
|
};
|
|
44
47
|
/**
|
|
45
48
|
* InsertsApi - axios parameter creator
|
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.
|
|
5
|
+
* The version of the OpenAPI document: 0.4.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|