@teemill/platform 0.19.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 +13 -2
- package/api.ts +680 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +473 -1
- package/dist/api.js +318 -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 +473 -1
- package/dist/esm/api.js +313 -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/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
|
|
@@ -1907,6 +2139,453 @@ export const ListCustomersSortByEnum = {
|
|
|
1907
2139
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
1908
2140
|
|
|
1909
2141
|
|
|
2142
|
+
/**
|
|
2143
|
+
* EnquiriesApi - axios parameter creator
|
|
2144
|
+
* @export
|
|
2145
|
+
*/
|
|
2146
|
+
export const EnquiriesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2147
|
+
return {
|
|
2148
|
+
/**
|
|
2149
|
+
* Get a customer enquiry
|
|
2150
|
+
* @summary Get customer enquiry
|
|
2151
|
+
* @param {string} project Project unique identifier
|
|
2152
|
+
* @param {string} platformId The platform identifier
|
|
2153
|
+
* @param {string} enquiryId
|
|
2154
|
+
* @param {*} [options] Override http request option.
|
|
2155
|
+
* @throws {RequiredError}
|
|
2156
|
+
*/
|
|
2157
|
+
getCustomerEnquiry: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2158
|
+
// verify required parameter 'project' is not null or undefined
|
|
2159
|
+
assertParamExists('getCustomerEnquiry', 'project', project)
|
|
2160
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
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)));
|
|
2167
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2168
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2169
|
+
let baseOptions;
|
|
2170
|
+
if (configuration) {
|
|
2171
|
+
baseOptions = configuration.baseOptions;
|
|
2172
|
+
}
|
|
2173
|
+
|
|
2174
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2175
|
+
const localVarHeaderParameter = {} as any;
|
|
2176
|
+
const localVarQueryParameter = {} as any;
|
|
2177
|
+
|
|
2178
|
+
// authentication session-oauth required
|
|
2179
|
+
// oauth required
|
|
2180
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2181
|
+
|
|
2182
|
+
// authentication api-key required
|
|
2183
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2184
|
+
|
|
2185
|
+
if (project !== undefined) {
|
|
2186
|
+
localVarQueryParameter['project'] = project;
|
|
2187
|
+
}
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2192
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2193
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2194
|
+
|
|
2195
|
+
return {
|
|
2196
|
+
url: toPathString(localVarUrlObj),
|
|
2197
|
+
options: localVarRequestOptions,
|
|
2198
|
+
};
|
|
2199
|
+
},
|
|
2200
|
+
/**
|
|
2201
|
+
* List customer enquiries
|
|
2202
|
+
* @summary List customer enquiries
|
|
2203
|
+
* @param {string} project Project unique identifier
|
|
2204
|
+
* @param {string} platformId The platform identifier
|
|
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
|
|
2210
|
+
* @param {*} [options] Override http request option.
|
|
2211
|
+
* @throws {RequiredError}
|
|
2212
|
+
*/
|
|
2213
|
+
listCustomerEnquiries: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2214
|
+
// verify required parameter 'project' is not null or undefined
|
|
2215
|
+
assertParamExists('listCustomerEnquiries', 'project', project)
|
|
2216
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2217
|
+
assertParamExists('listCustomerEnquiries', 'platformId', platformId)
|
|
2218
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries`
|
|
2219
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2220
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2221
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2222
|
+
let baseOptions;
|
|
2223
|
+
if (configuration) {
|
|
2224
|
+
baseOptions = configuration.baseOptions;
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2228
|
+
const localVarHeaderParameter = {} as any;
|
|
2229
|
+
const localVarQueryParameter = {} as any;
|
|
2230
|
+
|
|
2231
|
+
// authentication session-oauth required
|
|
2232
|
+
// oauth required
|
|
2233
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2234
|
+
|
|
2235
|
+
// authentication api-key required
|
|
2236
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2237
|
+
|
|
2238
|
+
if (project !== undefined) {
|
|
2239
|
+
localVarQueryParameter['project'] = project;
|
|
2240
|
+
}
|
|
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
|
+
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2269
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2270
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2271
|
+
|
|
2272
|
+
return {
|
|
2273
|
+
url: toPathString(localVarUrlObj),
|
|
2274
|
+
options: localVarRequestOptions,
|
|
2275
|
+
};
|
|
2276
|
+
},
|
|
2277
|
+
/**
|
|
2278
|
+
* Lists all customer enquiry Logs
|
|
2279
|
+
* @summary List customer enquiry Logs
|
|
2280
|
+
* @param {string} project Project unique identifier
|
|
2281
|
+
* @param {string} platformId The platform identifier
|
|
2282
|
+
* @param {string} enquiryId
|
|
2283
|
+
* @param {*} [options] Override http request option.
|
|
2284
|
+
* @throws {RequiredError}
|
|
2285
|
+
*/
|
|
2286
|
+
listCustomerEnquiryLogs: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2287
|
+
// verify required parameter 'project' is not null or undefined
|
|
2288
|
+
assertParamExists('listCustomerEnquiryLogs', 'project', project)
|
|
2289
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
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`
|
|
2294
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2295
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
2296
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2297
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2298
|
+
let baseOptions;
|
|
2299
|
+
if (configuration) {
|
|
2300
|
+
baseOptions = configuration.baseOptions;
|
|
2301
|
+
}
|
|
2302
|
+
|
|
2303
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2304
|
+
const localVarHeaderParameter = {} as any;
|
|
2305
|
+
const localVarQueryParameter = {} as any;
|
|
2306
|
+
|
|
2307
|
+
// authentication session-oauth required
|
|
2308
|
+
// oauth required
|
|
2309
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2310
|
+
|
|
2311
|
+
// authentication api-key required
|
|
2312
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2313
|
+
|
|
2314
|
+
if (project !== undefined) {
|
|
2315
|
+
localVarQueryParameter['project'] = project;
|
|
2316
|
+
}
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2321
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2322
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2323
|
+
|
|
2324
|
+
return {
|
|
2325
|
+
url: toPathString(localVarUrlObj),
|
|
2326
|
+
options: localVarRequestOptions,
|
|
2327
|
+
};
|
|
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 {
|
|
2339
|
+
/**
|
|
2340
|
+
* Get a customer enquiry
|
|
2341
|
+
* @summary Get customer enquiry
|
|
2342
|
+
* @param {string} project Project unique identifier
|
|
2343
|
+
* @param {string} platformId The platform identifier
|
|
2344
|
+
* @param {string} enquiryId
|
|
2345
|
+
* @param {*} [options] Override http request option.
|
|
2346
|
+
* @throws {RequiredError}
|
|
2347
|
+
*/
|
|
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
|
+
|
|
1910
2589
|
/**
|
|
1911
2590
|
* OrdersApi - axios parameter creator
|
|
1912
2591
|
* @export
|