@teemill/platform 0.18.0 → 0.20.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 +14 -2
- package/api.ts +861 -65
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +535 -1
- package/dist/api.js +401 -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 +535 -1
- package/dist/esm/api.js +396 -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/OrdersApi.md +63 -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.20.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
|
|
@@ -1908,31 +2140,30 @@ export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeo
|
|
|
1908
2140
|
|
|
1909
2141
|
|
|
1910
2142
|
/**
|
|
1911
|
-
*
|
|
2143
|
+
* EnquiriesApi - axios parameter creator
|
|
1912
2144
|
* @export
|
|
1913
2145
|
*/
|
|
1914
|
-
export const
|
|
2146
|
+
export const EnquiriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1915
2147
|
return {
|
|
1916
2148
|
/**
|
|
1917
|
-
*
|
|
1918
|
-
* @summary
|
|
2149
|
+
* Get a customer enquiry
|
|
2150
|
+
* @summary Get customer enquiry
|
|
1919
2151
|
* @param {string} project Project unique identifier
|
|
1920
2152
|
* @param {string} platformId The platform identifier
|
|
1921
|
-
* @param {string}
|
|
1922
|
-
* @param {string} [end] End of date range to filter when orders were placed
|
|
1923
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2153
|
+
* @param {string} enquiryId
|
|
1924
2154
|
* @param {*} [options] Override http request option.
|
|
1925
2155
|
* @throws {RequiredError}
|
|
1926
2156
|
*/
|
|
1927
|
-
|
|
2157
|
+
getCustomerEnquiry: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1928
2158
|
// verify required parameter 'project' is not null or undefined
|
|
1929
|
-
assertParamExists('
|
|
2159
|
+
assertParamExists('getCustomerEnquiry', 'project', project)
|
|
1930
2160
|
// verify required parameter 'platformId' is not null or undefined
|
|
1931
|
-
assertParamExists('
|
|
1932
|
-
// verify required parameter '
|
|
1933
|
-
assertParamExists('
|
|
1934
|
-
const localVarPath = `/v1/platform/{platformId}/
|
|
1935
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2161
|
+
assertParamExists('getCustomerEnquiry', 'platformId', platformId)
|
|
2162
|
+
// verify required parameter 'enquiryId' is not null or undefined
|
|
2163
|
+
assertParamExists('getCustomerEnquiry', 'enquiryId', enquiryId)
|
|
2164
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}`
|
|
2165
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2166
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
1936
2167
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1937
2168
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1938
2169
|
let baseOptions;
|
|
@@ -1955,22 +2186,6 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1955
2186
|
localVarQueryParameter['project'] = project;
|
|
1956
2187
|
}
|
|
1957
2188
|
|
|
1958
|
-
if (start !== undefined) {
|
|
1959
|
-
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
1960
|
-
(start as any).toISOString() :
|
|
1961
|
-
start;
|
|
1962
|
-
}
|
|
1963
|
-
|
|
1964
|
-
if (end !== undefined) {
|
|
1965
|
-
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
1966
|
-
(end as any).toISOString() :
|
|
1967
|
-
end;
|
|
1968
|
-
}
|
|
1969
|
-
|
|
1970
|
-
if (search !== undefined) {
|
|
1971
|
-
localVarQueryParameter['search'] = search;
|
|
1972
|
-
}
|
|
1973
|
-
|
|
1974
2189
|
|
|
1975
2190
|
|
|
1976
2191
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1983,24 +2198,25 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
1983
2198
|
};
|
|
1984
2199
|
},
|
|
1985
2200
|
/**
|
|
1986
|
-
*
|
|
1987
|
-
* @summary
|
|
2201
|
+
* List customer enquiries
|
|
2202
|
+
* @summary List customer enquiries
|
|
1988
2203
|
* @param {string} project Project unique identifier
|
|
1989
2204
|
* @param {string} platformId The platform identifier
|
|
1990
|
-
* @param {
|
|
2205
|
+
* @param {number} [pageToken] Page reference token
|
|
2206
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2207
|
+
* @param {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
|
|
2208
|
+
* @param {string} [start] Start of date range to filter by
|
|
2209
|
+
* @param {string} [end] End of date range to filter by
|
|
1991
2210
|
* @param {*} [options] Override http request option.
|
|
1992
2211
|
* @throws {RequiredError}
|
|
1993
2212
|
*/
|
|
1994
|
-
|
|
2213
|
+
listCustomerEnquiries: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1995
2214
|
// verify required parameter 'project' is not null or undefined
|
|
1996
|
-
assertParamExists('
|
|
2215
|
+
assertParamExists('listCustomerEnquiries', 'project', project)
|
|
1997
2216
|
// verify required parameter 'platformId' is not null or undefined
|
|
1998
|
-
assertParamExists('
|
|
1999
|
-
|
|
2000
|
-
|
|
2001
|
-
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
2002
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2003
|
-
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
2217
|
+
assertParamExists('listCustomerEnquiries', 'platformId', platformId)
|
|
2218
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries`
|
|
2219
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2004
2220
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2005
2221
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2006
2222
|
let baseOptions;
|
|
@@ -2023,6 +2239,30 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2023
2239
|
localVarQueryParameter['project'] = project;
|
|
2024
2240
|
}
|
|
2025
2241
|
|
|
2242
|
+
if (pageToken !== undefined) {
|
|
2243
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2244
|
+
}
|
|
2245
|
+
|
|
2246
|
+
if (pageSize !== undefined) {
|
|
2247
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2248
|
+
}
|
|
2249
|
+
|
|
2250
|
+
if (search !== undefined) {
|
|
2251
|
+
localVarQueryParameter['search'] = search;
|
|
2252
|
+
}
|
|
2253
|
+
|
|
2254
|
+
if (start !== undefined) {
|
|
2255
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
2256
|
+
(start as any).toISOString() :
|
|
2257
|
+
start;
|
|
2258
|
+
}
|
|
2259
|
+
|
|
2260
|
+
if (end !== undefined) {
|
|
2261
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
2262
|
+
(end as any).toISOString() :
|
|
2263
|
+
end;
|
|
2264
|
+
}
|
|
2265
|
+
|
|
2026
2266
|
|
|
2027
2267
|
|
|
2028
2268
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -2035,24 +2275,24 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2035
2275
|
};
|
|
2036
2276
|
},
|
|
2037
2277
|
/**
|
|
2038
|
-
*
|
|
2039
|
-
* @summary
|
|
2278
|
+
* Lists all customer enquiry Logs
|
|
2279
|
+
* @summary List customer enquiry Logs
|
|
2040
2280
|
* @param {string} project Project unique identifier
|
|
2041
2281
|
* @param {string} platformId The platform identifier
|
|
2042
|
-
* @param {string}
|
|
2282
|
+
* @param {string} enquiryId
|
|
2043
2283
|
* @param {*} [options] Override http request option.
|
|
2044
2284
|
* @throws {RequiredError}
|
|
2045
2285
|
*/
|
|
2046
|
-
|
|
2286
|
+
listCustomerEnquiryLogs: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2047
2287
|
// verify required parameter 'project' is not null or undefined
|
|
2048
|
-
assertParamExists('
|
|
2288
|
+
assertParamExists('listCustomerEnquiryLogs', 'project', project)
|
|
2049
2289
|
// verify required parameter 'platformId' is not null or undefined
|
|
2050
|
-
assertParamExists('
|
|
2051
|
-
// verify required parameter '
|
|
2052
|
-
assertParamExists('
|
|
2053
|
-
const localVarPath = `/v1/platform/{platformId}/
|
|
2290
|
+
assertParamExists('listCustomerEnquiryLogs', 'platformId', platformId)
|
|
2291
|
+
// verify required parameter 'enquiryId' is not null or undefined
|
|
2292
|
+
assertParamExists('listCustomerEnquiryLogs', 'enquiryId', enquiryId)
|
|
2293
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs`
|
|
2054
2294
|
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2055
|
-
.replace(`{${"
|
|
2295
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
2056
2296
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2057
2297
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2058
2298
|
let baseOptions;
|
|
@@ -2086,25 +2326,464 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2086
2326
|
options: localVarRequestOptions,
|
|
2087
2327
|
};
|
|
2088
2328
|
},
|
|
2329
|
+
}
|
|
2330
|
+
};
|
|
2331
|
+
|
|
2332
|
+
/**
|
|
2333
|
+
* EnquiriesApi - functional programming interface
|
|
2334
|
+
* @export
|
|
2335
|
+
*/
|
|
2336
|
+
export const EnquiriesApiFp = function(configuration?: Configuration) {
|
|
2337
|
+
const localVarAxiosParamCreator = EnquiriesApiAxiosParamCreator(configuration)
|
|
2338
|
+
return {
|
|
2089
2339
|
/**
|
|
2090
|
-
*
|
|
2091
|
-
* @summary
|
|
2340
|
+
* Get a customer enquiry
|
|
2341
|
+
* @summary Get customer enquiry
|
|
2092
2342
|
* @param {string} project Project unique identifier
|
|
2093
2343
|
* @param {string} platformId The platform identifier
|
|
2094
|
-
* @param {string}
|
|
2344
|
+
* @param {string} enquiryId
|
|
2095
2345
|
* @param {*} [options] Override http request option.
|
|
2096
2346
|
* @throws {RequiredError}
|
|
2097
2347
|
*/
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
|
|
2104
|
-
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2348
|
+
async getCustomerEnquiry(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Enquiry>> {
|
|
2349
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomerEnquiry(project, platformId, enquiryId, options);
|
|
2350
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2351
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.getCustomerEnquiry']?.[localVarOperationServerIndex]?.url;
|
|
2352
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2353
|
+
},
|
|
2354
|
+
/**
|
|
2355
|
+
* List customer enquiries
|
|
2356
|
+
* @summary List customer enquiries
|
|
2357
|
+
* @param {string} project Project unique identifier
|
|
2358
|
+
* @param {string} platformId The platform identifier
|
|
2359
|
+
* @param {number} [pageToken] Page reference token
|
|
2360
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2361
|
+
* @param {string} [search] Search term to filter based on enquiry title, content, customer name and customer email.
|
|
2362
|
+
* @param {string} [start] Start of date range to filter by
|
|
2363
|
+
* @param {string} [end] End of date range to filter by
|
|
2364
|
+
* @param {*} [options] Override http request option.
|
|
2365
|
+
* @throws {RequiredError}
|
|
2366
|
+
*/
|
|
2367
|
+
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>> {
|
|
2368
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomerEnquiries(project, platformId, pageToken, pageSize, search, start, end, options);
|
|
2369
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2370
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.listCustomerEnquiries']?.[localVarOperationServerIndex]?.url;
|
|
2371
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2372
|
+
},
|
|
2373
|
+
/**
|
|
2374
|
+
* Lists all customer enquiry Logs
|
|
2375
|
+
* @summary List customer enquiry Logs
|
|
2376
|
+
* @param {string} project Project unique identifier
|
|
2377
|
+
* @param {string} platformId The platform identifier
|
|
2378
|
+
* @param {string} enquiryId
|
|
2379
|
+
* @param {*} [options] Override http request option.
|
|
2380
|
+
* @throws {RequiredError}
|
|
2381
|
+
*/
|
|
2382
|
+
async listCustomerEnquiryLogs(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiryLogs200Response>> {
|
|
2383
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomerEnquiryLogs(project, platformId, enquiryId, options);
|
|
2384
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2385
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.listCustomerEnquiryLogs']?.[localVarOperationServerIndex]?.url;
|
|
2386
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2387
|
+
},
|
|
2388
|
+
}
|
|
2389
|
+
};
|
|
2390
|
+
|
|
2391
|
+
/**
|
|
2392
|
+
* EnquiriesApi - factory interface
|
|
2393
|
+
* @export
|
|
2394
|
+
*/
|
|
2395
|
+
export const EnquiriesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
2396
|
+
const localVarFp = EnquiriesApiFp(configuration)
|
|
2397
|
+
return {
|
|
2398
|
+
/**
|
|
2399
|
+
* Get a customer enquiry
|
|
2400
|
+
* @summary Get customer enquiry
|
|
2401
|
+
* @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
|
|
2402
|
+
* @param {*} [options] Override http request option.
|
|
2403
|
+
* @throws {RequiredError}
|
|
2404
|
+
*/
|
|
2405
|
+
getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry> {
|
|
2406
|
+
return localVarFp.getCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2407
|
+
},
|
|
2408
|
+
/**
|
|
2409
|
+
* List customer enquiries
|
|
2410
|
+
* @summary List customer enquiries
|
|
2411
|
+
* @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
|
|
2412
|
+
* @param {*} [options] Override http request option.
|
|
2413
|
+
* @throws {RequiredError}
|
|
2414
|
+
*/
|
|
2415
|
+
listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiries200Response> {
|
|
2416
|
+
return localVarFp.listCustomerEnquiries(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
2417
|
+
},
|
|
2418
|
+
/**
|
|
2419
|
+
* Lists all customer enquiry Logs
|
|
2420
|
+
* @summary List customer enquiry Logs
|
|
2421
|
+
* @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
|
|
2422
|
+
* @param {*} [options] Override http request option.
|
|
2423
|
+
* @throws {RequiredError}
|
|
2424
|
+
*/
|
|
2425
|
+
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response> {
|
|
2426
|
+
return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2427
|
+
},
|
|
2428
|
+
};
|
|
2429
|
+
};
|
|
2430
|
+
|
|
2431
|
+
/**
|
|
2432
|
+
* Request parameters for getCustomerEnquiry operation in EnquiriesApi.
|
|
2433
|
+
* @export
|
|
2434
|
+
* @interface EnquiriesApiGetCustomerEnquiryRequest
|
|
2435
|
+
*/
|
|
2436
|
+
export interface EnquiriesApiGetCustomerEnquiryRequest {
|
|
2437
|
+
/**
|
|
2438
|
+
* Project unique identifier
|
|
2439
|
+
* @type {string}
|
|
2440
|
+
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
2441
|
+
*/
|
|
2442
|
+
readonly project: string
|
|
2443
|
+
|
|
2444
|
+
/**
|
|
2445
|
+
* The platform identifier
|
|
2446
|
+
* @type {string}
|
|
2447
|
+
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
2448
|
+
*/
|
|
2449
|
+
readonly platformId: string
|
|
2450
|
+
|
|
2451
|
+
/**
|
|
2452
|
+
*
|
|
2453
|
+
* @type {string}
|
|
2454
|
+
* @memberof EnquiriesApiGetCustomerEnquiry
|
|
2455
|
+
*/
|
|
2456
|
+
readonly enquiryId: string
|
|
2457
|
+
}
|
|
2458
|
+
|
|
2459
|
+
/**
|
|
2460
|
+
* Request parameters for listCustomerEnquiries operation in EnquiriesApi.
|
|
2461
|
+
* @export
|
|
2462
|
+
* @interface EnquiriesApiListCustomerEnquiriesRequest
|
|
2463
|
+
*/
|
|
2464
|
+
export interface EnquiriesApiListCustomerEnquiriesRequest {
|
|
2465
|
+
/**
|
|
2466
|
+
* Project unique identifier
|
|
2467
|
+
* @type {string}
|
|
2468
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2469
|
+
*/
|
|
2470
|
+
readonly project: string
|
|
2471
|
+
|
|
2472
|
+
/**
|
|
2473
|
+
* The platform identifier
|
|
2474
|
+
* @type {string}
|
|
2475
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2476
|
+
*/
|
|
2477
|
+
readonly platformId: string
|
|
2478
|
+
|
|
2479
|
+
/**
|
|
2480
|
+
* Page reference token
|
|
2481
|
+
* @type {number}
|
|
2482
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2483
|
+
*/
|
|
2484
|
+
readonly pageToken?: number
|
|
2485
|
+
|
|
2486
|
+
/**
|
|
2487
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2488
|
+
* @type {number}
|
|
2489
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2490
|
+
*/
|
|
2491
|
+
readonly pageSize?: number
|
|
2492
|
+
|
|
2493
|
+
/**
|
|
2494
|
+
* Search term to filter based on enquiry title, content, customer name and customer email.
|
|
2495
|
+
* @type {string}
|
|
2496
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2497
|
+
*/
|
|
2498
|
+
readonly search?: string
|
|
2499
|
+
|
|
2500
|
+
/**
|
|
2501
|
+
* Start of date range to filter by
|
|
2502
|
+
* @type {string}
|
|
2503
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2504
|
+
*/
|
|
2505
|
+
readonly start?: string
|
|
2506
|
+
|
|
2507
|
+
/**
|
|
2508
|
+
* End of date range to filter by
|
|
2509
|
+
* @type {string}
|
|
2510
|
+
* @memberof EnquiriesApiListCustomerEnquiries
|
|
2511
|
+
*/
|
|
2512
|
+
readonly end?: string
|
|
2513
|
+
}
|
|
2514
|
+
|
|
2515
|
+
/**
|
|
2516
|
+
* Request parameters for listCustomerEnquiryLogs operation in EnquiriesApi.
|
|
2517
|
+
* @export
|
|
2518
|
+
* @interface EnquiriesApiListCustomerEnquiryLogsRequest
|
|
2519
|
+
*/
|
|
2520
|
+
export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
2521
|
+
/**
|
|
2522
|
+
* Project unique identifier
|
|
2523
|
+
* @type {string}
|
|
2524
|
+
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
2525
|
+
*/
|
|
2526
|
+
readonly project: string
|
|
2527
|
+
|
|
2528
|
+
/**
|
|
2529
|
+
* The platform identifier
|
|
2530
|
+
* @type {string}
|
|
2531
|
+
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
2532
|
+
*/
|
|
2533
|
+
readonly platformId: string
|
|
2534
|
+
|
|
2535
|
+
/**
|
|
2536
|
+
*
|
|
2537
|
+
* @type {string}
|
|
2538
|
+
* @memberof EnquiriesApiListCustomerEnquiryLogs
|
|
2539
|
+
*/
|
|
2540
|
+
readonly enquiryId: string
|
|
2541
|
+
}
|
|
2542
|
+
|
|
2543
|
+
/**
|
|
2544
|
+
* EnquiriesApi - object-oriented interface
|
|
2545
|
+
* @export
|
|
2546
|
+
* @class EnquiriesApi
|
|
2547
|
+
* @extends {BaseAPI}
|
|
2548
|
+
*/
|
|
2549
|
+
export class EnquiriesApi extends BaseAPI {
|
|
2550
|
+
/**
|
|
2551
|
+
* Get a customer enquiry
|
|
2552
|
+
* @summary Get customer enquiry
|
|
2553
|
+
* @param {EnquiriesApiGetCustomerEnquiryRequest} requestParameters Request parameters.
|
|
2554
|
+
* @param {*} [options] Override http request option.
|
|
2555
|
+
* @throws {RequiredError}
|
|
2556
|
+
* @memberof EnquiriesApi
|
|
2557
|
+
*/
|
|
2558
|
+
public getCustomerEnquiry(requestParameters: EnquiriesApiGetCustomerEnquiryRequest, options?: RawAxiosRequestConfig) {
|
|
2559
|
+
return EnquiriesApiFp(this.configuration).getCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
2560
|
+
}
|
|
2561
|
+
|
|
2562
|
+
/**
|
|
2563
|
+
* List customer enquiries
|
|
2564
|
+
* @summary List customer enquiries
|
|
2565
|
+
* @param {EnquiriesApiListCustomerEnquiriesRequest} requestParameters Request parameters.
|
|
2566
|
+
* @param {*} [options] Override http request option.
|
|
2567
|
+
* @throws {RequiredError}
|
|
2568
|
+
* @memberof EnquiriesApi
|
|
2569
|
+
*/
|
|
2570
|
+
public listCustomerEnquiries(requestParameters: EnquiriesApiListCustomerEnquiriesRequest, options?: RawAxiosRequestConfig) {
|
|
2571
|
+
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));
|
|
2572
|
+
}
|
|
2573
|
+
|
|
2574
|
+
/**
|
|
2575
|
+
* Lists all customer enquiry Logs
|
|
2576
|
+
* @summary List customer enquiry Logs
|
|
2577
|
+
* @param {EnquiriesApiListCustomerEnquiryLogsRequest} requestParameters Request parameters.
|
|
2578
|
+
* @param {*} [options] Override http request option.
|
|
2579
|
+
* @throws {RequiredError}
|
|
2580
|
+
* @memberof EnquiriesApi
|
|
2581
|
+
*/
|
|
2582
|
+
public listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig) {
|
|
2583
|
+
return EnquiriesApiFp(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
2584
|
+
}
|
|
2585
|
+
}
|
|
2586
|
+
|
|
2587
|
+
|
|
2588
|
+
|
|
2589
|
+
/**
|
|
2590
|
+
* OrdersApi - axios parameter creator
|
|
2591
|
+
* @export
|
|
2592
|
+
*/
|
|
2593
|
+
export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2594
|
+
return {
|
|
2595
|
+
/**
|
|
2596
|
+
* Export orders as a CSV file
|
|
2597
|
+
* @summary Export orders
|
|
2598
|
+
* @param {string} project Project unique identifier
|
|
2599
|
+
* @param {string} platformId The platform identifier
|
|
2600
|
+
* @param {string} start Start of date range to filter by when orders were placed
|
|
2601
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
2602
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2603
|
+
* @param {*} [options] Override http request option.
|
|
2604
|
+
* @throws {RequiredError}
|
|
2605
|
+
*/
|
|
2606
|
+
exportOrders: async (project: string, platformId: string, start: string, end?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2607
|
+
// verify required parameter 'project' is not null or undefined
|
|
2608
|
+
assertParamExists('exportOrders', 'project', project)
|
|
2609
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2610
|
+
assertParamExists('exportOrders', 'platformId', platformId)
|
|
2611
|
+
// verify required parameter 'start' is not null or undefined
|
|
2612
|
+
assertParamExists('exportOrders', 'start', start)
|
|
2613
|
+
const localVarPath = `/v1/platform/{platformId}/orders/export`
|
|
2614
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2615
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2616
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2617
|
+
let baseOptions;
|
|
2618
|
+
if (configuration) {
|
|
2619
|
+
baseOptions = configuration.baseOptions;
|
|
2620
|
+
}
|
|
2621
|
+
|
|
2622
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2623
|
+
const localVarHeaderParameter = {} as any;
|
|
2624
|
+
const localVarQueryParameter = {} as any;
|
|
2625
|
+
|
|
2626
|
+
// authentication session-oauth required
|
|
2627
|
+
// oauth required
|
|
2628
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2629
|
+
|
|
2630
|
+
// authentication api-key required
|
|
2631
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2632
|
+
|
|
2633
|
+
if (project !== undefined) {
|
|
2634
|
+
localVarQueryParameter['project'] = project;
|
|
2635
|
+
}
|
|
2636
|
+
|
|
2637
|
+
if (start !== undefined) {
|
|
2638
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
2639
|
+
(start as any).toISOString() :
|
|
2640
|
+
start;
|
|
2641
|
+
}
|
|
2642
|
+
|
|
2643
|
+
if (end !== undefined) {
|
|
2644
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
2645
|
+
(end as any).toISOString() :
|
|
2646
|
+
end;
|
|
2647
|
+
}
|
|
2648
|
+
|
|
2649
|
+
if (search !== undefined) {
|
|
2650
|
+
localVarQueryParameter['search'] = search;
|
|
2651
|
+
}
|
|
2652
|
+
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2656
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2657
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2658
|
+
|
|
2659
|
+
return {
|
|
2660
|
+
url: toPathString(localVarUrlObj),
|
|
2661
|
+
options: localVarRequestOptions,
|
|
2662
|
+
};
|
|
2663
|
+
},
|
|
2664
|
+
/**
|
|
2665
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2666
|
+
* @summary Get fulfillment
|
|
2667
|
+
* @param {string} project Project unique identifier
|
|
2668
|
+
* @param {string} platformId The platform identifier
|
|
2669
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
2670
|
+
* @param {*} [options] Override http request option.
|
|
2671
|
+
* @throws {RequiredError}
|
|
2672
|
+
*/
|
|
2673
|
+
getFulfillment: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2674
|
+
// verify required parameter 'project' is not null or undefined
|
|
2675
|
+
assertParamExists('getFulfillment', 'project', project)
|
|
2676
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2677
|
+
assertParamExists('getFulfillment', 'platformId', platformId)
|
|
2678
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
2679
|
+
assertParamExists('getFulfillment', 'fulfillmentId', fulfillmentId)
|
|
2680
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
2681
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2682
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
2683
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2684
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2685
|
+
let baseOptions;
|
|
2686
|
+
if (configuration) {
|
|
2687
|
+
baseOptions = configuration.baseOptions;
|
|
2688
|
+
}
|
|
2689
|
+
|
|
2690
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2691
|
+
const localVarHeaderParameter = {} as any;
|
|
2692
|
+
const localVarQueryParameter = {} as any;
|
|
2693
|
+
|
|
2694
|
+
// authentication session-oauth required
|
|
2695
|
+
// oauth required
|
|
2696
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2697
|
+
|
|
2698
|
+
// authentication api-key required
|
|
2699
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2700
|
+
|
|
2701
|
+
if (project !== undefined) {
|
|
2702
|
+
localVarQueryParameter['project'] = project;
|
|
2703
|
+
}
|
|
2704
|
+
|
|
2705
|
+
|
|
2706
|
+
|
|
2707
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2708
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2709
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2710
|
+
|
|
2711
|
+
return {
|
|
2712
|
+
url: toPathString(localVarUrlObj),
|
|
2713
|
+
options: localVarRequestOptions,
|
|
2714
|
+
};
|
|
2715
|
+
},
|
|
2716
|
+
/**
|
|
2717
|
+
* Get an order for a platform by a given order ID.
|
|
2718
|
+
* @summary Get order
|
|
2719
|
+
* @param {string} project Project unique identifier
|
|
2720
|
+
* @param {string} platformId The platform identifier
|
|
2721
|
+
* @param {string} orderId The order identifier
|
|
2722
|
+
* @param {*} [options] Override http request option.
|
|
2723
|
+
* @throws {RequiredError}
|
|
2724
|
+
*/
|
|
2725
|
+
getOrder: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2726
|
+
// verify required parameter 'project' is not null or undefined
|
|
2727
|
+
assertParamExists('getOrder', 'project', project)
|
|
2728
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2729
|
+
assertParamExists('getOrder', 'platformId', platformId)
|
|
2730
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
2731
|
+
assertParamExists('getOrder', 'orderId', orderId)
|
|
2732
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}`
|
|
2733
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2734
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
2735
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2736
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2737
|
+
let baseOptions;
|
|
2738
|
+
if (configuration) {
|
|
2739
|
+
baseOptions = configuration.baseOptions;
|
|
2740
|
+
}
|
|
2741
|
+
|
|
2742
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2743
|
+
const localVarHeaderParameter = {} as any;
|
|
2744
|
+
const localVarQueryParameter = {} as any;
|
|
2745
|
+
|
|
2746
|
+
// authentication session-oauth required
|
|
2747
|
+
// oauth required
|
|
2748
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2749
|
+
|
|
2750
|
+
// authentication api-key required
|
|
2751
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2752
|
+
|
|
2753
|
+
if (project !== undefined) {
|
|
2754
|
+
localVarQueryParameter['project'] = project;
|
|
2755
|
+
}
|
|
2756
|
+
|
|
2757
|
+
|
|
2758
|
+
|
|
2759
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2760
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2761
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2762
|
+
|
|
2763
|
+
return {
|
|
2764
|
+
url: toPathString(localVarUrlObj),
|
|
2765
|
+
options: localVarRequestOptions,
|
|
2766
|
+
};
|
|
2767
|
+
},
|
|
2768
|
+
/**
|
|
2769
|
+
* List available fulfillers for a given fulfillment
|
|
2770
|
+
* @summary List available fulfillers
|
|
2771
|
+
* @param {string} project Project unique identifier
|
|
2772
|
+
* @param {string} platformId The platform identifier
|
|
2773
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
2774
|
+
* @param {*} [options] Override http request option.
|
|
2775
|
+
* @throws {RequiredError}
|
|
2776
|
+
*/
|
|
2777
|
+
listAvailableFulfillers: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2778
|
+
// verify required parameter 'project' is not null or undefined
|
|
2779
|
+
assertParamExists('listAvailableFulfillers', 'project', project)
|
|
2780
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2781
|
+
assertParamExists('listAvailableFulfillers', 'platformId', platformId)
|
|
2782
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
2783
|
+
assertParamExists('listAvailableFulfillers', 'fulfillmentId', fulfillmentId)
|
|
2784
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers`
|
|
2785
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2786
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
2108
2787
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2109
2788
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2110
2789
|
let baseOptions;
|
|
@@ -2211,6 +2890,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2211
2890
|
|
|
2212
2891
|
|
|
2213
2892
|
|
|
2893
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2894
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2895
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2896
|
+
|
|
2897
|
+
return {
|
|
2898
|
+
url: toPathString(localVarUrlObj),
|
|
2899
|
+
options: localVarRequestOptions,
|
|
2900
|
+
};
|
|
2901
|
+
},
|
|
2902
|
+
/**
|
|
2903
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
2904
|
+
* @summary Retry
|
|
2905
|
+
* @param {string} project Project unique identifier
|
|
2906
|
+
* @param {string} platformId The platform identifier
|
|
2907
|
+
* @param {string} orderId The order identifier
|
|
2908
|
+
* @param {*} [options] Override http request option.
|
|
2909
|
+
* @throws {RequiredError}
|
|
2910
|
+
*/
|
|
2911
|
+
retryPlatformPayment: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2912
|
+
// verify required parameter 'project' is not null or undefined
|
|
2913
|
+
assertParamExists('retryPlatformPayment', 'project', project)
|
|
2914
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2915
|
+
assertParamExists('retryPlatformPayment', 'platformId', platformId)
|
|
2916
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
2917
|
+
assertParamExists('retryPlatformPayment', 'orderId', orderId)
|
|
2918
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/retryPlatformPayment`
|
|
2919
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2920
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
2921
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2922
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2923
|
+
let baseOptions;
|
|
2924
|
+
if (configuration) {
|
|
2925
|
+
baseOptions = configuration.baseOptions;
|
|
2926
|
+
}
|
|
2927
|
+
|
|
2928
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2929
|
+
const localVarHeaderParameter = {} as any;
|
|
2930
|
+
const localVarQueryParameter = {} as any;
|
|
2931
|
+
|
|
2932
|
+
// authentication session-oauth required
|
|
2933
|
+
// oauth required
|
|
2934
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2935
|
+
|
|
2936
|
+
// authentication api-key required
|
|
2937
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2938
|
+
|
|
2939
|
+
if (project !== undefined) {
|
|
2940
|
+
localVarQueryParameter['project'] = project;
|
|
2941
|
+
}
|
|
2942
|
+
|
|
2943
|
+
|
|
2944
|
+
|
|
2214
2945
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2215
2946
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2216
2947
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2370,6 +3101,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
2370
3101
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
2371
3102
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2372
3103
|
},
|
|
3104
|
+
/**
|
|
3105
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
3106
|
+
* @summary Retry
|
|
3107
|
+
* @param {string} project Project unique identifier
|
|
3108
|
+
* @param {string} platformId The platform identifier
|
|
3109
|
+
* @param {string} orderId The order identifier
|
|
3110
|
+
* @param {*} [options] Override http request option.
|
|
3111
|
+
* @throws {RequiredError}
|
|
3112
|
+
*/
|
|
3113
|
+
async retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
3114
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryPlatformPayment(project, platformId, orderId, options);
|
|
3115
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3116
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
|
|
3117
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3118
|
+
},
|
|
2373
3119
|
/**
|
|
2374
3120
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2375
3121
|
* @summary Update fulfillment
|
|
@@ -2446,6 +3192,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
2446
3192
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
2447
3193
|
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
2448
3194
|
},
|
|
3195
|
+
/**
|
|
3196
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
3197
|
+
* @summary Retry
|
|
3198
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
3199
|
+
* @param {*} [options] Override http request option.
|
|
3200
|
+
* @throws {RequiredError}
|
|
3201
|
+
*/
|
|
3202
|
+
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
3203
|
+
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3204
|
+
},
|
|
2449
3205
|
/**
|
|
2450
3206
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2451
3207
|
* @summary Update fulfillment
|
|
@@ -2648,6 +3404,34 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2648
3404
|
readonly dateFilterType?: ListOrdersDateFilterTypeEnum
|
|
2649
3405
|
}
|
|
2650
3406
|
|
|
3407
|
+
/**
|
|
3408
|
+
* Request parameters for retryPlatformPayment operation in OrdersApi.
|
|
3409
|
+
* @export
|
|
3410
|
+
* @interface OrdersApiRetryPlatformPaymentRequest
|
|
3411
|
+
*/
|
|
3412
|
+
export interface OrdersApiRetryPlatformPaymentRequest {
|
|
3413
|
+
/**
|
|
3414
|
+
* Project unique identifier
|
|
3415
|
+
* @type {string}
|
|
3416
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
3417
|
+
*/
|
|
3418
|
+
readonly project: string
|
|
3419
|
+
|
|
3420
|
+
/**
|
|
3421
|
+
* The platform identifier
|
|
3422
|
+
* @type {string}
|
|
3423
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
3424
|
+
*/
|
|
3425
|
+
readonly platformId: string
|
|
3426
|
+
|
|
3427
|
+
/**
|
|
3428
|
+
* The order identifier
|
|
3429
|
+
* @type {string}
|
|
3430
|
+
* @memberof OrdersApiRetryPlatformPayment
|
|
3431
|
+
*/
|
|
3432
|
+
readonly orderId: string
|
|
3433
|
+
}
|
|
3434
|
+
|
|
2651
3435
|
/**
|
|
2652
3436
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
2653
3437
|
* @export
|
|
@@ -2750,6 +3534,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
2750
3534
|
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
2751
3535
|
}
|
|
2752
3536
|
|
|
3537
|
+
/**
|
|
3538
|
+
* Retries failed platform payment, so fulfillment can proceed.
|
|
3539
|
+
* @summary Retry
|
|
3540
|
+
* @param {OrdersApiRetryPlatformPaymentRequest} requestParameters Request parameters.
|
|
3541
|
+
* @param {*} [options] Override http request option.
|
|
3542
|
+
* @throws {RequiredError}
|
|
3543
|
+
* @memberof OrdersApi
|
|
3544
|
+
*/
|
|
3545
|
+
public retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig) {
|
|
3546
|
+
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
3547
|
+
}
|
|
3548
|
+
|
|
2753
3549
|
/**
|
|
2754
3550
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2755
3551
|
* @summary Update fulfillment
|