@teemill/platform 0.39.0 → 0.41.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 +139 -22
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +77 -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 +77 -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/EnquiriesApi.md +5 -5
- package/docs/Order.md +2 -0
- package/docs/OrdersApi.md +63 -0
- package/docs/Platform.md +2 -0
- package/docs/UpdatePlatformRequest.md +2 -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.41.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.41.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.41.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
|
*/
|
|
@@ -568,6 +568,10 @@ export interface Order {
|
|
|
568
568
|
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
569
569
|
*/
|
|
570
570
|
'integrationType'?: string;
|
|
571
|
+
/**
|
|
572
|
+
* Reference to the chat channel resource
|
|
573
|
+
*/
|
|
574
|
+
'chatChannelRef'?: string | null;
|
|
571
575
|
}
|
|
572
576
|
|
|
573
577
|
|
|
@@ -736,6 +740,10 @@ export interface Platform {
|
|
|
736
740
|
* Whether the platform can charge clients for orders
|
|
737
741
|
*/
|
|
738
742
|
'chargeClients': boolean;
|
|
743
|
+
/**
|
|
744
|
+
* Recipient of customer service emails
|
|
745
|
+
*/
|
|
746
|
+
'customerServiceEmail': string | null;
|
|
739
747
|
}
|
|
740
748
|
export interface PlatformLogo {
|
|
741
749
|
'url': string;
|
|
@@ -952,6 +960,7 @@ export interface UpdatePlatformRequest {
|
|
|
952
960
|
'itemHandlingFee'?: number;
|
|
953
961
|
'neckPrintFee'?: number;
|
|
954
962
|
'chargeClients'?: boolean;
|
|
963
|
+
'customerServiceEmail'?: string | null;
|
|
955
964
|
}
|
|
956
965
|
export interface ValidationError {
|
|
957
966
|
'message': string;
|
|
@@ -2123,13 +2132,13 @@ export const EnquiriesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2123
2132
|
* @param {*} [options] Override http request option.
|
|
2124
2133
|
* @throws {RequiredError}
|
|
2125
2134
|
*/
|
|
2126
|
-
|
|
2135
|
+
createCustomerEnquiryChatChannel: async (project: string, platformId: string, enquiryId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2127
2136
|
// verify required parameter 'project' is not null or undefined
|
|
2128
|
-
assertParamExists('
|
|
2137
|
+
assertParamExists('createCustomerEnquiryChatChannel', 'project', project)
|
|
2129
2138
|
// verify required parameter 'platformId' is not null or undefined
|
|
2130
|
-
assertParamExists('
|
|
2139
|
+
assertParamExists('createCustomerEnquiryChatChannel', 'platformId', platformId)
|
|
2131
2140
|
// verify required parameter 'enquiryId' is not null or undefined
|
|
2132
|
-
assertParamExists('
|
|
2141
|
+
assertParamExists('createCustomerEnquiryChatChannel', 'enquiryId', enquiryId)
|
|
2133
2142
|
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel`
|
|
2134
2143
|
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2135
2144
|
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
@@ -2423,10 +2432,10 @@ export const EnquiriesApiFp = function(configuration?: Configuration) {
|
|
|
2423
2432
|
* @param {*} [options] Override http request option.
|
|
2424
2433
|
* @throws {RequiredError}
|
|
2425
2434
|
*/
|
|
2426
|
-
async
|
|
2427
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2435
|
+
async createCustomerEnquiryChatChannel(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>> {
|
|
2436
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomerEnquiryChatChannel(project, platformId, enquiryId, options);
|
|
2428
2437
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2429
|
-
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.
|
|
2438
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.createCustomerEnquiryChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
2430
2439
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2431
2440
|
},
|
|
2432
2441
|
/**
|
|
@@ -2506,12 +2515,12 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
|
|
|
2506
2515
|
/**
|
|
2507
2516
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
2508
2517
|
* @summary Create chat channel
|
|
2509
|
-
* @param {
|
|
2518
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
2510
2519
|
* @param {*} [options] Override http request option.
|
|
2511
2520
|
* @throws {RequiredError}
|
|
2512
2521
|
*/
|
|
2513
|
-
|
|
2514
|
-
return localVarFp.
|
|
2522
|
+
createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
2523
|
+
return localVarFp.createCustomerEnquiryChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2515
2524
|
},
|
|
2516
2525
|
/**
|
|
2517
2526
|
* Get a customer enquiry
|
|
@@ -2557,9 +2566,9 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
|
|
|
2557
2566
|
};
|
|
2558
2567
|
|
|
2559
2568
|
/**
|
|
2560
|
-
* Request parameters for
|
|
2569
|
+
* Request parameters for createCustomerEnquiryChatChannel operation in EnquiriesApi.
|
|
2561
2570
|
*/
|
|
2562
|
-
export interface
|
|
2571
|
+
export interface EnquiriesApiCreateCustomerEnquiryChatChannelRequest {
|
|
2563
2572
|
/**
|
|
2564
2573
|
* Project unique identifier
|
|
2565
2574
|
*/
|
|
@@ -2688,12 +2697,12 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
2688
2697
|
/**
|
|
2689
2698
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
2690
2699
|
* @summary Create chat channel
|
|
2691
|
-
* @param {
|
|
2700
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
2692
2701
|
* @param {*} [options] Override http request option.
|
|
2693
2702
|
* @throws {RequiredError}
|
|
2694
2703
|
*/
|
|
2695
|
-
public
|
|
2696
|
-
return EnquiriesApiFp(this.configuration).
|
|
2704
|
+
public createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig) {
|
|
2705
|
+
return EnquiriesApiFp(this.configuration).createCustomerEnquiryChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
2697
2706
|
}
|
|
2698
2707
|
|
|
2699
2708
|
/**
|
|
@@ -2918,6 +2927,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2918
2927
|
options: localVarRequestOptions,
|
|
2919
2928
|
};
|
|
2920
2929
|
},
|
|
2930
|
+
/**
|
|
2931
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2932
|
+
* @summary Create chat channel
|
|
2933
|
+
* @param {string} project Project unique identifier
|
|
2934
|
+
* @param {string} platformId The platform identifier
|
|
2935
|
+
* @param {string} orderId The order identifier
|
|
2936
|
+
* @param {*} [options] Override http request option.
|
|
2937
|
+
* @throws {RequiredError}
|
|
2938
|
+
*/
|
|
2939
|
+
createOrderChatChannel: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2940
|
+
// verify required parameter 'project' is not null or undefined
|
|
2941
|
+
assertParamExists('createOrderChatChannel', 'project', project)
|
|
2942
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2943
|
+
assertParamExists('createOrderChatChannel', 'platformId', platformId)
|
|
2944
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
2945
|
+
assertParamExists('createOrderChatChannel', 'orderId', orderId)
|
|
2946
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/chat-channel`
|
|
2947
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2948
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
2949
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2950
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2951
|
+
let baseOptions;
|
|
2952
|
+
if (configuration) {
|
|
2953
|
+
baseOptions = configuration.baseOptions;
|
|
2954
|
+
}
|
|
2955
|
+
|
|
2956
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
2957
|
+
const localVarHeaderParameter = {} as any;
|
|
2958
|
+
const localVarQueryParameter = {} as any;
|
|
2959
|
+
|
|
2960
|
+
// authentication session-oauth required
|
|
2961
|
+
// oauth required
|
|
2962
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2963
|
+
|
|
2964
|
+
// authentication api-key required
|
|
2965
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2966
|
+
|
|
2967
|
+
if (project !== undefined) {
|
|
2968
|
+
localVarQueryParameter['project'] = project;
|
|
2969
|
+
}
|
|
2970
|
+
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2974
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2975
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2976
|
+
|
|
2977
|
+
return {
|
|
2978
|
+
url: toPathString(localVarUrlObj),
|
|
2979
|
+
options: localVarRequestOptions,
|
|
2980
|
+
};
|
|
2981
|
+
},
|
|
2921
2982
|
/**
|
|
2922
2983
|
* Export orders as a CSV file
|
|
2923
2984
|
* @summary Export orders
|
|
@@ -3563,6 +3624,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3563
3624
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrder']?.[localVarOperationServerIndex]?.url;
|
|
3564
3625
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3565
3626
|
},
|
|
3627
|
+
/**
|
|
3628
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
3629
|
+
* @summary Create chat channel
|
|
3630
|
+
* @param {string} project Project unique identifier
|
|
3631
|
+
* @param {string} platformId The platform identifier
|
|
3632
|
+
* @param {string} orderId The order identifier
|
|
3633
|
+
* @param {*} [options] Override http request option.
|
|
3634
|
+
* @throws {RequiredError}
|
|
3635
|
+
*/
|
|
3636
|
+
async createOrderChatChannel(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>> {
|
|
3637
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrderChatChannel(project, platformId, orderId, options);
|
|
3638
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3639
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrderChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
3640
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3641
|
+
},
|
|
3566
3642
|
/**
|
|
3567
3643
|
* Export orders as a CSV file
|
|
3568
3644
|
* @summary Export orders
|
|
@@ -3763,6 +3839,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3763
3839
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
3764
3840
|
return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
|
|
3765
3841
|
},
|
|
3842
|
+
/**
|
|
3843
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
3844
|
+
* @summary Create chat channel
|
|
3845
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
3846
|
+
* @param {*} [options] Override http request option.
|
|
3847
|
+
* @throws {RequiredError}
|
|
3848
|
+
*/
|
|
3849
|
+
createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
3850
|
+
return localVarFp.createOrderChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3851
|
+
},
|
|
3766
3852
|
/**
|
|
3767
3853
|
* Export orders as a CSV file
|
|
3768
3854
|
* @summary Export orders
|
|
@@ -3936,6 +4022,26 @@ export interface OrdersApiCreateOrderRequest {
|
|
|
3936
4022
|
readonly createOrder: CreateOrder
|
|
3937
4023
|
}
|
|
3938
4024
|
|
|
4025
|
+
/**
|
|
4026
|
+
* Request parameters for createOrderChatChannel operation in OrdersApi.
|
|
4027
|
+
*/
|
|
4028
|
+
export interface OrdersApiCreateOrderChatChannelRequest {
|
|
4029
|
+
/**
|
|
4030
|
+
* Project unique identifier
|
|
4031
|
+
*/
|
|
4032
|
+
readonly project: string
|
|
4033
|
+
|
|
4034
|
+
/**
|
|
4035
|
+
* The platform identifier
|
|
4036
|
+
*/
|
|
4037
|
+
readonly platformId: string
|
|
4038
|
+
|
|
4039
|
+
/**
|
|
4040
|
+
* The order identifier
|
|
4041
|
+
*/
|
|
4042
|
+
readonly orderId: string
|
|
4043
|
+
}
|
|
4044
|
+
|
|
3939
4045
|
/**
|
|
3940
4046
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
3941
4047
|
*/
|
|
@@ -4225,6 +4331,17 @@ export class OrdersApi extends BaseAPI {
|
|
|
4225
4331
|
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
|
|
4226
4332
|
}
|
|
4227
4333
|
|
|
4334
|
+
/**
|
|
4335
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
4336
|
+
* @summary Create chat channel
|
|
4337
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
4338
|
+
* @param {*} [options] Override http request option.
|
|
4339
|
+
* @throws {RequiredError}
|
|
4340
|
+
*/
|
|
4341
|
+
public createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig) {
|
|
4342
|
+
return OrdersApiFp(this.configuration).createOrderChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
4343
|
+
}
|
|
4344
|
+
|
|
4228
4345
|
/**
|
|
4229
4346
|
* Export orders as a CSV file
|
|
4230
4347
|
* @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.41.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
|
*/
|
|
@@ -543,6 +543,10 @@ export interface Order {
|
|
|
543
543
|
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
544
544
|
*/
|
|
545
545
|
'integrationType'?: string;
|
|
546
|
+
/**
|
|
547
|
+
* Reference to the chat channel resource
|
|
548
|
+
*/
|
|
549
|
+
'chatChannelRef'?: string | null;
|
|
546
550
|
}
|
|
547
551
|
export interface OrderItem {
|
|
548
552
|
/**
|
|
@@ -700,6 +704,10 @@ export interface Platform {
|
|
|
700
704
|
* Whether the platform can charge clients for orders
|
|
701
705
|
*/
|
|
702
706
|
'chargeClients': boolean;
|
|
707
|
+
/**
|
|
708
|
+
* Recipient of customer service emails
|
|
709
|
+
*/
|
|
710
|
+
'customerServiceEmail': string | null;
|
|
703
711
|
}
|
|
704
712
|
export interface PlatformLogo {
|
|
705
713
|
'url': string;
|
|
@@ -913,6 +921,7 @@ export interface UpdatePlatformRequest {
|
|
|
913
921
|
'itemHandlingFee'?: number;
|
|
914
922
|
'neckPrintFee'?: number;
|
|
915
923
|
'chargeClients'?: boolean;
|
|
924
|
+
'customerServiceEmail'?: string | null;
|
|
916
925
|
}
|
|
917
926
|
export interface ValidationError {
|
|
918
927
|
'message': string;
|
|
@@ -1546,7 +1555,7 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1546
1555
|
* @param {*} [options] Override http request option.
|
|
1547
1556
|
* @throws {RequiredError}
|
|
1548
1557
|
*/
|
|
1549
|
-
|
|
1558
|
+
createCustomerEnquiryChatChannel: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1550
1559
|
/**
|
|
1551
1560
|
* Get a customer enquiry
|
|
1552
1561
|
* @summary Get customer enquiry
|
|
@@ -1606,7 +1615,7 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
|
1606
1615
|
* @param {*} [options] Override http request option.
|
|
1607
1616
|
* @throws {RequiredError}
|
|
1608
1617
|
*/
|
|
1609
|
-
|
|
1618
|
+
createCustomerEnquiryChatChannel(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1610
1619
|
/**
|
|
1611
1620
|
* Get a customer enquiry
|
|
1612
1621
|
* @summary Get customer enquiry
|
|
@@ -1660,11 +1669,11 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
1660
1669
|
/**
|
|
1661
1670
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
1662
1671
|
* @summary Create chat channel
|
|
1663
|
-
* @param {
|
|
1672
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
1664
1673
|
* @param {*} [options] Override http request option.
|
|
1665
1674
|
* @throws {RequiredError}
|
|
1666
1675
|
*/
|
|
1667
|
-
|
|
1676
|
+
createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1668
1677
|
/**
|
|
1669
1678
|
* Get a customer enquiry
|
|
1670
1679
|
* @summary Get customer enquiry
|
|
@@ -1699,9 +1708,9 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
1699
1708
|
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry>;
|
|
1700
1709
|
};
|
|
1701
1710
|
/**
|
|
1702
|
-
* Request parameters for
|
|
1711
|
+
* Request parameters for createCustomerEnquiryChatChannel operation in EnquiriesApi.
|
|
1703
1712
|
*/
|
|
1704
|
-
export interface
|
|
1713
|
+
export interface EnquiriesApiCreateCustomerEnquiryChatChannelRequest {
|
|
1705
1714
|
/**
|
|
1706
1715
|
* Project unique identifier
|
|
1707
1716
|
*/
|
|
@@ -1810,11 +1819,11 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
1810
1819
|
/**
|
|
1811
1820
|
* Create a chat channel for a customer enquiry if it doesn\'t exist
|
|
1812
1821
|
* @summary Create chat channel
|
|
1813
|
-
* @param {
|
|
1822
|
+
* @param {EnquiriesApiCreateCustomerEnquiryChatChannelRequest} requestParameters Request parameters.
|
|
1814
1823
|
* @param {*} [options] Override http request option.
|
|
1815
1824
|
* @throws {RequiredError}
|
|
1816
1825
|
*/
|
|
1817
|
-
|
|
1826
|
+
createCustomerEnquiryChatChannel(requestParameters: EnquiriesApiCreateCustomerEnquiryChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1818
1827
|
/**
|
|
1819
1828
|
* Get a customer enquiry
|
|
1820
1829
|
* @summary Get customer enquiry
|
|
@@ -1884,6 +1893,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1884
1893
|
* @throws {RequiredError}
|
|
1885
1894
|
*/
|
|
1886
1895
|
createOrder: (project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1896
|
+
/**
|
|
1897
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
1898
|
+
* @summary Create chat channel
|
|
1899
|
+
* @param {string} project Project unique identifier
|
|
1900
|
+
* @param {string} platformId The platform identifier
|
|
1901
|
+
* @param {string} orderId The order identifier
|
|
1902
|
+
* @param {*} [options] Override http request option.
|
|
1903
|
+
* @throws {RequiredError}
|
|
1904
|
+
*/
|
|
1905
|
+
createOrderChatChannel: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1887
1906
|
/**
|
|
1888
1907
|
* Export orders as a CSV file
|
|
1889
1908
|
* @summary Export orders
|
|
@@ -2032,6 +2051,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2032
2051
|
* @throws {RequiredError}
|
|
2033
2052
|
*/
|
|
2034
2053
|
createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2054
|
+
/**
|
|
2055
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2056
|
+
* @summary Create chat channel
|
|
2057
|
+
* @param {string} project Project unique identifier
|
|
2058
|
+
* @param {string} platformId The platform identifier
|
|
2059
|
+
* @param {string} orderId The order identifier
|
|
2060
|
+
* @param {*} [options] Override http request option.
|
|
2061
|
+
* @throws {RequiredError}
|
|
2062
|
+
*/
|
|
2063
|
+
createOrderChatChannel(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
2035
2064
|
/**
|
|
2036
2065
|
* Export orders as a CSV file
|
|
2037
2066
|
* @summary Export orders
|
|
@@ -2172,6 +2201,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2172
2201
|
* @throws {RequiredError}
|
|
2173
2202
|
*/
|
|
2174
2203
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2204
|
+
/**
|
|
2205
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2206
|
+
* @summary Create chat channel
|
|
2207
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
2208
|
+
* @param {*} [options] Override http request option.
|
|
2209
|
+
* @throws {RequiredError}
|
|
2210
|
+
*/
|
|
2211
|
+
createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
2175
2212
|
/**
|
|
2176
2213
|
* Export orders as a CSV file
|
|
2177
2214
|
* @summary Export orders
|
|
@@ -2312,6 +2349,23 @@ export interface OrdersApiCreateOrderRequest {
|
|
|
2312
2349
|
*/
|
|
2313
2350
|
readonly createOrder: CreateOrder;
|
|
2314
2351
|
}
|
|
2352
|
+
/**
|
|
2353
|
+
* Request parameters for createOrderChatChannel operation in OrdersApi.
|
|
2354
|
+
*/
|
|
2355
|
+
export interface OrdersApiCreateOrderChatChannelRequest {
|
|
2356
|
+
/**
|
|
2357
|
+
* Project unique identifier
|
|
2358
|
+
*/
|
|
2359
|
+
readonly project: string;
|
|
2360
|
+
/**
|
|
2361
|
+
* The platform identifier
|
|
2362
|
+
*/
|
|
2363
|
+
readonly platformId: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* The order identifier
|
|
2366
|
+
*/
|
|
2367
|
+
readonly orderId: string;
|
|
2368
|
+
}
|
|
2315
2369
|
/**
|
|
2316
2370
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
2317
2371
|
*/
|
|
@@ -2551,6 +2605,14 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2551
2605
|
* @throws {RequiredError}
|
|
2552
2606
|
*/
|
|
2553
2607
|
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any, {}>>;
|
|
2608
|
+
/**
|
|
2609
|
+
* Create a chat channel for a platform order if it doesn\'t exist
|
|
2610
|
+
* @summary Create chat channel
|
|
2611
|
+
* @param {OrdersApiCreateOrderChatChannelRequest} requestParameters Request parameters.
|
|
2612
|
+
* @param {*} [options] Override http request option.
|
|
2613
|
+
* @throws {RequiredError}
|
|
2614
|
+
*/
|
|
2615
|
+
createOrderChatChannel(requestParameters: OrdersApiCreateOrderChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
2554
2616
|
/**
|
|
2555
2617
|
* Export orders as a CSV file
|
|
2556
2618
|
* @summary Export orders
|