@teemill/platform 0.53.0 → 0.54.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 +4 -2
- package/api.ts +124 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +66 -2
- package/dist/api.js +88 -1
- 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 +66 -2
- package/dist/esm/api.js +88 -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/Customer.md +2 -0
- package/docs/CustomersApi.md +66 -0
- package/docs/Order.md +1 -1
- package/docs/UpdateCustomerRequest.md +26 -0
- package/docs/UpdateOrderRequest.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.54.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.54.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -56,6 +56,7 @@ Class | Method | HTTP request | Description
|
|
|
56
56
|
*CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
|
|
57
57
|
*CustomersApi* | [**listCustomerTags**](docs/CustomersApi.md#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags
|
|
58
58
|
*CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
|
|
59
|
+
*CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID
|
|
59
60
|
*DashboardApi* | [**getDashboard**](docs/DashboardApi.md#getdashboard) | **GET** /v1/platform/{platformId}/dashboard | Get the platform\'s dashboard
|
|
60
61
|
*DashboardApi* | [**saveDashboard**](docs/DashboardApi.md#savedashboard) | **PUT** /v1/platform/{platformId}/dashboard | Save the platform\'s dashboard
|
|
61
62
|
*EnquiriesApi* | [**createCustomerEnquiryChatChannel**](docs/EnquiriesApi.md#createcustomerenquirychatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel
|
|
@@ -197,6 +198,7 @@ Class | Method | HTTP request | Description
|
|
|
197
198
|
- [StatusHistoryItem](docs/StatusHistoryItem.md)
|
|
198
199
|
- [Terms](docs/Terms.md)
|
|
199
200
|
- [UpdateCustomerEnquiryRequest](docs/UpdateCustomerEnquiryRequest.md)
|
|
201
|
+
- [UpdateCustomerRequest](docs/UpdateCustomerRequest.md)
|
|
200
202
|
- [UpdateFulfillmentRequest](docs/UpdateFulfillmentRequest.md)
|
|
201
203
|
- [UpdateModerationItemRequest](docs/UpdateModerationItemRequest.md)
|
|
202
204
|
- [UpdateOrderRequest](docs/UpdateOrderRequest.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.54.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -344,6 +344,7 @@ export interface Customer {
|
|
|
344
344
|
'country': string | null;
|
|
345
345
|
'statistics': Statistics;
|
|
346
346
|
'shippingAddress'?: Address;
|
|
347
|
+
'billingAddress'?: Address;
|
|
347
348
|
/**
|
|
348
349
|
* Reference to the chat channel resource
|
|
349
350
|
*/
|
|
@@ -606,7 +607,7 @@ export interface Order {
|
|
|
606
607
|
'contactInformation': ContactInformation;
|
|
607
608
|
'paymentMethod'?: OrderPaymentMethod;
|
|
608
609
|
'shippingAddress': Address;
|
|
609
|
-
'billingAddress'
|
|
610
|
+
'billingAddress': Address;
|
|
610
611
|
/**
|
|
611
612
|
* ISO 8601 Timestamp
|
|
612
613
|
*/
|
|
@@ -1043,6 +1044,12 @@ export interface UpdateCustomerEnquiryRequest {
|
|
|
1043
1044
|
*/
|
|
1044
1045
|
'owner'?: string | null;
|
|
1045
1046
|
}
|
|
1047
|
+
export interface UpdateCustomerRequest {
|
|
1048
|
+
'email'?: string;
|
|
1049
|
+
'name'?: string;
|
|
1050
|
+
'billingAddress'?: Address;
|
|
1051
|
+
'shippingAddress'?: Address;
|
|
1052
|
+
}
|
|
1046
1053
|
export interface UpdateFulfillmentRequest {
|
|
1047
1054
|
/**
|
|
1048
1055
|
* Unique object identifier
|
|
@@ -1063,6 +1070,7 @@ export type UpdateModerationItemRequestJudgementEnum = typeof UpdateModerationIt
|
|
|
1063
1070
|
|
|
1064
1071
|
export interface UpdateOrderRequest {
|
|
1065
1072
|
'email'?: string;
|
|
1073
|
+
'billingAddress'?: Address;
|
|
1066
1074
|
'shippingAddress'?: Address;
|
|
1067
1075
|
'priorityLevel'?: PriorityLevel;
|
|
1068
1076
|
}
|
|
@@ -1550,6 +1558,61 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1550
1558
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1551
1559
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1552
1560
|
|
|
1561
|
+
return {
|
|
1562
|
+
url: toPathString(localVarUrlObj),
|
|
1563
|
+
options: localVarRequestOptions,
|
|
1564
|
+
};
|
|
1565
|
+
},
|
|
1566
|
+
/**
|
|
1567
|
+
*
|
|
1568
|
+
* @summary Update the customer with the given customer ID
|
|
1569
|
+
* @param {string} project Project unique identifier
|
|
1570
|
+
* @param {string} platformId The platform identifier
|
|
1571
|
+
* @param {string} customerId The customer identifier
|
|
1572
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1573
|
+
* @param {*} [options] Override http request option.
|
|
1574
|
+
* @throws {RequiredError}
|
|
1575
|
+
*/
|
|
1576
|
+
updateCustomer: async (project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1577
|
+
// verify required parameter 'project' is not null or undefined
|
|
1578
|
+
assertParamExists('updateCustomer', 'project', project)
|
|
1579
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1580
|
+
assertParamExists('updateCustomer', 'platformId', platformId)
|
|
1581
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1582
|
+
assertParamExists('updateCustomer', 'customerId', customerId)
|
|
1583
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
1584
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1585
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1586
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1587
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1588
|
+
let baseOptions;
|
|
1589
|
+
if (configuration) {
|
|
1590
|
+
baseOptions = configuration.baseOptions;
|
|
1591
|
+
}
|
|
1592
|
+
|
|
1593
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
1594
|
+
const localVarHeaderParameter = {} as any;
|
|
1595
|
+
const localVarQueryParameter = {} as any;
|
|
1596
|
+
|
|
1597
|
+
// authentication session-oauth required
|
|
1598
|
+
// oauth required
|
|
1599
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1600
|
+
|
|
1601
|
+
// authentication api-key required
|
|
1602
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1603
|
+
|
|
1604
|
+
if (project !== undefined) {
|
|
1605
|
+
localVarQueryParameter['project'] = project;
|
|
1606
|
+
}
|
|
1607
|
+
|
|
1608
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1609
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1610
|
+
|
|
1611
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1612
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1613
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1614
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerRequest, localVarRequestOptions, configuration)
|
|
1615
|
+
|
|
1553
1616
|
return {
|
|
1554
1617
|
url: toPathString(localVarUrlObj),
|
|
1555
1618
|
options: localVarRequestOptions,
|
|
@@ -1674,6 +1737,22 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1674
1737
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1675
1738
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1676
1739
|
},
|
|
1740
|
+
/**
|
|
1741
|
+
*
|
|
1742
|
+
* @summary Update the customer with the given customer ID
|
|
1743
|
+
* @param {string} project Project unique identifier
|
|
1744
|
+
* @param {string} platformId The platform identifier
|
|
1745
|
+
* @param {string} customerId The customer identifier
|
|
1746
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1747
|
+
* @param {*} [options] Override http request option.
|
|
1748
|
+
* @throws {RequiredError}
|
|
1749
|
+
*/
|
|
1750
|
+
async updateCustomer(project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>> {
|
|
1751
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCustomer(project, platformId, customerId, updateCustomerRequest, options);
|
|
1752
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1753
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.updateCustomer']?.[localVarOperationServerIndex]?.url;
|
|
1754
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1755
|
+
},
|
|
1677
1756
|
}
|
|
1678
1757
|
};
|
|
1679
1758
|
|
|
@@ -1733,6 +1812,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1733
1812
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
1734
1813
|
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
1735
1814
|
},
|
|
1815
|
+
/**
|
|
1816
|
+
*
|
|
1817
|
+
* @summary Update the customer with the given customer ID
|
|
1818
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1819
|
+
* @param {*} [options] Override http request option.
|
|
1820
|
+
* @throws {RequiredError}
|
|
1821
|
+
*/
|
|
1822
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
1823
|
+
return localVarFp.updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(axios, basePath));
|
|
1824
|
+
},
|
|
1736
1825
|
};
|
|
1737
1826
|
};
|
|
1738
1827
|
|
|
@@ -2011,6 +2100,28 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2011
2100
|
readonly lastPurchasedEnd?: string
|
|
2012
2101
|
}
|
|
2013
2102
|
|
|
2103
|
+
/**
|
|
2104
|
+
* Request parameters for updateCustomer operation in CustomersApi.
|
|
2105
|
+
*/
|
|
2106
|
+
export interface CustomersApiUpdateCustomerRequest {
|
|
2107
|
+
/**
|
|
2108
|
+
* Project unique identifier
|
|
2109
|
+
*/
|
|
2110
|
+
readonly project: string
|
|
2111
|
+
|
|
2112
|
+
/**
|
|
2113
|
+
* The platform identifier
|
|
2114
|
+
*/
|
|
2115
|
+
readonly platformId: string
|
|
2116
|
+
|
|
2117
|
+
/**
|
|
2118
|
+
* The customer identifier
|
|
2119
|
+
*/
|
|
2120
|
+
readonly customerId: string
|
|
2121
|
+
|
|
2122
|
+
readonly updateCustomerRequest?: UpdateCustomerRequest
|
|
2123
|
+
}
|
|
2124
|
+
|
|
2014
2125
|
/**
|
|
2015
2126
|
* CustomersApi - object-oriented interface
|
|
2016
2127
|
*/
|
|
@@ -2069,6 +2180,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
2069
2180
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2070
2181
|
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2071
2182
|
}
|
|
2183
|
+
|
|
2184
|
+
/**
|
|
2185
|
+
*
|
|
2186
|
+
* @summary Update the customer with the given customer ID
|
|
2187
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
2188
|
+
* @param {*} [options] Override http request option.
|
|
2189
|
+
* @throws {RequiredError}
|
|
2190
|
+
*/
|
|
2191
|
+
public updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig) {
|
|
2192
|
+
return CustomersApiFp(this.configuration).updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2193
|
+
}
|
|
2072
2194
|
}
|
|
2073
2195
|
|
|
2074
2196
|
export const ExportCustomersSortByEnum = {
|
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.54.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -320,6 +320,7 @@ export interface Customer {
|
|
|
320
320
|
'country': string | null;
|
|
321
321
|
'statistics': Statistics;
|
|
322
322
|
'shippingAddress'?: Address;
|
|
323
|
+
'billingAddress'?: Address;
|
|
323
324
|
/**
|
|
324
325
|
* Reference to the chat channel resource
|
|
325
326
|
*/
|
|
@@ -575,7 +576,7 @@ export interface Order {
|
|
|
575
576
|
'contactInformation': ContactInformation;
|
|
576
577
|
'paymentMethod'?: OrderPaymentMethod;
|
|
577
578
|
'shippingAddress': Address;
|
|
578
|
-
'billingAddress'
|
|
579
|
+
'billingAddress': Address;
|
|
579
580
|
/**
|
|
580
581
|
* ISO 8601 Timestamp
|
|
581
582
|
*/
|
|
@@ -994,6 +995,12 @@ export interface UpdateCustomerEnquiryRequest {
|
|
|
994
995
|
*/
|
|
995
996
|
'owner'?: string | null;
|
|
996
997
|
}
|
|
998
|
+
export interface UpdateCustomerRequest {
|
|
999
|
+
'email'?: string;
|
|
1000
|
+
'name'?: string;
|
|
1001
|
+
'billingAddress'?: Address;
|
|
1002
|
+
'shippingAddress'?: Address;
|
|
1003
|
+
}
|
|
997
1004
|
export interface UpdateFulfillmentRequest {
|
|
998
1005
|
/**
|
|
999
1006
|
* Unique object identifier
|
|
@@ -1011,6 +1018,7 @@ export declare const UpdateModerationItemRequestJudgementEnum: {
|
|
|
1011
1018
|
export type UpdateModerationItemRequestJudgementEnum = typeof UpdateModerationItemRequestJudgementEnum[keyof typeof UpdateModerationItemRequestJudgementEnum];
|
|
1012
1019
|
export interface UpdateOrderRequest {
|
|
1013
1020
|
'email'?: string;
|
|
1021
|
+
'billingAddress'?: Address;
|
|
1014
1022
|
'shippingAddress'?: Address;
|
|
1015
1023
|
'priorityLevel'?: PriorityLevel;
|
|
1016
1024
|
}
|
|
@@ -1142,6 +1150,17 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1142
1150
|
* @throws {RequiredError}
|
|
1143
1151
|
*/
|
|
1144
1152
|
listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1153
|
+
/**
|
|
1154
|
+
*
|
|
1155
|
+
* @summary Update the customer with the given customer ID
|
|
1156
|
+
* @param {string} project Project unique identifier
|
|
1157
|
+
* @param {string} platformId The platform identifier
|
|
1158
|
+
* @param {string} customerId The customer identifier
|
|
1159
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1160
|
+
* @param {*} [options] Override http request option.
|
|
1161
|
+
* @throws {RequiredError}
|
|
1162
|
+
*/
|
|
1163
|
+
updateCustomer: (project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1145
1164
|
};
|
|
1146
1165
|
/**
|
|
1147
1166
|
* CustomersApi - functional programming interface
|
|
@@ -1232,6 +1251,17 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1232
1251
|
* @throws {RequiredError}
|
|
1233
1252
|
*/
|
|
1234
1253
|
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1254
|
+
/**
|
|
1255
|
+
*
|
|
1256
|
+
* @summary Update the customer with the given customer ID
|
|
1257
|
+
* @param {string} project Project unique identifier
|
|
1258
|
+
* @param {string} platformId The platform identifier
|
|
1259
|
+
* @param {string} customerId The customer identifier
|
|
1260
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1261
|
+
* @param {*} [options] Override http request option.
|
|
1262
|
+
* @throws {RequiredError}
|
|
1263
|
+
*/
|
|
1264
|
+
updateCustomer(project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
1235
1265
|
};
|
|
1236
1266
|
/**
|
|
1237
1267
|
* CustomersApi - factory interface
|
|
@@ -1277,6 +1307,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1277
1307
|
* @throws {RequiredError}
|
|
1278
1308
|
*/
|
|
1279
1309
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1310
|
+
/**
|
|
1311
|
+
*
|
|
1312
|
+
* @summary Update the customer with the given customer ID
|
|
1313
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1314
|
+
* @param {*} [options] Override http request option.
|
|
1315
|
+
* @throws {RequiredError}
|
|
1316
|
+
*/
|
|
1317
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
1280
1318
|
};
|
|
1281
1319
|
/**
|
|
1282
1320
|
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
@@ -1503,6 +1541,24 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1503
1541
|
*/
|
|
1504
1542
|
readonly lastPurchasedEnd?: string;
|
|
1505
1543
|
}
|
|
1544
|
+
/**
|
|
1545
|
+
* Request parameters for updateCustomer operation in CustomersApi.
|
|
1546
|
+
*/
|
|
1547
|
+
export interface CustomersApiUpdateCustomerRequest {
|
|
1548
|
+
/**
|
|
1549
|
+
* Project unique identifier
|
|
1550
|
+
*/
|
|
1551
|
+
readonly project: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* The platform identifier
|
|
1554
|
+
*/
|
|
1555
|
+
readonly platformId: string;
|
|
1556
|
+
/**
|
|
1557
|
+
* The customer identifier
|
|
1558
|
+
*/
|
|
1559
|
+
readonly customerId: string;
|
|
1560
|
+
readonly updateCustomerRequest?: UpdateCustomerRequest;
|
|
1561
|
+
}
|
|
1506
1562
|
/**
|
|
1507
1563
|
* CustomersApi - object-oriented interface
|
|
1508
1564
|
*/
|
|
@@ -1547,6 +1603,14 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
1547
1603
|
* @throws {RequiredError}
|
|
1548
1604
|
*/
|
|
1549
1605
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any, {}>>;
|
|
1606
|
+
/**
|
|
1607
|
+
*
|
|
1608
|
+
* @summary Update the customer with the given customer ID
|
|
1609
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1610
|
+
* @param {*} [options] Override http request option.
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
*/
|
|
1613
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
|
|
1550
1614
|
}
|
|
1551
1615
|
export declare const ExportCustomersSortByEnum: {
|
|
1552
1616
|
readonly LifetimeValue: "+lifetimeValue";
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.54.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -463,6 +463,54 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
463
463
|
options: localVarRequestOptions,
|
|
464
464
|
};
|
|
465
465
|
}),
|
|
466
|
+
/**
|
|
467
|
+
*
|
|
468
|
+
* @summary Update the customer with the given customer ID
|
|
469
|
+
* @param {string} project Project unique identifier
|
|
470
|
+
* @param {string} platformId The platform identifier
|
|
471
|
+
* @param {string} customerId The customer identifier
|
|
472
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
473
|
+
* @param {*} [options] Override http request option.
|
|
474
|
+
* @throws {RequiredError}
|
|
475
|
+
*/
|
|
476
|
+
updateCustomer: (project_1, platformId_1, customerId_1, updateCustomerRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, updateCustomerRequest_1, ...args_1], void 0, function* (project, platformId, customerId, updateCustomerRequest, options = {}) {
|
|
477
|
+
// verify required parameter 'project' is not null or undefined
|
|
478
|
+
(0, common_1.assertParamExists)('updateCustomer', 'project', project);
|
|
479
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
480
|
+
(0, common_1.assertParamExists)('updateCustomer', 'platformId', platformId);
|
|
481
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
482
|
+
(0, common_1.assertParamExists)('updateCustomer', 'customerId', customerId);
|
|
483
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
484
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
485
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
486
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
487
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
488
|
+
let baseOptions;
|
|
489
|
+
if (configuration) {
|
|
490
|
+
baseOptions = configuration.baseOptions;
|
|
491
|
+
}
|
|
492
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
493
|
+
const localVarHeaderParameter = {};
|
|
494
|
+
const localVarQueryParameter = {};
|
|
495
|
+
// authentication session-oauth required
|
|
496
|
+
// oauth required
|
|
497
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
498
|
+
// authentication api-key required
|
|
499
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
500
|
+
if (project !== undefined) {
|
|
501
|
+
localVarQueryParameter['project'] = project;
|
|
502
|
+
}
|
|
503
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
504
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
505
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
506
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
507
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
508
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateCustomerRequest, localVarRequestOptions, configuration);
|
|
509
|
+
return {
|
|
510
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
511
|
+
options: localVarRequestOptions,
|
|
512
|
+
};
|
|
513
|
+
}),
|
|
466
514
|
};
|
|
467
515
|
};
|
|
468
516
|
exports.CustomersApiAxiosParamCreator = CustomersApiAxiosParamCreator;
|
|
@@ -597,6 +645,25 @@ const CustomersApiFp = function (configuration) {
|
|
|
597
645
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
598
646
|
});
|
|
599
647
|
},
|
|
648
|
+
/**
|
|
649
|
+
*
|
|
650
|
+
* @summary Update the customer with the given customer ID
|
|
651
|
+
* @param {string} project Project unique identifier
|
|
652
|
+
* @param {string} platformId The platform identifier
|
|
653
|
+
* @param {string} customerId The customer identifier
|
|
654
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
655
|
+
* @param {*} [options] Override http request option.
|
|
656
|
+
* @throws {RequiredError}
|
|
657
|
+
*/
|
|
658
|
+
updateCustomer(project, platformId, customerId, updateCustomerRequest, options) {
|
|
659
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
660
|
+
var _a, _b, _c;
|
|
661
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCustomer(project, platformId, customerId, updateCustomerRequest, options);
|
|
662
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
663
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.updateCustomer']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
664
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
665
|
+
});
|
|
666
|
+
},
|
|
600
667
|
};
|
|
601
668
|
};
|
|
602
669
|
exports.CustomersApiFp = CustomersApiFp;
|
|
@@ -656,6 +723,16 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
656
723
|
listCustomers(requestParameters, options) {
|
|
657
724
|
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
658
725
|
},
|
|
726
|
+
/**
|
|
727
|
+
*
|
|
728
|
+
* @summary Update the customer with the given customer ID
|
|
729
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
730
|
+
* @param {*} [options] Override http request option.
|
|
731
|
+
* @throws {RequiredError}
|
|
732
|
+
*/
|
|
733
|
+
updateCustomer(requestParameters, options) {
|
|
734
|
+
return localVarFp.updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(axios, basePath));
|
|
735
|
+
},
|
|
659
736
|
};
|
|
660
737
|
};
|
|
661
738
|
exports.CustomersApiFactory = CustomersApiFactory;
|
|
@@ -713,6 +790,16 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
713
790
|
listCustomers(requestParameters, options) {
|
|
714
791
|
return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
715
792
|
}
|
|
793
|
+
/**
|
|
794
|
+
*
|
|
795
|
+
* @summary Update the customer with the given customer ID
|
|
796
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
797
|
+
* @param {*} [options] Override http request option.
|
|
798
|
+
* @throws {RequiredError}
|
|
799
|
+
*/
|
|
800
|
+
updateCustomer(requestParameters, options) {
|
|
801
|
+
return (0, exports.CustomersApiFp)(this.configuration).updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
802
|
+
}
|
|
716
803
|
}
|
|
717
804
|
exports.CustomersApi = CustomersApi;
|
|
718
805
|
exports.ExportCustomersSortByEnum = {
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/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.54.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -320,6 +320,7 @@ export interface Customer {
|
|
|
320
320
|
'country': string | null;
|
|
321
321
|
'statistics': Statistics;
|
|
322
322
|
'shippingAddress'?: Address;
|
|
323
|
+
'billingAddress'?: Address;
|
|
323
324
|
/**
|
|
324
325
|
* Reference to the chat channel resource
|
|
325
326
|
*/
|
|
@@ -575,7 +576,7 @@ export interface Order {
|
|
|
575
576
|
'contactInformation': ContactInformation;
|
|
576
577
|
'paymentMethod'?: OrderPaymentMethod;
|
|
577
578
|
'shippingAddress': Address;
|
|
578
|
-
'billingAddress'
|
|
579
|
+
'billingAddress': Address;
|
|
579
580
|
/**
|
|
580
581
|
* ISO 8601 Timestamp
|
|
581
582
|
*/
|
|
@@ -994,6 +995,12 @@ export interface UpdateCustomerEnquiryRequest {
|
|
|
994
995
|
*/
|
|
995
996
|
'owner'?: string | null;
|
|
996
997
|
}
|
|
998
|
+
export interface UpdateCustomerRequest {
|
|
999
|
+
'email'?: string;
|
|
1000
|
+
'name'?: string;
|
|
1001
|
+
'billingAddress'?: Address;
|
|
1002
|
+
'shippingAddress'?: Address;
|
|
1003
|
+
}
|
|
997
1004
|
export interface UpdateFulfillmentRequest {
|
|
998
1005
|
/**
|
|
999
1006
|
* Unique object identifier
|
|
@@ -1011,6 +1018,7 @@ export declare const UpdateModerationItemRequestJudgementEnum: {
|
|
|
1011
1018
|
export type UpdateModerationItemRequestJudgementEnum = typeof UpdateModerationItemRequestJudgementEnum[keyof typeof UpdateModerationItemRequestJudgementEnum];
|
|
1012
1019
|
export interface UpdateOrderRequest {
|
|
1013
1020
|
'email'?: string;
|
|
1021
|
+
'billingAddress'?: Address;
|
|
1014
1022
|
'shippingAddress'?: Address;
|
|
1015
1023
|
'priorityLevel'?: PriorityLevel;
|
|
1016
1024
|
}
|
|
@@ -1142,6 +1150,17 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1142
1150
|
* @throws {RequiredError}
|
|
1143
1151
|
*/
|
|
1144
1152
|
listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1153
|
+
/**
|
|
1154
|
+
*
|
|
1155
|
+
* @summary Update the customer with the given customer ID
|
|
1156
|
+
* @param {string} project Project unique identifier
|
|
1157
|
+
* @param {string} platformId The platform identifier
|
|
1158
|
+
* @param {string} customerId The customer identifier
|
|
1159
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1160
|
+
* @param {*} [options] Override http request option.
|
|
1161
|
+
* @throws {RequiredError}
|
|
1162
|
+
*/
|
|
1163
|
+
updateCustomer: (project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1145
1164
|
};
|
|
1146
1165
|
/**
|
|
1147
1166
|
* CustomersApi - functional programming interface
|
|
@@ -1232,6 +1251,17 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1232
1251
|
* @throws {RequiredError}
|
|
1233
1252
|
*/
|
|
1234
1253
|
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1254
|
+
/**
|
|
1255
|
+
*
|
|
1256
|
+
* @summary Update the customer with the given customer ID
|
|
1257
|
+
* @param {string} project Project unique identifier
|
|
1258
|
+
* @param {string} platformId The platform identifier
|
|
1259
|
+
* @param {string} customerId The customer identifier
|
|
1260
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1261
|
+
* @param {*} [options] Override http request option.
|
|
1262
|
+
* @throws {RequiredError}
|
|
1263
|
+
*/
|
|
1264
|
+
updateCustomer(project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
1235
1265
|
};
|
|
1236
1266
|
/**
|
|
1237
1267
|
* CustomersApi - factory interface
|
|
@@ -1277,6 +1307,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1277
1307
|
* @throws {RequiredError}
|
|
1278
1308
|
*/
|
|
1279
1309
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
1310
|
+
/**
|
|
1311
|
+
*
|
|
1312
|
+
* @summary Update the customer with the given customer ID
|
|
1313
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1314
|
+
* @param {*} [options] Override http request option.
|
|
1315
|
+
* @throws {RequiredError}
|
|
1316
|
+
*/
|
|
1317
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
1280
1318
|
};
|
|
1281
1319
|
/**
|
|
1282
1320
|
* Request parameters for createCustomerChatChannel operation in CustomersApi.
|
|
@@ -1503,6 +1541,24 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1503
1541
|
*/
|
|
1504
1542
|
readonly lastPurchasedEnd?: string;
|
|
1505
1543
|
}
|
|
1544
|
+
/**
|
|
1545
|
+
* Request parameters for updateCustomer operation in CustomersApi.
|
|
1546
|
+
*/
|
|
1547
|
+
export interface CustomersApiUpdateCustomerRequest {
|
|
1548
|
+
/**
|
|
1549
|
+
* Project unique identifier
|
|
1550
|
+
*/
|
|
1551
|
+
readonly project: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* The platform identifier
|
|
1554
|
+
*/
|
|
1555
|
+
readonly platformId: string;
|
|
1556
|
+
/**
|
|
1557
|
+
* The customer identifier
|
|
1558
|
+
*/
|
|
1559
|
+
readonly customerId: string;
|
|
1560
|
+
readonly updateCustomerRequest?: UpdateCustomerRequest;
|
|
1561
|
+
}
|
|
1506
1562
|
/**
|
|
1507
1563
|
* CustomersApi - object-oriented interface
|
|
1508
1564
|
*/
|
|
@@ -1547,6 +1603,14 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
1547
1603
|
* @throws {RequiredError}
|
|
1548
1604
|
*/
|
|
1549
1605
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any, {}>>;
|
|
1606
|
+
/**
|
|
1607
|
+
*
|
|
1608
|
+
* @summary Update the customer with the given customer ID
|
|
1609
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1610
|
+
* @param {*} [options] Override http request option.
|
|
1611
|
+
* @throws {RequiredError}
|
|
1612
|
+
*/
|
|
1613
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
|
|
1550
1614
|
}
|
|
1551
1615
|
export declare const ExportCustomersSortByEnum: {
|
|
1552
1616
|
readonly LifetimeValue: "+lifetimeValue";
|
package/dist/esm/api.js
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.54.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -459,6 +459,54 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
459
459
|
options: localVarRequestOptions,
|
|
460
460
|
};
|
|
461
461
|
}),
|
|
462
|
+
/**
|
|
463
|
+
*
|
|
464
|
+
* @summary Update the customer with the given customer ID
|
|
465
|
+
* @param {string} project Project unique identifier
|
|
466
|
+
* @param {string} platformId The platform identifier
|
|
467
|
+
* @param {string} customerId The customer identifier
|
|
468
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
469
|
+
* @param {*} [options] Override http request option.
|
|
470
|
+
* @throws {RequiredError}
|
|
471
|
+
*/
|
|
472
|
+
updateCustomer: (project_1, platformId_1, customerId_1, updateCustomerRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, updateCustomerRequest_1, ...args_1], void 0, function* (project, platformId, customerId, updateCustomerRequest, options = {}) {
|
|
473
|
+
// verify required parameter 'project' is not null or undefined
|
|
474
|
+
assertParamExists('updateCustomer', 'project', project);
|
|
475
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
476
|
+
assertParamExists('updateCustomer', 'platformId', platformId);
|
|
477
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
478
|
+
assertParamExists('updateCustomer', 'customerId', customerId);
|
|
479
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
480
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
481
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
482
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
483
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
484
|
+
let baseOptions;
|
|
485
|
+
if (configuration) {
|
|
486
|
+
baseOptions = configuration.baseOptions;
|
|
487
|
+
}
|
|
488
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
489
|
+
const localVarHeaderParameter = {};
|
|
490
|
+
const localVarQueryParameter = {};
|
|
491
|
+
// authentication session-oauth required
|
|
492
|
+
// oauth required
|
|
493
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
494
|
+
// authentication api-key required
|
|
495
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
496
|
+
if (project !== undefined) {
|
|
497
|
+
localVarQueryParameter['project'] = project;
|
|
498
|
+
}
|
|
499
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
500
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
501
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
502
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
503
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
504
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerRequest, localVarRequestOptions, configuration);
|
|
505
|
+
return {
|
|
506
|
+
url: toPathString(localVarUrlObj),
|
|
507
|
+
options: localVarRequestOptions,
|
|
508
|
+
};
|
|
509
|
+
}),
|
|
462
510
|
};
|
|
463
511
|
};
|
|
464
512
|
/**
|
|
@@ -592,6 +640,25 @@ export const CustomersApiFp = function (configuration) {
|
|
|
592
640
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
593
641
|
});
|
|
594
642
|
},
|
|
643
|
+
/**
|
|
644
|
+
*
|
|
645
|
+
* @summary Update the customer with the given customer ID
|
|
646
|
+
* @param {string} project Project unique identifier
|
|
647
|
+
* @param {string} platformId The platform identifier
|
|
648
|
+
* @param {string} customerId The customer identifier
|
|
649
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
650
|
+
* @param {*} [options] Override http request option.
|
|
651
|
+
* @throws {RequiredError}
|
|
652
|
+
*/
|
|
653
|
+
updateCustomer(project, platformId, customerId, updateCustomerRequest, options) {
|
|
654
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
655
|
+
var _a, _b, _c;
|
|
656
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCustomer(project, platformId, customerId, updateCustomerRequest, options);
|
|
657
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
658
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.updateCustomer']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
659
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
660
|
+
});
|
|
661
|
+
},
|
|
595
662
|
};
|
|
596
663
|
};
|
|
597
664
|
/**
|
|
@@ -650,6 +717,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
650
717
|
listCustomers(requestParameters, options) {
|
|
651
718
|
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
652
719
|
},
|
|
720
|
+
/**
|
|
721
|
+
*
|
|
722
|
+
* @summary Update the customer with the given customer ID
|
|
723
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
724
|
+
* @param {*} [options] Override http request option.
|
|
725
|
+
* @throws {RequiredError}
|
|
726
|
+
*/
|
|
727
|
+
updateCustomer(requestParameters, options) {
|
|
728
|
+
return localVarFp.updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(axios, basePath));
|
|
729
|
+
},
|
|
653
730
|
};
|
|
654
731
|
};
|
|
655
732
|
/**
|
|
@@ -706,6 +783,16 @@ export class CustomersApi extends BaseAPI {
|
|
|
706
783
|
listCustomers(requestParameters, options) {
|
|
707
784
|
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
708
785
|
}
|
|
786
|
+
/**
|
|
787
|
+
*
|
|
788
|
+
* @summary Update the customer with the given customer ID
|
|
789
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
790
|
+
* @param {*} [options] Override http request option.
|
|
791
|
+
* @throws {RequiredError}
|
|
792
|
+
*/
|
|
793
|
+
updateCustomer(requestParameters, options) {
|
|
794
|
+
return CustomersApiFp(this.configuration).updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
795
|
+
}
|
|
709
796
|
}
|
|
710
797
|
export const ExportCustomersSortByEnum = {
|
|
711
798
|
LifetimeValue: '+lifetimeValue',
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/Customer.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**country** | **string** | | [default to undefined]
|
|
15
15
|
**statistics** | [**Statistics**](Statistics.md) | | [default to undefined]
|
|
16
16
|
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
17
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
17
18
|
**chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
@@ -30,6 +31,7 @@ const instance: Customer = {
|
|
|
30
31
|
country,
|
|
31
32
|
statistics,
|
|
32
33
|
shippingAddress,
|
|
34
|
+
billingAddress,
|
|
33
35
|
chatChannelRef,
|
|
34
36
|
};
|
|
35
37
|
```
|
package/docs/CustomersApi.md
CHANGED
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
9
9
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
10
10
|
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
11
11
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
12
|
+
|[**updateCustomer**](#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID|
|
|
12
13
|
|
|
13
14
|
# **createCustomerChatChannel**
|
|
14
15
|
> CreateOrderChatChannel200Response createCustomerChatChannel()
|
|
@@ -426,3 +427,68 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
426
427
|
|
|
427
428
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
428
429
|
|
|
430
|
+
# **updateCustomer**
|
|
431
|
+
> Customer updateCustomer()
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
### Example
|
|
435
|
+
|
|
436
|
+
```typescript
|
|
437
|
+
import {
|
|
438
|
+
CustomersApi,
|
|
439
|
+
Configuration,
|
|
440
|
+
UpdateCustomerRequest
|
|
441
|
+
} from '@teemill/platform';
|
|
442
|
+
|
|
443
|
+
const configuration = new Configuration();
|
|
444
|
+
const apiInstance = new CustomersApi(configuration);
|
|
445
|
+
|
|
446
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
447
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
448
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
449
|
+
let updateCustomerRequest: UpdateCustomerRequest; // (optional)
|
|
450
|
+
|
|
451
|
+
const { status, data } = await apiInstance.updateCustomer(
|
|
452
|
+
project,
|
|
453
|
+
platformId,
|
|
454
|
+
customerId,
|
|
455
|
+
updateCustomerRequest
|
|
456
|
+
);
|
|
457
|
+
```
|
|
458
|
+
|
|
459
|
+
### Parameters
|
|
460
|
+
|
|
461
|
+
|Name | Type | Description | Notes|
|
|
462
|
+
|------------- | ------------- | ------------- | -------------|
|
|
463
|
+
| **updateCustomerRequest** | **UpdateCustomerRequest**| | |
|
|
464
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
465
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
466
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
### Return type
|
|
470
|
+
|
|
471
|
+
**Customer**
|
|
472
|
+
|
|
473
|
+
### Authorization
|
|
474
|
+
|
|
475
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
476
|
+
|
|
477
|
+
### HTTP request headers
|
|
478
|
+
|
|
479
|
+
- **Content-Type**: application/json
|
|
480
|
+
- **Accept**: application/json
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
### HTTP response details
|
|
484
|
+
| Status code | Description | Response headers |
|
|
485
|
+
|-------------|-------------|------------------|
|
|
486
|
+
|**200** | Customer response | - |
|
|
487
|
+
|**400** | Failed validation | - |
|
|
488
|
+
|**401** | Not authorised to access this resource | - |
|
|
489
|
+
|**403** | Refuse to authorize | - |
|
|
490
|
+
|**404** | Resource not found | - |
|
|
491
|
+
|**500** | Unknown server error | - |
|
|
492
|
+
|
|
493
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
494
|
+
|
package/docs/Order.md
CHANGED
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
14
14
|
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
15
15
|
**shippingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
16
|
-
**billingAddress** | [**Address**](Address.md) | | [
|
|
16
|
+
**billingAddress** | [**Address**](Address.md) | | [default to undefined]
|
|
17
17
|
**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
18
18
|
**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
19
19
|
**merchantReference** | **string** | A custom reference to the merchant\'s order that will be displayed on the shipping label. | [optional] [default to undefined]
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UpdateCustomerRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
11
|
+
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { UpdateCustomerRequest } from '@teemill/platform';
|
|
17
|
+
|
|
18
|
+
const instance: UpdateCustomerRequest = {
|
|
19
|
+
email,
|
|
20
|
+
name,
|
|
21
|
+
billingAddress,
|
|
22
|
+
shippingAddress,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**email** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
9
10
|
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
10
11
|
**priorityLevel** | [**PriorityLevel**](PriorityLevel.md) | | [optional] [default to undefined]
|
|
11
12
|
|
|
@@ -16,6 +17,7 @@ import { UpdateOrderRequest } from '@teemill/platform';
|
|
|
16
17
|
|
|
17
18
|
const instance: UpdateOrderRequest = {
|
|
18
19
|
email,
|
|
20
|
+
billingAddress,
|
|
19
21
|
shippingAddress,
|
|
20
22
|
priorityLevel,
|
|
21
23
|
};
|
package/index.ts
CHANGED