@teemill/platform 0.19.0 → 0.21.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.
- package/README.md +17 -2
- package/api.ts +1069 -53
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +689 -1
- package/dist/api.js +518 -2
- 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 +689 -1
- package/dist/esm/api.js +509 -1
- 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/Client.md +24 -0
- package/docs/EnquiriesApi.md +204 -0
- package/docs/Enquiry.md +42 -0
- package/docs/EnquiryExtraInputsInner.md +24 -0
- package/docs/EnquiryExtraInputsInnerValue.md +18 -0
- package/docs/ListCustomerEnquiries200Response.md +22 -0
- package/docs/ListCustomerEnquiryLogs200Response.md +20 -0
- package/docs/ListCustomerEnquiryLogs200ResponseLogsInner.md +22 -0
- package/docs/ListCustomerEnquiryLogs200ResponseLogsInnerCustomer.md +28 -0
- package/docs/SaveTermsRequest.md +24 -0
- package/docs/Terms.md +32 -0
- package/docs/TermsApi.md +127 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.21.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -110,6 +110,31 @@ export interface AuthorizeStripe200Response {
|
|
|
110
110
|
*/
|
|
111
111
|
'redirect_url': string;
|
|
112
112
|
}
|
|
113
|
+
/**
|
|
114
|
+
*
|
|
115
|
+
* @export
|
|
116
|
+
* @interface Client
|
|
117
|
+
*/
|
|
118
|
+
export interface Client {
|
|
119
|
+
/**
|
|
120
|
+
*
|
|
121
|
+
* @type {string}
|
|
122
|
+
* @memberof Client
|
|
123
|
+
*/
|
|
124
|
+
'id'?: string;
|
|
125
|
+
/**
|
|
126
|
+
* API reference for the client
|
|
127
|
+
* @type {string}
|
|
128
|
+
* @memberof Client
|
|
129
|
+
*/
|
|
130
|
+
'ref'?: string;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @type {string}
|
|
134
|
+
* @memberof Client
|
|
135
|
+
*/
|
|
136
|
+
'name'?: string;
|
|
137
|
+
}
|
|
113
138
|
/**
|
|
114
139
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
115
140
|
* @export
|
|
@@ -235,6 +260,125 @@ export interface DeliveryEstimates {
|
|
|
235
260
|
*/
|
|
236
261
|
'max'?: string;
|
|
237
262
|
}
|
|
263
|
+
/**
|
|
264
|
+
*
|
|
265
|
+
* @export
|
|
266
|
+
* @interface Enquiry
|
|
267
|
+
*/
|
|
268
|
+
export interface Enquiry {
|
|
269
|
+
/**
|
|
270
|
+
*
|
|
271
|
+
* @type {string}
|
|
272
|
+
* @memberof Enquiry
|
|
273
|
+
*/
|
|
274
|
+
'id': string;
|
|
275
|
+
/**
|
|
276
|
+
* API reference for the enquiry
|
|
277
|
+
* @type {string}
|
|
278
|
+
* @memberof Enquiry
|
|
279
|
+
*/
|
|
280
|
+
'ref': string;
|
|
281
|
+
/**
|
|
282
|
+
*
|
|
283
|
+
* @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
|
|
284
|
+
* @memberof Enquiry
|
|
285
|
+
*/
|
|
286
|
+
'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
|
|
287
|
+
/**
|
|
288
|
+
*
|
|
289
|
+
* @type {Client}
|
|
290
|
+
* @memberof Enquiry
|
|
291
|
+
*/
|
|
292
|
+
'client': Client;
|
|
293
|
+
/**
|
|
294
|
+
*
|
|
295
|
+
* @type {string}
|
|
296
|
+
* @memberof Enquiry
|
|
297
|
+
*/
|
|
298
|
+
'subject': string;
|
|
299
|
+
/**
|
|
300
|
+
*
|
|
301
|
+
* @type {string}
|
|
302
|
+
* @memberof Enquiry
|
|
303
|
+
*/
|
|
304
|
+
'body': string;
|
|
305
|
+
/**
|
|
306
|
+
*
|
|
307
|
+
* @type {string}
|
|
308
|
+
* @memberof Enquiry
|
|
309
|
+
*/
|
|
310
|
+
'createdAt': string;
|
|
311
|
+
/**
|
|
312
|
+
*
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof Enquiry
|
|
315
|
+
*/
|
|
316
|
+
'updatedAt': string;
|
|
317
|
+
/**
|
|
318
|
+
*
|
|
319
|
+
* @type {Array<string>}
|
|
320
|
+
* @memberof Enquiry
|
|
321
|
+
*/
|
|
322
|
+
'tags': Array<string>;
|
|
323
|
+
/**
|
|
324
|
+
*
|
|
325
|
+
* @type {string}
|
|
326
|
+
* @memberof Enquiry
|
|
327
|
+
*/
|
|
328
|
+
'status': EnquiryStatusEnum;
|
|
329
|
+
/**
|
|
330
|
+
*
|
|
331
|
+
* @type {boolean}
|
|
332
|
+
* @memberof Enquiry
|
|
333
|
+
*/
|
|
334
|
+
'read': boolean;
|
|
335
|
+
/**
|
|
336
|
+
*
|
|
337
|
+
* @type {Array<EnquiryExtraInputsInner>}
|
|
338
|
+
* @memberof Enquiry
|
|
339
|
+
*/
|
|
340
|
+
'extraInputs': Array<EnquiryExtraInputsInner> | null;
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
export const EnquiryStatusEnum = {
|
|
344
|
+
New: 'New',
|
|
345
|
+
Archived: 'Archived',
|
|
346
|
+
Priority: 'Priority'
|
|
347
|
+
} as const;
|
|
348
|
+
|
|
349
|
+
export type EnquiryStatusEnum = typeof EnquiryStatusEnum[keyof typeof EnquiryStatusEnum];
|
|
350
|
+
|
|
351
|
+
/**
|
|
352
|
+
*
|
|
353
|
+
* @export
|
|
354
|
+
* @interface EnquiryExtraInputsInner
|
|
355
|
+
*/
|
|
356
|
+
export interface EnquiryExtraInputsInner {
|
|
357
|
+
/**
|
|
358
|
+
*
|
|
359
|
+
* @type {string}
|
|
360
|
+
* @memberof EnquiryExtraInputsInner
|
|
361
|
+
*/
|
|
362
|
+
'name': string;
|
|
363
|
+
/**
|
|
364
|
+
*
|
|
365
|
+
* @type {string}
|
|
366
|
+
* @memberof EnquiryExtraInputsInner
|
|
367
|
+
*/
|
|
368
|
+
'type': string;
|
|
369
|
+
/**
|
|
370
|
+
*
|
|
371
|
+
* @type {EnquiryExtraInputsInnerValue}
|
|
372
|
+
* @memberof EnquiryExtraInputsInner
|
|
373
|
+
*/
|
|
374
|
+
'value': EnquiryExtraInputsInnerValue;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* @type EnquiryExtraInputsInnerValue
|
|
378
|
+
* @export
|
|
379
|
+
*/
|
|
380
|
+
export type EnquiryExtraInputsInnerValue = Array<string | null> | string;
|
|
381
|
+
|
|
238
382
|
/**
|
|
239
383
|
*
|
|
240
384
|
* @export
|
|
@@ -418,6 +562,94 @@ export interface Image {
|
|
|
418
562
|
*/
|
|
419
563
|
'sortOrder'?: number;
|
|
420
564
|
}
|
|
565
|
+
/**
|
|
566
|
+
*
|
|
567
|
+
* @export
|
|
568
|
+
* @interface ListCustomerEnquiries200Response
|
|
569
|
+
*/
|
|
570
|
+
export interface ListCustomerEnquiries200Response {
|
|
571
|
+
/**
|
|
572
|
+
*
|
|
573
|
+
* @type {Array<Enquiry>}
|
|
574
|
+
* @memberof ListCustomerEnquiries200Response
|
|
575
|
+
*/
|
|
576
|
+
'enquiries'?: Array<Enquiry>;
|
|
577
|
+
/**
|
|
578
|
+
*
|
|
579
|
+
* @type {number}
|
|
580
|
+
* @memberof ListCustomerEnquiries200Response
|
|
581
|
+
*/
|
|
582
|
+
'nextPageToken'?: number | null;
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
*
|
|
586
|
+
* @export
|
|
587
|
+
* @interface ListCustomerEnquiryLogs200Response
|
|
588
|
+
*/
|
|
589
|
+
export interface ListCustomerEnquiryLogs200Response {
|
|
590
|
+
/**
|
|
591
|
+
*
|
|
592
|
+
* @type {Array<ListCustomerEnquiryLogs200ResponseLogsInner>}
|
|
593
|
+
* @memberof ListCustomerEnquiryLogs200Response
|
|
594
|
+
*/
|
|
595
|
+
'logs': Array<ListCustomerEnquiryLogs200ResponseLogsInner>;
|
|
596
|
+
}
|
|
597
|
+
/**
|
|
598
|
+
*
|
|
599
|
+
* @export
|
|
600
|
+
* @interface ListCustomerEnquiryLogs200ResponseLogsInner
|
|
601
|
+
*/
|
|
602
|
+
export interface ListCustomerEnquiryLogs200ResponseLogsInner {
|
|
603
|
+
/**
|
|
604
|
+
*
|
|
605
|
+
* @type {ListCustomerEnquiryLogs200ResponseLogsInnerCustomer}
|
|
606
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInner
|
|
607
|
+
*/
|
|
608
|
+
'customer': ListCustomerEnquiryLogs200ResponseLogsInnerCustomer;
|
|
609
|
+
/**
|
|
610
|
+
*
|
|
611
|
+
* @type {string}
|
|
612
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInner
|
|
613
|
+
*/
|
|
614
|
+
'createdAt': string;
|
|
615
|
+
}
|
|
616
|
+
/**
|
|
617
|
+
*
|
|
618
|
+
* @export
|
|
619
|
+
* @interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
620
|
+
*/
|
|
621
|
+
export interface ListCustomerEnquiryLogs200ResponseLogsInnerCustomer {
|
|
622
|
+
/**
|
|
623
|
+
*
|
|
624
|
+
* @type {string}
|
|
625
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
626
|
+
*/
|
|
627
|
+
'id'?: string;
|
|
628
|
+
/**
|
|
629
|
+
* API reference for the customer
|
|
630
|
+
* @type {string}
|
|
631
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
632
|
+
*/
|
|
633
|
+
'ref'?: string;
|
|
634
|
+
/**
|
|
635
|
+
*
|
|
636
|
+
* @type {string}
|
|
637
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
638
|
+
*/
|
|
639
|
+
'firstName'?: string;
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @type {string}
|
|
643
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
644
|
+
*/
|
|
645
|
+
'lastName'?: string;
|
|
646
|
+
/**
|
|
647
|
+
*
|
|
648
|
+
* @type {string}
|
|
649
|
+
* @memberof ListCustomerEnquiryLogs200ResponseLogsInnerCustomer
|
|
650
|
+
*/
|
|
651
|
+
'email'?: string;
|
|
652
|
+
}
|
|
421
653
|
/**
|
|
422
654
|
*
|
|
423
655
|
* @export
|
|
@@ -1142,6 +1374,31 @@ export interface ReviewsResponse {
|
|
|
1142
1374
|
*/
|
|
1143
1375
|
'nextPageToken'?: number | null;
|
|
1144
1376
|
}
|
|
1377
|
+
/**
|
|
1378
|
+
*
|
|
1379
|
+
* @export
|
|
1380
|
+
* @interface SaveTermsRequest
|
|
1381
|
+
*/
|
|
1382
|
+
export interface SaveTermsRequest {
|
|
1383
|
+
/**
|
|
1384
|
+
*
|
|
1385
|
+
* @type {string}
|
|
1386
|
+
* @memberof SaveTermsRequest
|
|
1387
|
+
*/
|
|
1388
|
+
'title': string;
|
|
1389
|
+
/**
|
|
1390
|
+
*
|
|
1391
|
+
* @type {string}
|
|
1392
|
+
* @memberof SaveTermsRequest
|
|
1393
|
+
*/
|
|
1394
|
+
'content': string;
|
|
1395
|
+
/**
|
|
1396
|
+
*
|
|
1397
|
+
* @type {boolean}
|
|
1398
|
+
* @memberof SaveTermsRequest
|
|
1399
|
+
*/
|
|
1400
|
+
'enabled': boolean;
|
|
1401
|
+
}
|
|
1145
1402
|
/**
|
|
1146
1403
|
*
|
|
1147
1404
|
* @export
|
|
@@ -1243,6 +1500,55 @@ export interface StatusHistoryItem {
|
|
|
1243
1500
|
}
|
|
1244
1501
|
|
|
1245
1502
|
|
|
1503
|
+
/**
|
|
1504
|
+
*
|
|
1505
|
+
* @export
|
|
1506
|
+
* @interface Terms
|
|
1507
|
+
*/
|
|
1508
|
+
export interface Terms {
|
|
1509
|
+
/**
|
|
1510
|
+
*
|
|
1511
|
+
* @type {string}
|
|
1512
|
+
* @memberof Terms
|
|
1513
|
+
*/
|
|
1514
|
+
'id': string;
|
|
1515
|
+
/**
|
|
1516
|
+
*
|
|
1517
|
+
* @type {string}
|
|
1518
|
+
* @memberof Terms
|
|
1519
|
+
*/
|
|
1520
|
+
'title': string;
|
|
1521
|
+
/**
|
|
1522
|
+
*
|
|
1523
|
+
* @type {string}
|
|
1524
|
+
* @memberof Terms
|
|
1525
|
+
*/
|
|
1526
|
+
'content': string;
|
|
1527
|
+
/**
|
|
1528
|
+
*
|
|
1529
|
+
* @type {number}
|
|
1530
|
+
* @memberof Terms
|
|
1531
|
+
*/
|
|
1532
|
+
'version': number;
|
|
1533
|
+
/**
|
|
1534
|
+
*
|
|
1535
|
+
* @type {boolean}
|
|
1536
|
+
* @memberof Terms
|
|
1537
|
+
*/
|
|
1538
|
+
'enabled': boolean;
|
|
1539
|
+
/**
|
|
1540
|
+
*
|
|
1541
|
+
* @type {string}
|
|
1542
|
+
* @memberof Terms
|
|
1543
|
+
*/
|
|
1544
|
+
'createdAt': string;
|
|
1545
|
+
/**
|
|
1546
|
+
*
|
|
1547
|
+
* @type {string}
|
|
1548
|
+
* @memberof Terms
|
|
1549
|
+
*/
|
|
1550
|
+
'updatedAt': string;
|
|
1551
|
+
}
|
|
1246
1552
|
/**
|
|
1247
1553
|
*
|
|
1248
1554
|
* @export
|
|
@@ -1820,91 +2126,538 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1820
2126
|
* @type {number}
|
|
1821
2127
|
* @memberof CustomersApiListCustomers
|
|
1822
2128
|
*/
|
|
1823
|
-
readonly lifetimeValue?: number
|
|
2129
|
+
readonly lifetimeValue?: number
|
|
2130
|
+
|
|
2131
|
+
/**
|
|
2132
|
+
* Start of date range to filter customers by last purchase date
|
|
2133
|
+
* @type {string}
|
|
2134
|
+
* @memberof CustomersApiListCustomers
|
|
2135
|
+
*/
|
|
2136
|
+
readonly lastPurchasedStart?: string
|
|
2137
|
+
|
|
2138
|
+
/**
|
|
2139
|
+
* End of date range to filter customers by last purchase date
|
|
2140
|
+
* @type {string}
|
|
2141
|
+
* @memberof CustomersApiListCustomers
|
|
2142
|
+
*/
|
|
2143
|
+
readonly lastPurchasedEnd?: string
|
|
2144
|
+
}
|
|
2145
|
+
|
|
2146
|
+
/**
|
|
2147
|
+
* CustomersApi - object-oriented interface
|
|
2148
|
+
* @export
|
|
2149
|
+
* @class CustomersApi
|
|
2150
|
+
* @extends {BaseAPI}
|
|
2151
|
+
*/
|
|
2152
|
+
export class CustomersApi extends BaseAPI {
|
|
2153
|
+
/**
|
|
2154
|
+
* Export customers as a CSV file
|
|
2155
|
+
* @summary Export customers
|
|
2156
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
2157
|
+
* @param {*} [options] Override http request option.
|
|
2158
|
+
* @throws {RequiredError}
|
|
2159
|
+
* @memberof CustomersApi
|
|
2160
|
+
*/
|
|
2161
|
+
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2162
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2163
|
+
}
|
|
2164
|
+
|
|
2165
|
+
/**
|
|
2166
|
+
* Get a customer for a platform by a given customer ID.
|
|
2167
|
+
* @summary Get customer
|
|
2168
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
2169
|
+
* @param {*} [options] Override http request option.
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
* @memberof CustomersApi
|
|
2172
|
+
*/
|
|
2173
|
+
public getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig) {
|
|
2174
|
+
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2175
|
+
}
|
|
2176
|
+
|
|
2177
|
+
/**
|
|
2178
|
+
* List customers for a platform
|
|
2179
|
+
* @summary List customers
|
|
2180
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
2181
|
+
* @param {*} [options] Override http request option.
|
|
2182
|
+
* @throws {RequiredError}
|
|
2183
|
+
* @memberof CustomersApi
|
|
2184
|
+
*/
|
|
2185
|
+
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2186
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2187
|
+
}
|
|
2188
|
+
}
|
|
2189
|
+
|
|
2190
|
+
/**
|
|
2191
|
+
* @export
|
|
2192
|
+
*/
|
|
2193
|
+
export const ExportCustomersSortByEnum = {
|
|
2194
|
+
LifetimeValue: '+lifetimeValue',
|
|
2195
|
+
LifetimeValue2: '-lifetimeValue',
|
|
2196
|
+
TotalOrderCount: '+totalOrderCount',
|
|
2197
|
+
TotalOrderCount2: '-totalOrderCount',
|
|
2198
|
+
LastPurchased: '+lastPurchased',
|
|
2199
|
+
LastPurchased2: '-lastPurchased'
|
|
2200
|
+
} as const;
|
|
2201
|
+
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
2202
|
+
/**
|
|
2203
|
+
* @export
|
|
2204
|
+
*/
|
|
2205
|
+
export const ListCustomersSortByEnum = {
|
|
2206
|
+
LifetimeValue: '+lifetimeValue',
|
|
2207
|
+
LifetimeValue2: '-lifetimeValue',
|
|
2208
|
+
TotalOrderCount: '+totalOrderCount',
|
|
2209
|
+
TotalOrderCount2: '-totalOrderCount',
|
|
2210
|
+
LastPurchased: '+lastPurchased',
|
|
2211
|
+
LastPurchased2: '-lastPurchased'
|
|
2212
|
+
} as const;
|
|
2213
|
+
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
/**
|
|
2217
|
+
* EnquiriesApi - axios parameter creator
|
|
2218
|
+
* @export
|
|
2219
|
+
*/
|
|
2220
|
+
export const EnquiriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2221
|
+
return {
|
|
2222
|
+
/**
|
|
2223
|
+
* Get a customer enquiry
|
|
2224
|
+
* @summary Get customer enquiry
|
|
2225
|
+
* @param {string} project Project unique identifier
|
|
2226
|
+
* @param {string} platformId The platform identifier
|
|
2227
|
+
* @param {string} enquiryId
|
|
2228
|
+
* @param {*} [options] Override http request option.
|
|
2229
|
+
* @throws {RequiredError}
|
|
2230
|
+
*/
|
|
2231
|
+
getCustomerEnquiry: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2232
|
+
// verify required parameter 'project' is not null or undefined
|
|
2233
|
+
assertParamExists('getCustomerEnquiry', 'project', project)
|
|
2234
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2235
|
+
assertParamExists('getCustomerEnquiry', 'platformId', platformId)
|
|
2236
|
+
// verify required parameter 'enquiryId' is not null or undefined
|
|
2237
|
+
assertParamExists('getCustomerEnquiry', 'enquiryId', enquiryId)
|
|
2238
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}`
|
|
2239
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2240
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
2241
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2242
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2243
|
+
let baseOptions;
|
|
2244
|
+
if (configuration) {
|
|
2245
|
+
baseOptions = configuration.baseOptions;
|
|
2246
|
+
}
|
|
2247
|
+
|
|
2248
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2249
|
+
const localVarHeaderParameter = {} as any;
|
|
2250
|
+
const localVarQueryParameter = {} as any;
|
|
2251
|
+
|
|
2252
|
+
// authentication session-oauth required
|
|
2253
|
+
// oauth required
|
|
2254
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2255
|
+
|
|
2256
|
+
// authentication api-key required
|
|
2257
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2258
|
+
|
|
2259
|
+
if (project !== undefined) {
|
|
2260
|
+
localVarQueryParameter['project'] = project;
|
|
2261
|
+
}
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2266
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2267
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2268
|
+
|
|
2269
|
+
return {
|
|
2270
|
+
url: toPathString(localVarUrlObj),
|
|
2271
|
+
options: localVarRequestOptions,
|
|
2272
|
+
};
|
|
2273
|
+
},
|
|
2274
|
+
/**
|
|
2275
|
+
* List customer enquiries
|
|
2276
|
+
* @summary List customer enquiries
|
|
2277
|
+
* @param {string} project Project unique identifier
|
|
2278
|
+
* @param {string} platformId The platform identifier
|
|
2279
|
+
* @param {number} [pageToken] Page reference token
|
|
2280
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2281
|
+
* @param {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
|
|
2282
|
+
* @param {string} [start] Start of date range to filter by
|
|
2283
|
+
* @param {string} [end] End of date range to filter by
|
|
2284
|
+
* @param {*} [options] Override http request option.
|
|
2285
|
+
* @throws {RequiredError}
|
|
2286
|
+
*/
|
|
2287
|
+
listCustomerEnquiries: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2288
|
+
// verify required parameter 'project' is not null or undefined
|
|
2289
|
+
assertParamExists('listCustomerEnquiries', 'project', project)
|
|
2290
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2291
|
+
assertParamExists('listCustomerEnquiries', 'platformId', platformId)
|
|
2292
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries`
|
|
2293
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2294
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2295
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2296
|
+
let baseOptions;
|
|
2297
|
+
if (configuration) {
|
|
2298
|
+
baseOptions = configuration.baseOptions;
|
|
2299
|
+
}
|
|
2300
|
+
|
|
2301
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2302
|
+
const localVarHeaderParameter = {} as any;
|
|
2303
|
+
const localVarQueryParameter = {} as any;
|
|
2304
|
+
|
|
2305
|
+
// authentication session-oauth required
|
|
2306
|
+
// oauth required
|
|
2307
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2308
|
+
|
|
2309
|
+
// authentication api-key required
|
|
2310
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2311
|
+
|
|
2312
|
+
if (project !== undefined) {
|
|
2313
|
+
localVarQueryParameter['project'] = project;
|
|
2314
|
+
}
|
|
2315
|
+
|
|
2316
|
+
if (pageToken !== undefined) {
|
|
2317
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2318
|
+
}
|
|
2319
|
+
|
|
2320
|
+
if (pageSize !== undefined) {
|
|
2321
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2322
|
+
}
|
|
2323
|
+
|
|
2324
|
+
if (search !== undefined) {
|
|
2325
|
+
localVarQueryParameter['search'] = search;
|
|
2326
|
+
}
|
|
2327
|
+
|
|
2328
|
+
if (start !== undefined) {
|
|
2329
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
2330
|
+
(start as any).toISOString() :
|
|
2331
|
+
start;
|
|
2332
|
+
}
|
|
2333
|
+
|
|
2334
|
+
if (end !== undefined) {
|
|
2335
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
2336
|
+
(end as any).toISOString() :
|
|
2337
|
+
end;
|
|
2338
|
+
}
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2343
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2344
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2345
|
+
|
|
2346
|
+
return {
|
|
2347
|
+
url: toPathString(localVarUrlObj),
|
|
2348
|
+
options: localVarRequestOptions,
|
|
2349
|
+
};
|
|
2350
|
+
},
|
|
2351
|
+
/**
|
|
2352
|
+
* Lists all customer enquiry Logs
|
|
2353
|
+
* @summary List customer enquiry Logs
|
|
2354
|
+
* @param {string} project Project unique identifier
|
|
2355
|
+
* @param {string} platformId The platform identifier
|
|
2356
|
+
* @param {string} enquiryId
|
|
2357
|
+
* @param {*} [options] Override http request option.
|
|
2358
|
+
* @throws {RequiredError}
|
|
2359
|
+
*/
|
|
2360
|
+
listCustomerEnquiryLogs: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2361
|
+
// verify required parameter 'project' is not null or undefined
|
|
2362
|
+
assertParamExists('listCustomerEnquiryLogs', 'project', project)
|
|
2363
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2364
|
+
assertParamExists('listCustomerEnquiryLogs', 'platformId', platformId)
|
|
2365
|
+
// verify required parameter 'enquiryId' is not null or undefined
|
|
2366
|
+
assertParamExists('listCustomerEnquiryLogs', 'enquiryId', enquiryId)
|
|
2367
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs`
|
|
2368
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2369
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
2370
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2371
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2372
|
+
let baseOptions;
|
|
2373
|
+
if (configuration) {
|
|
2374
|
+
baseOptions = configuration.baseOptions;
|
|
2375
|
+
}
|
|
2376
|
+
|
|
2377
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2378
|
+
const localVarHeaderParameter = {} as any;
|
|
2379
|
+
const localVarQueryParameter = {} as any;
|
|
2380
|
+
|
|
2381
|
+
// authentication session-oauth required
|
|
2382
|
+
// oauth required
|
|
2383
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2384
|
+
|
|
2385
|
+
// authentication api-key required
|
|
2386
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2387
|
+
|
|
2388
|
+
if (project !== undefined) {
|
|
2389
|
+
localVarQueryParameter['project'] = project;
|
|
2390
|
+
}
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2395
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2396
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2397
|
+
|
|
2398
|
+
return {
|
|
2399
|
+
url: toPathString(localVarUrlObj),
|
|
2400
|
+
options: localVarRequestOptions,
|
|
2401
|
+
};
|
|
2402
|
+
},
|
|
2403
|
+
}
|
|
2404
|
+
};
|
|
2405
|
+
|
|
2406
|
+
/**
|
|
2407
|
+
* EnquiriesApi - functional programming interface
|
|
2408
|
+
* @export
|
|
2409
|
+
*/
|
|
2410
|
+
export const EnquiriesApiFp = function(configuration?: Configuration) {
|
|
2411
|
+
const localVarAxiosParamCreator = EnquiriesApiAxiosParamCreator(configuration)
|
|
2412
|
+
return {
|
|
2413
|
+
/**
|
|
2414
|
+
* Get a customer enquiry
|
|
2415
|
+
* @summary Get customer enquiry
|
|
2416
|
+
* @param {string} project Project unique identifier
|
|
2417
|
+
* @param {string} platformId The platform identifier
|
|
2418
|
+
* @param {string} enquiryId
|
|
2419
|
+
* @param {*} [options] Override http request option.
|
|
2420
|
+
* @throws {RequiredError}
|
|
2421
|
+
*/
|
|
2422
|
+
async getCustomerEnquiry(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Enquiry>> {
|
|
2423
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomerEnquiry(project, platformId, enquiryId, options);
|
|
2424
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2425
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.getCustomerEnquiry']?.[localVarOperationServerIndex]?.url;
|
|
2426
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2427
|
+
},
|
|
2428
|
+
/**
|
|
2429
|
+
* List customer enquiries
|
|
2430
|
+
* @summary List customer enquiries
|
|
2431
|
+
* @param {string} project Project unique identifier
|
|
2432
|
+
* @param {string} platformId The platform identifier
|
|
2433
|
+
* @param {number} [pageToken] Page reference token
|
|
2434
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2435
|
+
* @param {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
|
|
2436
|
+
* @param {string} [start] Start of date range to filter by
|
|
2437
|
+
* @param {string} [end] End of date range to filter by
|
|
2438
|
+
* @param {*} [options] Override http request option.
|
|
2439
|
+
* @throws {RequiredError}
|
|
2440
|
+
*/
|
|
2441
|
+
async listCustomerEnquiries(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiries200Response>> {
|
|
2442
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomerEnquiries(project, platformId, pageToken, pageSize, search, start, end, options);
|
|
2443
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2444
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.listCustomerEnquiries']?.[localVarOperationServerIndex]?.url;
|
|
2445
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2446
|
+
},
|
|
2447
|
+
/**
|
|
2448
|
+
* Lists all customer enquiry Logs
|
|
2449
|
+
* @summary List customer enquiry Logs
|
|
2450
|
+
* @param {string} project Project unique identifier
|
|
2451
|
+
* @param {string} platformId The platform identifier
|
|
2452
|
+
* @param {string} enquiryId
|
|
2453
|
+
* @param {*} [options] Override http request option.
|
|
2454
|
+
* @throws {RequiredError}
|
|
2455
|
+
*/
|
|
2456
|
+
async listCustomerEnquiryLogs(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiryLogs200Response>> {
|
|
2457
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomerEnquiryLogs(project, platformId, enquiryId, options);
|
|
2458
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2459
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.listCustomerEnquiryLogs']?.[localVarOperationServerIndex]?.url;
|
|
2460
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2461
|
+
},
|
|
2462
|
+
}
|
|
2463
|
+
};
|
|
2464
|
+
|
|
2465
|
+
/**
|
|
2466
|
+
* EnquiriesApi - factory interface
|
|
2467
|
+
* @export
|
|
2468
|
+
*/
|
|
2469
|
+
export const EnquiriesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2470
|
+
const localVarFp = EnquiriesApiFp(configuration)
|
|
2471
|
+
return {
|
|
2472
|
+
/**
|
|
2473
|
+
* Get a customer enquiry
|
|
2474
|
+
* @summary Get customer enquiry
|
|
2475
|
+
* @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
|
|
2476
|
+
* @param {*} [options] Override http request option.
|
|
2477
|
+
* @throws {RequiredError}
|
|
2478
|
+
*/
|
|
2479
|
+
getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry> {
|
|
2480
|
+
return localVarFp.getCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2481
|
+
},
|
|
2482
|
+
/**
|
|
2483
|
+
* List customer enquiries
|
|
2484
|
+
* @summary List customer enquiries
|
|
2485
|
+
* @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
|
|
2486
|
+
* @param {*} [options] Override http request option.
|
|
2487
|
+
* @throws {RequiredError}
|
|
2488
|
+
*/
|
|
2489
|
+
listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiries200Response> {
|
|
2490
|
+
return localVarFp.listCustomerEnquiries(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
2491
|
+
},
|
|
2492
|
+
/**
|
|
2493
|
+
* Lists all customer enquiry Logs
|
|
2494
|
+
* @summary List customer enquiry Logs
|
|
2495
|
+
* @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
|
|
2496
|
+
* @param {*} [options] Override http request option.
|
|
2497
|
+
* @throws {RequiredError}
|
|
2498
|
+
*/
|
|
2499
|
+
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response> {
|
|
2500
|
+
return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2501
|
+
},
|
|
2502
|
+
};
|
|
2503
|
+
};
|
|
2504
|
+
|
|
2505
|
+
/**
|
|
2506
|
+
* Request parameters for getCustomerEnquiry operation in EnquiriesApi.
|
|
2507
|
+
* @export
|
|
2508
|
+
* @interface EnquiriesApiGetCustomerEnquiryRequest
|
|
2509
|
+
*/
|
|
2510
|
+
export interface EnquiriesApiGetCustomerEnquiryRequest {
|
|
2511
|
+
/**
|
|
2512
|
+
* Project unique identifier
|
|
2513
|
+
* @type {string}
|
|
2514
|
+
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
2515
|
+
*/
|
|
2516
|
+
readonly project: string
|
|
2517
|
+
|
|
2518
|
+
/**
|
|
2519
|
+
* The platform identifier
|
|
2520
|
+
* @type {string}
|
|
2521
|
+
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
2522
|
+
*/
|
|
2523
|
+
readonly platformId: string
|
|
2524
|
+
|
|
2525
|
+
/**
|
|
2526
|
+
*
|
|
2527
|
+
* @type {string}
|
|
2528
|
+
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
2529
|
+
*/
|
|
2530
|
+
readonly enquiryId: string
|
|
2531
|
+
}
|
|
2532
|
+
|
|
2533
|
+
/**
|
|
2534
|
+
* Request parameters for listCustomerEnquiries operation in EnquiriesApi.
|
|
2535
|
+
* @export
|
|
2536
|
+
* @interface EnquiriesApiListCustomerEnquiriesRequest
|
|
2537
|
+
*/
|
|
2538
|
+
export interface EnquiriesApiListCustomerEnquiriesRequest {
|
|
2539
|
+
/**
|
|
2540
|
+
* Project unique identifier
|
|
2541
|
+
* @type {string}
|
|
2542
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2543
|
+
*/
|
|
2544
|
+
readonly project: string
|
|
2545
|
+
|
|
2546
|
+
/**
|
|
2547
|
+
* The platform identifier
|
|
2548
|
+
* @type {string}
|
|
2549
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2550
|
+
*/
|
|
2551
|
+
readonly platformId: string
|
|
2552
|
+
|
|
2553
|
+
/**
|
|
2554
|
+
* Page reference token
|
|
2555
|
+
* @type {number}
|
|
2556
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2557
|
+
*/
|
|
2558
|
+
readonly pageToken?: number
|
|
2559
|
+
|
|
2560
|
+
/**
|
|
2561
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2562
|
+
* @type {number}
|
|
2563
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2564
|
+
*/
|
|
2565
|
+
readonly pageSize?: number
|
|
2566
|
+
|
|
2567
|
+
/**
|
|
2568
|
+
* Search term to filter based on enquiry title, content, customer name and customer email.
|
|
2569
|
+
* @type {string}
|
|
2570
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2571
|
+
*/
|
|
2572
|
+
readonly search?: string
|
|
2573
|
+
|
|
2574
|
+
/**
|
|
2575
|
+
* Start of date range to filter by
|
|
2576
|
+
* @type {string}
|
|
2577
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2578
|
+
*/
|
|
2579
|
+
readonly start?: string
|
|
2580
|
+
|
|
2581
|
+
/**
|
|
2582
|
+
* End of date range to filter by
|
|
2583
|
+
* @type {string}
|
|
2584
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2585
|
+
*/
|
|
2586
|
+
readonly end?: string
|
|
2587
|
+
}
|
|
2588
|
+
|
|
2589
|
+
/**
|
|
2590
|
+
* Request parameters for listCustomerEnquiryLogs operation in EnquiriesApi.
|
|
2591
|
+
* @export
|
|
2592
|
+
* @interface EnquiriesApiListCustomerEnquiryLogsRequest
|
|
2593
|
+
*/
|
|
2594
|
+
export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
2595
|
+
/**
|
|
2596
|
+
* Project unique identifier
|
|
2597
|
+
* @type {string}
|
|
2598
|
+
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
2599
|
+
*/
|
|
2600
|
+
readonly project: string
|
|
1824
2601
|
|
|
1825
2602
|
/**
|
|
1826
|
-
*
|
|
2603
|
+
* The platform identifier
|
|
1827
2604
|
* @type {string}
|
|
1828
|
-
* @memberof
|
|
2605
|
+
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
1829
2606
|
*/
|
|
1830
|
-
readonly
|
|
2607
|
+
readonly platformId: string
|
|
1831
2608
|
|
|
1832
2609
|
/**
|
|
1833
|
-
*
|
|
2610
|
+
*
|
|
1834
2611
|
* @type {string}
|
|
1835
|
-
* @memberof
|
|
2612
|
+
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
1836
2613
|
*/
|
|
1837
|
-
readonly
|
|
2614
|
+
readonly enquiryId: string
|
|
1838
2615
|
}
|
|
1839
2616
|
|
|
1840
2617
|
/**
|
|
1841
|
-
*
|
|
2618
|
+
* EnquiriesApi - object-oriented interface
|
|
1842
2619
|
* @export
|
|
1843
|
-
* @class
|
|
2620
|
+
* @class EnquiriesApi
|
|
1844
2621
|
* @extends {BaseAPI}
|
|
1845
2622
|
*/
|
|
1846
|
-
export class
|
|
2623
|
+
export class EnquiriesApi extends BaseAPI {
|
|
1847
2624
|
/**
|
|
1848
|
-
*
|
|
1849
|
-
* @summary
|
|
1850
|
-
* @param {
|
|
2625
|
+
* Get a customer enquiry
|
|
2626
|
+
* @summary Get customer enquiry
|
|
2627
|
+
* @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
|
|
1851
2628
|
* @param {*} [options] Override http request option.
|
|
1852
2629
|
* @throws {RequiredError}
|
|
1853
|
-
* @memberof
|
|
2630
|
+
* @memberof EnquiriesApi
|
|
1854
2631
|
*/
|
|
1855
|
-
public
|
|
1856
|
-
return
|
|
2632
|
+
public getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig) {
|
|
2633
|
+
return EnquiriesApiFp(this.configuration).getCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
1857
2634
|
}
|
|
1858
2635
|
|
|
1859
2636
|
/**
|
|
1860
|
-
*
|
|
1861
|
-
* @summary
|
|
1862
|
-
* @param {
|
|
2637
|
+
* List customer enquiries
|
|
2638
|
+
* @summary List customer enquiries
|
|
2639
|
+
* @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
|
|
1863
2640
|
* @param {*} [options] Override http request option.
|
|
1864
2641
|
* @throws {RequiredError}
|
|
1865
|
-
* @memberof
|
|
2642
|
+
* @memberof EnquiriesApi
|
|
1866
2643
|
*/
|
|
1867
|
-
public
|
|
1868
|
-
return
|
|
2644
|
+
public listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig) {
|
|
2645
|
+
return EnquiriesApiFp(this.configuration).listCustomerEnquiries(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1869
2646
|
}
|
|
1870
2647
|
|
|
1871
2648
|
/**
|
|
1872
|
-
*
|
|
1873
|
-
* @summary List
|
|
1874
|
-
* @param {
|
|
2649
|
+
* Lists all customer enquiry Logs
|
|
2650
|
+
* @summary List customer enquiry Logs
|
|
2651
|
+
* @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
|
|
1875
2652
|
* @param {*} [options] Override http request option.
|
|
1876
2653
|
* @throws {RequiredError}
|
|
1877
|
-
* @memberof
|
|
2654
|
+
* @memberof EnquiriesApi
|
|
1878
2655
|
*/
|
|
1879
|
-
public
|
|
1880
|
-
return
|
|
2656
|
+
public listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig) {
|
|
2657
|
+
return EnquiriesApiFp(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
1881
2658
|
}
|
|
1882
2659
|
}
|
|
1883
2660
|
|
|
1884
|
-
/**
|
|
1885
|
-
* @export
|
|
1886
|
-
*/
|
|
1887
|
-
export const ExportCustomersSortByEnum = {
|
|
1888
|
-
LifetimeValue: '+lifetimeValue',
|
|
1889
|
-
LifetimeValue2: '-lifetimeValue',
|
|
1890
|
-
TotalOrderCount: '+totalOrderCount',
|
|
1891
|
-
TotalOrderCount2: '-totalOrderCount',
|
|
1892
|
-
LastPurchased: '+lastPurchased',
|
|
1893
|
-
LastPurchased2: '-lastPurchased'
|
|
1894
|
-
} as const;
|
|
1895
|
-
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
1896
|
-
/**
|
|
1897
|
-
* @export
|
|
1898
|
-
*/
|
|
1899
|
-
export const ListCustomersSortByEnum = {
|
|
1900
|
-
LifetimeValue: '+lifetimeValue',
|
|
1901
|
-
LifetimeValue2: '-lifetimeValue',
|
|
1902
|
-
TotalOrderCount: '+totalOrderCount',
|
|
1903
|
-
TotalOrderCount2: '-totalOrderCount',
|
|
1904
|
-
LastPurchased: '+lastPurchased',
|
|
1905
|
-
LastPurchased2: '-lastPurchased'
|
|
1906
|
-
} as const;
|
|
1907
|
-
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
1908
2661
|
|
|
1909
2662
|
|
|
1910
2663
|
/**
|
|
@@ -4057,3 +4810,266 @@ export class ReviewsApi extends BaseAPI {
|
|
|
4057
4810
|
|
|
4058
4811
|
|
|
4059
4812
|
|
|
4813
|
+
/**
|
|
4814
|
+
* TermsApi - axios parameter creator
|
|
4815
|
+
* @export
|
|
4816
|
+
*/
|
|
4817
|
+
export const TermsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
4818
|
+
return {
|
|
4819
|
+
/**
|
|
4820
|
+
*
|
|
4821
|
+
* @summary Get the platform\'s terms
|
|
4822
|
+
* @param {string} project Project unique identifier
|
|
4823
|
+
* @param {string} platformId The platform identifier
|
|
4824
|
+
* @param {*} [options] Override http request option.
|
|
4825
|
+
* @throws {RequiredError}
|
|
4826
|
+
*/
|
|
4827
|
+
getTerms: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4828
|
+
// verify required parameter 'project' is not null or undefined
|
|
4829
|
+
assertParamExists('getTerms', 'project', project)
|
|
4830
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
4831
|
+
assertParamExists('getTerms', 'platformId', platformId)
|
|
4832
|
+
const localVarPath = `/v1/platform/{platformId}/terms`
|
|
4833
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
4834
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4835
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4836
|
+
let baseOptions;
|
|
4837
|
+
if (configuration) {
|
|
4838
|
+
baseOptions = configuration.baseOptions;
|
|
4839
|
+
}
|
|
4840
|
+
|
|
4841
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
4842
|
+
const localVarHeaderParameter = {} as any;
|
|
4843
|
+
const localVarQueryParameter = {} as any;
|
|
4844
|
+
|
|
4845
|
+
// authentication session-oauth required
|
|
4846
|
+
// oauth required
|
|
4847
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
4848
|
+
|
|
4849
|
+
// authentication api-key required
|
|
4850
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4851
|
+
|
|
4852
|
+
if (project !== undefined) {
|
|
4853
|
+
localVarQueryParameter['project'] = project;
|
|
4854
|
+
}
|
|
4855
|
+
|
|
4856
|
+
|
|
4857
|
+
|
|
4858
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4859
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4860
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4861
|
+
|
|
4862
|
+
return {
|
|
4863
|
+
url: toPathString(localVarUrlObj),
|
|
4864
|
+
options: localVarRequestOptions,
|
|
4865
|
+
};
|
|
4866
|
+
},
|
|
4867
|
+
/**
|
|
4868
|
+
*
|
|
4869
|
+
* @summary Save the platform\'s terms
|
|
4870
|
+
* @param {string} project Project unique identifier
|
|
4871
|
+
* @param {string} platformId The platform identifier
|
|
4872
|
+
* @param {SaveTermsRequest} saveTermsRequest Save terms
|
|
4873
|
+
* @param {*} [options] Override http request option.
|
|
4874
|
+
* @throws {RequiredError}
|
|
4875
|
+
*/
|
|
4876
|
+
saveTerms: async (project: string, platformId: string, saveTermsRequest: SaveTermsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
4877
|
+
// verify required parameter 'project' is not null or undefined
|
|
4878
|
+
assertParamExists('saveTerms', 'project', project)
|
|
4879
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
4880
|
+
assertParamExists('saveTerms', 'platformId', platformId)
|
|
4881
|
+
// verify required parameter 'saveTermsRequest' is not null or undefined
|
|
4882
|
+
assertParamExists('saveTerms', 'saveTermsRequest', saveTermsRequest)
|
|
4883
|
+
const localVarPath = `/v1/platform/{platformId}/terms`
|
|
4884
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
4885
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4886
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4887
|
+
let baseOptions;
|
|
4888
|
+
if (configuration) {
|
|
4889
|
+
baseOptions = configuration.baseOptions;
|
|
4890
|
+
}
|
|
4891
|
+
|
|
4892
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
4893
|
+
const localVarHeaderParameter = {} as any;
|
|
4894
|
+
const localVarQueryParameter = {} as any;
|
|
4895
|
+
|
|
4896
|
+
// authentication session-oauth required
|
|
4897
|
+
// oauth required
|
|
4898
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
4899
|
+
|
|
4900
|
+
// authentication api-key required
|
|
4901
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
4902
|
+
|
|
4903
|
+
if (project !== undefined) {
|
|
4904
|
+
localVarQueryParameter['project'] = project;
|
|
4905
|
+
}
|
|
4906
|
+
|
|
4907
|
+
|
|
4908
|
+
|
|
4909
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
4910
|
+
|
|
4911
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4912
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
4913
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
4914
|
+
localVarRequestOptions.data = serializeDataIfNeeded(saveTermsRequest, localVarRequestOptions, configuration)
|
|
4915
|
+
|
|
4916
|
+
return {
|
|
4917
|
+
url: toPathString(localVarUrlObj),
|
|
4918
|
+
options: localVarRequestOptions,
|
|
4919
|
+
};
|
|
4920
|
+
},
|
|
4921
|
+
}
|
|
4922
|
+
};
|
|
4923
|
+
|
|
4924
|
+
/**
|
|
4925
|
+
* TermsApi - functional programming interface
|
|
4926
|
+
* @export
|
|
4927
|
+
*/
|
|
4928
|
+
export const TermsApiFp = function(configuration?: Configuration) {
|
|
4929
|
+
const localVarAxiosParamCreator = TermsApiAxiosParamCreator(configuration)
|
|
4930
|
+
return {
|
|
4931
|
+
/**
|
|
4932
|
+
*
|
|
4933
|
+
* @summary Get the platform\'s terms
|
|
4934
|
+
* @param {string} project Project unique identifier
|
|
4935
|
+
* @param {string} platformId The platform identifier
|
|
4936
|
+
* @param {*} [options] Override http request option.
|
|
4937
|
+
* @throws {RequiredError}
|
|
4938
|
+
*/
|
|
4939
|
+
async getTerms(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Terms>> {
|
|
4940
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getTerms(project, platformId, options);
|
|
4941
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4942
|
+
const localVarOperationServerBasePath = operationServerMap['TermsApi.getTerms']?.[localVarOperationServerIndex]?.url;
|
|
4943
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4944
|
+
},
|
|
4945
|
+
/**
|
|
4946
|
+
*
|
|
4947
|
+
* @summary Save the platform\'s terms
|
|
4948
|
+
* @param {string} project Project unique identifier
|
|
4949
|
+
* @param {string} platformId The platform identifier
|
|
4950
|
+
* @param {SaveTermsRequest} saveTermsRequest Save terms
|
|
4951
|
+
* @param {*} [options] Override http request option.
|
|
4952
|
+
* @throws {RequiredError}
|
|
4953
|
+
*/
|
|
4954
|
+
async saveTerms(project: string, platformId: string, saveTermsRequest: SaveTermsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Terms>> {
|
|
4955
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.saveTerms(project, platformId, saveTermsRequest, options);
|
|
4956
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4957
|
+
const localVarOperationServerBasePath = operationServerMap['TermsApi.saveTerms']?.[localVarOperationServerIndex]?.url;
|
|
4958
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4959
|
+
},
|
|
4960
|
+
}
|
|
4961
|
+
};
|
|
4962
|
+
|
|
4963
|
+
/**
|
|
4964
|
+
* TermsApi - factory interface
|
|
4965
|
+
* @export
|
|
4966
|
+
*/
|
|
4967
|
+
export const TermsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
4968
|
+
const localVarFp = TermsApiFp(configuration)
|
|
4969
|
+
return {
|
|
4970
|
+
/**
|
|
4971
|
+
*
|
|
4972
|
+
* @summary Get the platform\'s terms
|
|
4973
|
+
* @param {TermsApiGetTermsRequest} requestParameters Request parameters.
|
|
4974
|
+
* @param {*} [options] Override http request option.
|
|
4975
|
+
* @throws {RequiredError}
|
|
4976
|
+
*/
|
|
4977
|
+
getTerms(requestParameters: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Terms> {
|
|
4978
|
+
return localVarFp.getTerms(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
4979
|
+
},
|
|
4980
|
+
/**
|
|
4981
|
+
*
|
|
4982
|
+
* @summary Save the platform\'s terms
|
|
4983
|
+
* @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
|
|
4984
|
+
* @param {*} [options] Override http request option.
|
|
4985
|
+
* @throws {RequiredError}
|
|
4986
|
+
*/
|
|
4987
|
+
saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Terms> {
|
|
4988
|
+
return localVarFp.saveTerms(requestParameters.project, requestParameters.platformId, requestParameters.saveTermsRequest, options).then((request) => request(axios, basePath));
|
|
4989
|
+
},
|
|
4990
|
+
};
|
|
4991
|
+
};
|
|
4992
|
+
|
|
4993
|
+
/**
|
|
4994
|
+
* Request parameters for getTerms operation in TermsApi.
|
|
4995
|
+
* @export
|
|
4996
|
+
* @interface TermsApiGetTermsRequest
|
|
4997
|
+
*/
|
|
4998
|
+
export interface TermsApiGetTermsRequest {
|
|
4999
|
+
/**
|
|
5000
|
+
* Project unique identifier
|
|
5001
|
+
* @type {string}
|
|
5002
|
+
* @memberof TermsApiGetTerms
|
|
5003
|
+
*/
|
|
5004
|
+
readonly project: string
|
|
5005
|
+
|
|
5006
|
+
/**
|
|
5007
|
+
* The platform identifier
|
|
5008
|
+
* @type {string}
|
|
5009
|
+
* @memberof TermsApiGetTerms
|
|
5010
|
+
*/
|
|
5011
|
+
readonly platformId: string
|
|
5012
|
+
}
|
|
5013
|
+
|
|
5014
|
+
/**
|
|
5015
|
+
* Request parameters for saveTerms operation in TermsApi.
|
|
5016
|
+
* @export
|
|
5017
|
+
* @interface TermsApiSaveTermsRequest
|
|
5018
|
+
*/
|
|
5019
|
+
export interface TermsApiSaveTermsRequest {
|
|
5020
|
+
/**
|
|
5021
|
+
* Project unique identifier
|
|
5022
|
+
* @type {string}
|
|
5023
|
+
* @memberof TermsApiSaveTerms
|
|
5024
|
+
*/
|
|
5025
|
+
readonly project: string
|
|
5026
|
+
|
|
5027
|
+
/**
|
|
5028
|
+
* The platform identifier
|
|
5029
|
+
* @type {string}
|
|
5030
|
+
* @memberof TermsApiSaveTerms
|
|
5031
|
+
*/
|
|
5032
|
+
readonly platformId: string
|
|
5033
|
+
|
|
5034
|
+
/**
|
|
5035
|
+
* Save terms
|
|
5036
|
+
* @type {SaveTermsRequest}
|
|
5037
|
+
* @memberof TermsApiSaveTerms
|
|
5038
|
+
*/
|
|
5039
|
+
readonly saveTermsRequest: SaveTermsRequest
|
|
5040
|
+
}
|
|
5041
|
+
|
|
5042
|
+
/**
|
|
5043
|
+
* TermsApi - object-oriented interface
|
|
5044
|
+
* @export
|
|
5045
|
+
* @class TermsApi
|
|
5046
|
+
* @extends {BaseAPI}
|
|
5047
|
+
*/
|
|
5048
|
+
export class TermsApi extends BaseAPI {
|
|
5049
|
+
/**
|
|
5050
|
+
*
|
|
5051
|
+
* @summary Get the platform\'s terms
|
|
5052
|
+
* @param {TermsApiGetTermsRequest} requestParameters Request parameters.
|
|
5053
|
+
* @param {*} [options] Override http request option.
|
|
5054
|
+
* @throws {RequiredError}
|
|
5055
|
+
* @memberof TermsApi
|
|
5056
|
+
*/
|
|
5057
|
+
public getTerms(requestParameters: TermsApiGetTermsRequest, options?: RawAxiosRequestConfig) {
|
|
5058
|
+
return TermsApiFp(this.configuration).getTerms(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
5059
|
+
}
|
|
5060
|
+
|
|
5061
|
+
/**
|
|
5062
|
+
*
|
|
5063
|
+
* @summary Save the platform\'s terms
|
|
5064
|
+
* @param {TermsApiSaveTermsRequest} requestParameters Request parameters.
|
|
5065
|
+
* @param {*} [options] Override http request option.
|
|
5066
|
+
* @throws {RequiredError}
|
|
5067
|
+
* @memberof TermsApi
|
|
5068
|
+
*/
|
|
5069
|
+
public saveTerms(requestParameters: TermsApiSaveTermsRequest, options?: RawAxiosRequestConfig) {
|
|
5070
|
+
return TermsApiFp(this.configuration).saveTerms(requestParameters.project, requestParameters.platformId, requestParameters.saveTermsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
5071
|
+
}
|
|
5072
|
+
}
|
|
5073
|
+
|
|
5074
|
+
|
|
5075
|
+
|