@teemill/platform 0.38.2 → 0.40.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 +5 -4
- package/api.ts +135 -22
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +73 -15
- package/dist/api.js +96 -14
- 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 +73 -15
- package/dist/esm/api.js +96 -14
- 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/CreateOrderChatChannel200Response.md +20 -0
- package/docs/CreateReviewPayload.md +2 -0
- package/docs/CreateReviewRequest.md +2 -0
- package/docs/EnquiriesApi.md +5 -5
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +63 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.40.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.40.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -57,7 +57,7 @@ Class | Method | HTTP request | Description
|
|
|
57
57
|
*CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
|
|
58
58
|
*DashboardApi* | [**getDashboard**](docs/DashboardApi.md#getdashboard) | **GET** /v1/platform/{platformId}/dashboard | Get the platform\'s dashboard
|
|
59
59
|
*DashboardApi* | [**saveDashboard**](docs/DashboardApi.md#savedashboard) | **PUT** /v1/platform/{platformId}/dashboard | Save the platform\'s dashboard
|
|
60
|
-
*EnquiriesApi* | [**
|
|
60
|
+
*EnquiriesApi* | [**createCustomerEnquiryChatChannel**](docs/EnquiriesApi.md#createcustomerenquirychatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel
|
|
61
61
|
*EnquiriesApi* | [**getCustomerEnquiry**](docs/EnquiriesApi.md#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry
|
|
62
62
|
*EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
|
|
63
63
|
*EnquiriesApi* | [**listCustomerEnquiryLogs**](docs/EnquiriesApi.md#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs
|
|
@@ -65,6 +65,7 @@ Class | Method | HTTP request | Description
|
|
|
65
65
|
*OrdersApi* | [**amendOrder**](docs/OrdersApi.md#amendorder) | **PATCH** /v1/platform/{platformId}/orders/{orderId}/amend | Amend the contents of an order
|
|
66
66
|
*OrdersApi* | [**confirmOrder**](docs/OrdersApi.md#confirmorder) | **POST** /v1/platform/{platformId}/orders/{orderId}/confirm | Confirm order
|
|
67
67
|
*OrdersApi* | [**createOrder**](docs/OrdersApi.md#createorder) | **POST** /v1/platform/{platformId}/orders | Create order
|
|
68
|
+
*OrdersApi* | [**createOrderChatChannel**](docs/OrdersApi.md#createorderchatchannel) | **POST** /v1/platform/{platformId}/orders/{orderId}/chat-channel | Create chat channel
|
|
68
69
|
*OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
|
|
69
70
|
*OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
|
|
70
71
|
*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
|
|
@@ -117,9 +118,9 @@ Class | Method | HTTP request | Description
|
|
|
117
118
|
- [ConfirmOrderRequest](docs/ConfirmOrderRequest.md)
|
|
118
119
|
- [ContactInformation](docs/ContactInformation.md)
|
|
119
120
|
- [Coupon](docs/Coupon.md)
|
|
120
|
-
- [CreateChatChannel200Response](docs/CreateChatChannel200Response.md)
|
|
121
121
|
- [CreateDomainRequest](docs/CreateDomainRequest.md)
|
|
122
122
|
- [CreateOrder](docs/CreateOrder.md)
|
|
123
|
+
- [CreateOrderChatChannel200Response](docs/CreateOrderChatChannel200Response.md)
|
|
123
124
|
- [CreateOrderContactInformation](docs/CreateOrderContactInformation.md)
|
|
124
125
|
- [CreatePixelRequest](docs/CreatePixelRequest.md)
|
|
125
126
|
- [CreatePixelRequestFilters](docs/CreatePixelRequestFilters.md)
|
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.40.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -180,12 +180,6 @@ export interface Coupon {
|
|
|
180
180
|
'id': string;
|
|
181
181
|
'code': string;
|
|
182
182
|
}
|
|
183
|
-
export interface CreateChatChannel200Response {
|
|
184
|
-
/**
|
|
185
|
-
* Reference to the chat channel resource
|
|
186
|
-
*/
|
|
187
|
-
'chatChannelRef': string;
|
|
188
|
-
}
|
|
189
183
|
export interface CreateDomainRequest {
|
|
190
184
|
'domain'?: string;
|
|
191
185
|
}
|
|
@@ -215,6 +209,12 @@ export interface CreateOrder {
|
|
|
215
209
|
*/
|
|
216
210
|
'client'?: string;
|
|
217
211
|
}
|
|
212
|
+
export interface CreateOrderChatChannel200Response {
|
|
213
|
+
/**
|
|
214
|
+
* Reference to the chat channel resource
|
|
215
|
+
*/
|
|
216
|
+
'chatChannelRef': string;
|
|
217
|
+
}
|
|
218
218
|
/**
|
|
219
219
|
* Contact information for the order
|
|
220
220
|
*/
|
|
@@ -264,6 +264,7 @@ export interface CreateReviewPayload {
|
|
|
264
264
|
* A reference to the project being ordered
|
|
265
265
|
*/
|
|
266
266
|
'projectRef': string;
|
|
267
|
+
'createdAt'?: string;
|
|
267
268
|
}
|
|
268
269
|
export interface CreateReviewPayloadAuthor {
|
|
269
270
|
/**
|
|
@@ -567,6 +568,10 @@ export interface Order {
|
|
|
567
568
|
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
568
569
|
*/
|
|
569
570
|
'integrationType'?: string;
|
|
571
|
+
/**
|
|
572
|
+
* Reference to the chat channel resource
|
|
573
|
+
*/
|
|
574
|
+
'chatChannelRef'?: string | null;
|
|
570
575
|
}
|
|
571
576
|
|
|
572
577
|
|
|
@@ -2122,13 +2127,13 @@ export const EnquiriesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2122
2127
|
* @param {*} [options] Override http request option.
|
|
2123
2128
|
* @throws {RequiredError}
|
|
2124
2129
|
*/
|
|
2125
|
-
|
|
2130
|
+
createCustomerEnquiryChatChannel: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2126
2131
|
// verify required parameter 'project' is not null or undefined
|
|
2127
|
-
assertParamExists('
|
|
2132
|
+
assertParamExists('createCustomerEnquiryChatChannel', 'project', project)
|
|
2128
2133
|
// verify required parameter 'platformId' is not null or undefined
|
|
2129
|
-
assertParamExists('
|
|
2134
|
+
assertParamExists('createCustomerEnquiryChatChannel', 'platformId', platformId)
|
|
2130
2135
|
// verify required parameter 'enquiryId' is not null or undefined
|
|
2131
|
-
assertParamExists('
|
|
2136
|
+
assertParamExists('createCustomerEnquiryChatChannel', 'enquiryId', enquiryId)
|
|
2132
2137
|
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel`
|
|
2133
2138
|
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2134
2139
|
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
@@ -2422,10 +2427,10 @@ export const EnquiriesApiFp = function(configuration?: Configuration) {
|
|
|
2422
2427
|
* @param {*} [options] Override http request option.
|
|
2423
2428
|
* @throws {RequiredError}
|
|
2424
2429
|
*/
|
|
2425
|
-
async
|
|
2426
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2430
|
+
async createCustomerEnquiryChatChannel(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>> {
|
|
2431
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomerEnquiryChatChannel(project, platformId, enquiryId, options);
|
|
2427
2432
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2428
|
-
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.
|
|
2433
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.createCustomerEnquiryChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
2429
2434
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2430
2435
|
},
|
|
2431
2436
|
/**
|
|
@@ -2505,12 +2510,12 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
|
|
|
2505
2510
|
/**
|
|
2506
2511
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
2507
2512
|
* @summary Create chat channel
|
|
2508
|
-
* @param {
|
|
2513
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
2509
2514
|
* @param {*} [options] Override http request option.
|
|
2510
2515
|
* @throws {RequiredError}
|
|
2511
2516
|
*/
|
|
2512
|
-
|
|
2513
|
-
return localVarFp.
|
|
2517
|
+
createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
2518
|
+
return localVarFp.createCustomerEnquiryChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2514
2519
|
},
|
|
2515
2520
|
/**
|
|
2516
2521
|
* Get a customer enquiry
|
|
@@ -2556,9 +2561,9 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
|
|
|
2556
2561
|
};
|
|
2557
2562
|
|
|
2558
2563
|
/**
|
|
2559
|
-
* Request parameters for
|
|
2564
|
+
* Request parameters for createCustomerEnquiryChatChannel operation in EnquiriesApi.
|
|
2560
2565
|
*/
|
|
2561
|
-
export interface
|
|
2566
|
+
export interface EnquiriesApiCreateCustomerEnquiryChatChannelRequest {
|
|
2562
2567
|
/**
|
|
2563
2568
|
* Project unique identifier
|
|
2564
2569
|
*/
|
|
@@ -2687,12 +2692,12 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
2687
2692
|
/**
|
|
2688
2693
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
2689
2694
|
* @summary Create chat channel
|
|
2690
|
-
* @param {
|
|
2695
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
2691
2696
|
* @param {*} [options] Override http request option.
|
|
2692
2697
|
* @throws {RequiredError}
|
|
2693
2698
|
*/
|
|
2694
|
-
public
|
|
2695
|
-
return EnquiriesApiFp(this.configuration).
|
|
2699
|
+
public createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig) {
|
|
2700
|
+
return EnquiriesApiFp(this.configuration).createCustomerEnquiryChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
2696
2701
|
}
|
|
2697
2702
|
|
|
2698
2703
|
/**
|
|
@@ -2917,6 +2922,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2917
2922
|
options: localVarRequestOptions,
|
|
2918
2923
|
};
|
|
2919
2924
|
},
|
|
2925
|
+
/**
|
|
2926
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2927
|
+
* @summary Create chat channel
|
|
2928
|
+
* @param {string} project Project unique identifier
|
|
2929
|
+
* @param {string} platformId The platform identifier
|
|
2930
|
+
* @param {string} orderId The order identifier
|
|
2931
|
+
* @param {*} [options] Override http request option.
|
|
2932
|
+
* @throws {RequiredError}
|
|
2933
|
+
*/
|
|
2934
|
+
createOrderChatChannel: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2935
|
+
// verify required parameter 'project' is not null or undefined
|
|
2936
|
+
assertParamExists('createOrderChatChannel', 'project', project)
|
|
2937
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2938
|
+
assertParamExists('createOrderChatChannel', 'platformId', platformId)
|
|
2939
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
2940
|
+
assertParamExists('createOrderChatChannel', 'orderId', orderId)
|
|
2941
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/chat-channel`
|
|
2942
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2943
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
2944
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2945
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2946
|
+
let baseOptions;
|
|
2947
|
+
if (configuration) {
|
|
2948
|
+
baseOptions = configuration.baseOptions;
|
|
2949
|
+
}
|
|
2950
|
+
|
|
2951
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2952
|
+
const localVarHeaderParameter = {} as any;
|
|
2953
|
+
const localVarQueryParameter = {} as any;
|
|
2954
|
+
|
|
2955
|
+
// authentication session-oauth required
|
|
2956
|
+
// oauth required
|
|
2957
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2958
|
+
|
|
2959
|
+
// authentication api-key required
|
|
2960
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2961
|
+
|
|
2962
|
+
if (project !== undefined) {
|
|
2963
|
+
localVarQueryParameter['project'] = project;
|
|
2964
|
+
}
|
|
2965
|
+
|
|
2966
|
+
|
|
2967
|
+
|
|
2968
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2969
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2970
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2971
|
+
|
|
2972
|
+
return {
|
|
2973
|
+
url: toPathString(localVarUrlObj),
|
|
2974
|
+
options: localVarRequestOptions,
|
|
2975
|
+
};
|
|
2976
|
+
},
|
|
2920
2977
|
/**
|
|
2921
2978
|
* Export orders as a CSV file
|
|
2922
2979
|
* @summary Export orders
|
|
@@ -3562,6 +3619,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3562
3619
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrder']?.[localVarOperationServerIndex]?.url;
|
|
3563
3620
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3564
3621
|
},
|
|
3622
|
+
/**
|
|
3623
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
3624
|
+
* @summary Create chat channel
|
|
3625
|
+
* @param {string} project Project unique identifier
|
|
3626
|
+
* @param {string} platformId The platform identifier
|
|
3627
|
+
* @param {string} orderId The order identifier
|
|
3628
|
+
* @param {*} [options] Override http request option.
|
|
3629
|
+
* @throws {RequiredError}
|
|
3630
|
+
*/
|
|
3631
|
+
async createOrderChatChannel(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>> {
|
|
3632
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrderChatChannel(project, platformId, orderId, options);
|
|
3633
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3634
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrderChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
3635
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3636
|
+
},
|
|
3565
3637
|
/**
|
|
3566
3638
|
* Export orders as a CSV file
|
|
3567
3639
|
* @summary Export orders
|
|
@@ -3762,6 +3834,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3762
3834
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
3763
3835
|
return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
|
|
3764
3836
|
},
|
|
3837
|
+
/**
|
|
3838
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
3839
|
+
* @summary Create chat channel
|
|
3840
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
3841
|
+
* @param {*} [options] Override http request option.
|
|
3842
|
+
* @throws {RequiredError}
|
|
3843
|
+
*/
|
|
3844
|
+
createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
3845
|
+
return localVarFp.createOrderChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3846
|
+
},
|
|
3765
3847
|
/**
|
|
3766
3848
|
* Export orders as a CSV file
|
|
3767
3849
|
* @summary Export orders
|
|
@@ -3935,6 +4017,26 @@ export interface OrdersApiCreateOrderRequest {
|
|
|
3935
4017
|
readonly createOrder: CreateOrder
|
|
3936
4018
|
}
|
|
3937
4019
|
|
|
4020
|
+
/**
|
|
4021
|
+
* Request parameters for createOrderChatChannel operation in OrdersApi.
|
|
4022
|
+
*/
|
|
4023
|
+
export interface OrdersApiCreateOrderChatChannelRequest {
|
|
4024
|
+
/**
|
|
4025
|
+
* Project unique identifier
|
|
4026
|
+
*/
|
|
4027
|
+
readonly project: string
|
|
4028
|
+
|
|
4029
|
+
/**
|
|
4030
|
+
* The platform identifier
|
|
4031
|
+
*/
|
|
4032
|
+
readonly platformId: string
|
|
4033
|
+
|
|
4034
|
+
/**
|
|
4035
|
+
* The order identifier
|
|
4036
|
+
*/
|
|
4037
|
+
readonly orderId: string
|
|
4038
|
+
}
|
|
4039
|
+
|
|
3938
4040
|
/**
|
|
3939
4041
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
3940
4042
|
*/
|
|
@@ -4224,6 +4326,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
4224
4326
|
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
|
|
4225
4327
|
}
|
|
4226
4328
|
|
|
4329
|
+
/**
|
|
4330
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
4331
|
+
* @summary Create chat channel
|
|
4332
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
4333
|
+
* @param {*} [options] Override http request option.
|
|
4334
|
+
* @throws {RequiredError}
|
|
4335
|
+
*/
|
|
4336
|
+
public createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig) {
|
|
4337
|
+
return OrdersApiFp(this.configuration).createOrderChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
4338
|
+
}
|
|
4339
|
+
|
|
4227
4340
|
/**
|
|
4228
4341
|
* Export orders as a CSV file
|
|
4229
4342
|
* @summary Export orders
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.40.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -164,12 +164,6 @@ export interface Coupon {
|
|
|
164
164
|
'id': string;
|
|
165
165
|
'code': string;
|
|
166
166
|
}
|
|
167
|
-
export interface CreateChatChannel200Response {
|
|
168
|
-
/**
|
|
169
|
-
* Reference to the chat channel resource
|
|
170
|
-
*/
|
|
171
|
-
'chatChannelRef': string;
|
|
172
|
-
}
|
|
173
167
|
export interface CreateDomainRequest {
|
|
174
168
|
'domain'?: string;
|
|
175
169
|
}
|
|
@@ -199,6 +193,12 @@ export interface CreateOrder {
|
|
|
199
193
|
*/
|
|
200
194
|
'client'?: string;
|
|
201
195
|
}
|
|
196
|
+
export interface CreateOrderChatChannel200Response {
|
|
197
|
+
/**
|
|
198
|
+
* Reference to the chat channel resource
|
|
199
|
+
*/
|
|
200
|
+
'chatChannelRef': string;
|
|
201
|
+
}
|
|
202
202
|
/**
|
|
203
203
|
* Contact information for the order
|
|
204
204
|
*/
|
|
@@ -247,6 +247,7 @@ export interface CreateReviewPayload {
|
|
|
247
247
|
* A reference to the project being ordered
|
|
248
248
|
*/
|
|
249
249
|
'projectRef': string;
|
|
250
|
+
'createdAt'?: string;
|
|
250
251
|
}
|
|
251
252
|
export interface CreateReviewPayloadAuthor {
|
|
252
253
|
/**
|
|
@@ -542,6 +543,10 @@ export interface Order {
|
|
|
542
543
|
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
543
544
|
*/
|
|
544
545
|
'integrationType'?: string;
|
|
546
|
+
/**
|
|
547
|
+
* Reference to the chat channel resource
|
|
548
|
+
*/
|
|
549
|
+
'chatChannelRef'?: string | null;
|
|
545
550
|
}
|
|
546
551
|
export interface OrderItem {
|
|
547
552
|
/**
|
|
@@ -1545,7 +1550,7 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1545
1550
|
* @param {*} [options] Override http request option.
|
|
1546
1551
|
* @throws {RequiredError}
|
|
1547
1552
|
*/
|
|
1548
|
-
|
|
1553
|
+
createCustomerEnquiryChatChannel: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1549
1554
|
/**
|
|
1550
1555
|
* Get a customer enquiry
|
|
1551
1556
|
* @summary Get customer enquiry
|
|
@@ -1605,7 +1610,7 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
|
1605
1610
|
* @param {*} [options] Override http request option.
|
|
1606
1611
|
* @throws {RequiredError}
|
|
1607
1612
|
*/
|
|
1608
|
-
|
|
1613
|
+
createCustomerEnquiryChatChannel(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1609
1614
|
/**
|
|
1610
1615
|
* Get a customer enquiry
|
|
1611
1616
|
* @summary Get customer enquiry
|
|
@@ -1659,11 +1664,11 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
1659
1664
|
/**
|
|
1660
1665
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
1661
1666
|
* @summary Create chat channel
|
|
1662
|
-
* @param {
|
|
1667
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
1663
1668
|
* @param {*} [options] Override http request option.
|
|
1664
1669
|
* @throws {RequiredError}
|
|
1665
1670
|
*/
|
|
1666
|
-
|
|
1671
|
+
createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1667
1672
|
/**
|
|
1668
1673
|
* Get a customer enquiry
|
|
1669
1674
|
* @summary Get customer enquiry
|
|
@@ -1698,9 +1703,9 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
1698
1703
|
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry>;
|
|
1699
1704
|
};
|
|
1700
1705
|
/**
|
|
1701
|
-
* Request parameters for
|
|
1706
|
+
* Request parameters for createCustomerEnquiryChatChannel operation in EnquiriesApi.
|
|
1702
1707
|
*/
|
|
1703
|
-
export interface
|
|
1708
|
+
export interface EnquiriesApiCreateCustomerEnquiryChatChannelRequest {
|
|
1704
1709
|
/**
|
|
1705
1710
|
* Project unique identifier
|
|
1706
1711
|
*/
|
|
@@ -1809,11 +1814,11 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
1809
1814
|
/**
|
|
1810
1815
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
1811
1816
|
* @summary Create chat channel
|
|
1812
|
-
* @param {
|
|
1817
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
1813
1818
|
* @param {*} [options] Override http request option.
|
|
1814
1819
|
* @throws {RequiredError}
|
|
1815
1820
|
*/
|
|
1816
|
-
|
|
1821
|
+
createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1817
1822
|
/**
|
|
1818
1823
|
* Get a customer enquiry
|
|
1819
1824
|
* @summary Get customer enquiry
|
|
@@ -1883,6 +1888,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1883
1888
|
* @throws {RequiredError}
|
|
1884
1889
|
*/
|
|
1885
1890
|
createOrder: (project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1891
|
+
/**
|
|
1892
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
1893
|
+
* @summary Create chat channel
|
|
1894
|
+
* @param {string} project Project unique identifier
|
|
1895
|
+
* @param {string} platformId The platform identifier
|
|
1896
|
+
* @param {string} orderId The order identifier
|
|
1897
|
+
* @param {*} [options] Override http request option.
|
|
1898
|
+
* @throws {RequiredError}
|
|
1899
|
+
*/
|
|
1900
|
+
createOrderChatChannel: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1886
1901
|
/**
|
|
1887
1902
|
* Export orders as a CSV file
|
|
1888
1903
|
* @summary Export orders
|
|
@@ -2031,6 +2046,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2031
2046
|
* @throws {RequiredError}
|
|
2032
2047
|
*/
|
|
2033
2048
|
createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2049
|
+
/**
|
|
2050
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2051
|
+
* @summary Create chat channel
|
|
2052
|
+
* @param {string} project Project unique identifier
|
|
2053
|
+
* @param {string} platformId The platform identifier
|
|
2054
|
+
* @param {string} orderId The order identifier
|
|
2055
|
+
* @param {*} [options] Override http request option.
|
|
2056
|
+
* @throws {RequiredError}
|
|
2057
|
+
*/
|
|
2058
|
+
createOrderChatChannel(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
2034
2059
|
/**
|
|
2035
2060
|
* Export orders as a CSV file
|
|
2036
2061
|
* @summary Export orders
|
|
@@ -2171,6 +2196,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2171
2196
|
* @throws {RequiredError}
|
|
2172
2197
|
*/
|
|
2173
2198
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2199
|
+
/**
|
|
2200
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2201
|
+
* @summary Create chat channel
|
|
2202
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
2203
|
+
* @param {*} [options] Override http request option.
|
|
2204
|
+
* @throws {RequiredError}
|
|
2205
|
+
*/
|
|
2206
|
+
createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
2174
2207
|
/**
|
|
2175
2208
|
* Export orders as a CSV file
|
|
2176
2209
|
* @summary Export orders
|
|
@@ -2311,6 +2344,23 @@ export interface OrdersApiCreateOrderRequest {
|
|
|
2311
2344
|
*/
|
|
2312
2345
|
readonly createOrder: CreateOrder;
|
|
2313
2346
|
}
|
|
2347
|
+
/**
|
|
2348
|
+
* Request parameters for createOrderChatChannel operation in OrdersApi.
|
|
2349
|
+
*/
|
|
2350
|
+
export interface OrdersApiCreateOrderChatChannelRequest {
|
|
2351
|
+
/**
|
|
2352
|
+
* Project unique identifier
|
|
2353
|
+
*/
|
|
2354
|
+
readonly project: string;
|
|
2355
|
+
/**
|
|
2356
|
+
* The platform identifier
|
|
2357
|
+
*/
|
|
2358
|
+
readonly platformId: string;
|
|
2359
|
+
/**
|
|
2360
|
+
* The order identifier
|
|
2361
|
+
*/
|
|
2362
|
+
readonly orderId: string;
|
|
2363
|
+
}
|
|
2314
2364
|
/**
|
|
2315
2365
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
2316
2366
|
*/
|
|
@@ -2550,6 +2600,14 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2550
2600
|
* @throws {RequiredError}
|
|
2551
2601
|
*/
|
|
2552
2602
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
|
|
2603
|
+
/**
|
|
2604
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2605
|
+
* @summary Create chat channel
|
|
2606
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
2607
|
+
* @param {*} [options] Override http request option.
|
|
2608
|
+
* @throws {RequiredError}
|
|
2609
|
+
*/
|
|
2610
|
+
createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
2553
2611
|
/**
|
|
2554
2612
|
* Export orders as a CSV file
|
|
2555
2613
|
* @summary Export orders
|