@teemill/platform 0.24.0 → 0.26.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 +267 -13
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +170 -7
- package/dist/api.js +149 -12
- 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 +170 -7
- package/dist/esm/api.js +148 -11
- 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/CustomersApi.md +22 -4
- package/docs/EnquiriesApi.md +67 -0
- package/docs/Enquiry.md +2 -0
- package/docs/Statistics.md +2 -0
- package/docs/UpdateCustomerEnquiryRequest.md +20 -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.26.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.26.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -58,6 +58,7 @@ Class | Method | HTTP request | Description
|
|
|
58
58
|
*EnquiriesApi* | [**getCustomerEnquiry**](docs/EnquiriesApi.md#getcustomerenquiry) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Get customer enquiry
|
|
59
59
|
*EnquiriesApi* | [**listCustomerEnquiries**](docs/EnquiriesApi.md#listcustomerenquiries) | **GET** /v1/platform/{platformId}/customers/enquiries | List customer enquiries
|
|
60
60
|
*EnquiriesApi* | [**listCustomerEnquiryLogs**](docs/EnquiriesApi.md#listcustomerenquirylogs) | **GET** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/logs | List customer enquiry Logs
|
|
61
|
+
*EnquiriesApi* | [**updateCustomerEnquiry**](docs/EnquiriesApi.md#updatecustomerenquiry) | **PATCH** /v1/platform/{platformId}/customers/enquiries/{enquiryId} | Update customer enquiry
|
|
61
62
|
*OrdersApi* | [**exportOrders**](docs/OrdersApi.md#exportorders) | **GET** /v1/platform/{platformId}/orders/export | Export orders
|
|
62
63
|
*OrdersApi* | [**getFulfillment**](docs/OrdersApi.md#getfulfillment) | **GET** /v1/platform/{platformId}/fulfillments/{fulfillmentId} | Get fulfillment
|
|
63
64
|
*OrdersApi* | [**getOrder**](docs/OrdersApi.md#getorder) | **GET** /v1/platform/{platformId}/orders/{orderId} | Get order
|
|
@@ -141,6 +142,7 @@ Class | Method | HTTP request | Description
|
|
|
141
142
|
- [Statistics](docs/Statistics.md)
|
|
142
143
|
- [StatusHistoryItem](docs/StatusHistoryItem.md)
|
|
143
144
|
- [Terms](docs/Terms.md)
|
|
145
|
+
- [UpdateCustomerEnquiryRequest](docs/UpdateCustomerEnquiryRequest.md)
|
|
144
146
|
- [UpdateFulfillmentRequest](docs/UpdateFulfillmentRequest.md)
|
|
145
147
|
- [UpdatePlatformRequest](docs/UpdatePlatformRequest.md)
|
|
146
148
|
- [ValidationError](docs/ValidationError.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.26.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -388,6 +388,12 @@ export interface Enquiry {
|
|
|
388
388
|
* @memberof Enquiry
|
|
389
389
|
*/
|
|
390
390
|
'chatChannelRef'?: string | null;
|
|
391
|
+
/**
|
|
392
|
+
* The unique id of the user who owns the enquiry
|
|
393
|
+
* @type {string}
|
|
394
|
+
* @memberof Enquiry
|
|
395
|
+
*/
|
|
396
|
+
'owner': string | null;
|
|
391
397
|
}
|
|
392
398
|
|
|
393
399
|
export const EnquiryStatusEnum = {
|
|
@@ -1560,6 +1566,12 @@ export interface Statistics {
|
|
|
1560
1566
|
* @memberof Statistics
|
|
1561
1567
|
*/
|
|
1562
1568
|
'totalOrderCount': number;
|
|
1569
|
+
/**
|
|
1570
|
+
*
|
|
1571
|
+
* @type {number}
|
|
1572
|
+
* @memberof Statistics
|
|
1573
|
+
*/
|
|
1574
|
+
'refundedOrderCount': number;
|
|
1563
1575
|
/**
|
|
1564
1576
|
*
|
|
1565
1577
|
* @type {string}
|
|
@@ -1637,6 +1649,19 @@ export interface Terms {
|
|
|
1637
1649
|
*/
|
|
1638
1650
|
'updatedAt': string;
|
|
1639
1651
|
}
|
|
1652
|
+
/**
|
|
1653
|
+
*
|
|
1654
|
+
* @export
|
|
1655
|
+
* @interface UpdateCustomerEnquiryRequest
|
|
1656
|
+
*/
|
|
1657
|
+
export interface UpdateCustomerEnquiryRequest {
|
|
1658
|
+
/**
|
|
1659
|
+
* The unique id of the user who owns the enquiry
|
|
1660
|
+
* @type {string}
|
|
1661
|
+
* @memberof UpdateCustomerEnquiryRequest
|
|
1662
|
+
*/
|
|
1663
|
+
'owner'?: string | null;
|
|
1664
|
+
}
|
|
1640
1665
|
/**
|
|
1641
1666
|
*
|
|
1642
1667
|
* @export
|
|
@@ -1749,7 +1774,10 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1749
1774
|
* @summary Export customers
|
|
1750
1775
|
* @param {string} project Project unique identifier
|
|
1751
1776
|
* @param {string} platformId The platform identifier
|
|
1777
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
1778
|
+
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1752
1779
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1780
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1753
1781
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1754
1782
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1755
1783
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -1757,7 +1785,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1757
1785
|
* @param {*} [options] Override http request option.
|
|
1758
1786
|
* @throws {RequiredError}
|
|
1759
1787
|
*/
|
|
1760
|
-
exportCustomers: async (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1788
|
+
exportCustomers: async (project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1761
1789
|
// verify required parameter 'project' is not null or undefined
|
|
1762
1790
|
assertParamExists('exportCustomers', 'project', project)
|
|
1763
1791
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1786,10 +1814,22 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1786
1814
|
localVarQueryParameter['project'] = project;
|
|
1787
1815
|
}
|
|
1788
1816
|
|
|
1817
|
+
if (countries) {
|
|
1818
|
+
localVarQueryParameter['countries'] = countries;
|
|
1819
|
+
}
|
|
1820
|
+
|
|
1821
|
+
if (gender !== undefined) {
|
|
1822
|
+
localVarQueryParameter['gender'] = gender;
|
|
1823
|
+
}
|
|
1824
|
+
|
|
1789
1825
|
if (totalOrderCount !== undefined) {
|
|
1790
1826
|
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
1791
1827
|
}
|
|
1792
1828
|
|
|
1829
|
+
if (refundedOrderCount !== undefined) {
|
|
1830
|
+
localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
|
|
1831
|
+
}
|
|
1832
|
+
|
|
1793
1833
|
if (lifetimeValue !== undefined) {
|
|
1794
1834
|
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
1795
1835
|
}
|
|
@@ -1880,14 +1920,17 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1880
1920
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1881
1921
|
* @param {string} [search] Search term to filter results
|
|
1882
1922
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1923
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
1924
|
+
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1883
1925
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1926
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1884
1927
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1885
1928
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1886
1929
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1887
1930
|
* @param {*} [options] Override http request option.
|
|
1888
1931
|
* @throws {RequiredError}
|
|
1889
1932
|
*/
|
|
1890
|
-
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1933
|
+
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1891
1934
|
// verify required parameter 'project' is not null or undefined
|
|
1892
1935
|
assertParamExists('listCustomers', 'project', project)
|
|
1893
1936
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1932,10 +1975,22 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1932
1975
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
1933
1976
|
}
|
|
1934
1977
|
|
|
1978
|
+
if (countries) {
|
|
1979
|
+
localVarQueryParameter['countries'] = countries;
|
|
1980
|
+
}
|
|
1981
|
+
|
|
1982
|
+
if (gender !== undefined) {
|
|
1983
|
+
localVarQueryParameter['gender'] = gender;
|
|
1984
|
+
}
|
|
1985
|
+
|
|
1935
1986
|
if (totalOrderCount !== undefined) {
|
|
1936
1987
|
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
1937
1988
|
}
|
|
1938
1989
|
|
|
1990
|
+
if (refundedOrderCount !== undefined) {
|
|
1991
|
+
localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1939
1994
|
if (lifetimeValue !== undefined) {
|
|
1940
1995
|
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
1941
1996
|
}
|
|
@@ -1976,7 +2031,10 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1976
2031
|
* @summary Export customers
|
|
1977
2032
|
* @param {string} project Project unique identifier
|
|
1978
2033
|
* @param {string} platformId The platform identifier
|
|
2034
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
2035
|
+
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1979
2036
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
2037
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1980
2038
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1981
2039
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1982
2040
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -1984,8 +2042,8 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1984
2042
|
* @param {*} [options] Override http request option.
|
|
1985
2043
|
* @throws {RequiredError}
|
|
1986
2044
|
*/
|
|
1987
|
-
async exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
1988
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2045
|
+
async exportCustomers(project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
2046
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
|
|
1989
2047
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1990
2048
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1991
2049
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2014,15 +2072,18 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2014
2072
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2015
2073
|
* @param {string} [search] Search term to filter results
|
|
2016
2074
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2075
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
2076
|
+
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2017
2077
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
2078
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
2018
2079
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
2019
2080
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2020
2081
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2021
2082
|
* @param {*} [options] Override http request option.
|
|
2022
2083
|
* @throws {RequiredError}
|
|
2023
2084
|
*/
|
|
2024
|
-
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
2025
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2085
|
+
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
2086
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2026
2087
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2027
2088
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2028
2089
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2045,7 +2106,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2045
2106
|
* @throws {RequiredError}
|
|
2046
2107
|
*/
|
|
2047
2108
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
2048
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2109
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2049
2110
|
},
|
|
2050
2111
|
/**
|
|
2051
2112
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -2065,7 +2126,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2065
2126
|
* @throws {RequiredError}
|
|
2066
2127
|
*/
|
|
2067
2128
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
2068
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2129
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2069
2130
|
},
|
|
2070
2131
|
};
|
|
2071
2132
|
};
|
|
@@ -2090,6 +2151,20 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2090
2151
|
*/
|
|
2091
2152
|
readonly platformId: string
|
|
2092
2153
|
|
|
2154
|
+
/**
|
|
2155
|
+
* Filter customers by country code
|
|
2156
|
+
* @type {Array<string>}
|
|
2157
|
+
* @memberof CustomersApiExportCustomers
|
|
2158
|
+
*/
|
|
2159
|
+
readonly countries?: Array<string>
|
|
2160
|
+
|
|
2161
|
+
/**
|
|
2162
|
+
* Filter customers by gender equal to the value provided
|
|
2163
|
+
* @type {'male' | 'female'}
|
|
2164
|
+
* @memberof CustomersApiExportCustomers
|
|
2165
|
+
*/
|
|
2166
|
+
readonly gender?: ExportCustomersGenderEnum
|
|
2167
|
+
|
|
2093
2168
|
/**
|
|
2094
2169
|
* Filter customers by total order count equal to the value provided
|
|
2095
2170
|
* @type {number}
|
|
@@ -2097,6 +2172,13 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2097
2172
|
*/
|
|
2098
2173
|
readonly totalOrderCount?: number
|
|
2099
2174
|
|
|
2175
|
+
/**
|
|
2176
|
+
* Filter customers by refunded order count equal to the value provided
|
|
2177
|
+
* @type {number}
|
|
2178
|
+
* @memberof CustomersApiExportCustomers
|
|
2179
|
+
*/
|
|
2180
|
+
readonly refundedOrderCount?: number
|
|
2181
|
+
|
|
2100
2182
|
/**
|
|
2101
2183
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2102
2184
|
* @type {number}
|
|
@@ -2106,7 +2188,7 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2106
2188
|
|
|
2107
2189
|
/**
|
|
2108
2190
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2109
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2191
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2110
2192
|
* @memberof CustomersApiExportCustomers
|
|
2111
2193
|
*/
|
|
2112
2194
|
readonly sortBy?: Array<ExportCustomersSortByEnum>
|
|
@@ -2197,11 +2279,25 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2197
2279
|
|
|
2198
2280
|
/**
|
|
2199
2281
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2200
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2282
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2201
2283
|
* @memberof CustomersApiListCustomers
|
|
2202
2284
|
*/
|
|
2203
2285
|
readonly sortBy?: Array<ListCustomersSortByEnum>
|
|
2204
2286
|
|
|
2287
|
+
/**
|
|
2288
|
+
* Filter customers by country code
|
|
2289
|
+
* @type {Array<string>}
|
|
2290
|
+
* @memberof CustomersApiListCustomers
|
|
2291
|
+
*/
|
|
2292
|
+
readonly countries?: Array<string>
|
|
2293
|
+
|
|
2294
|
+
/**
|
|
2295
|
+
* Filter customers by gender equal to the value provided
|
|
2296
|
+
* @type {'male' | 'female'}
|
|
2297
|
+
* @memberof CustomersApiListCustomers
|
|
2298
|
+
*/
|
|
2299
|
+
readonly gender?: ListCustomersGenderEnum
|
|
2300
|
+
|
|
2205
2301
|
/**
|
|
2206
2302
|
* Filter customers by total order count equal to the value provided
|
|
2207
2303
|
* @type {number}
|
|
@@ -2209,6 +2305,13 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2209
2305
|
*/
|
|
2210
2306
|
readonly totalOrderCount?: number
|
|
2211
2307
|
|
|
2308
|
+
/**
|
|
2309
|
+
* Filter customers by refunded order count equal to the value provided
|
|
2310
|
+
* @type {number}
|
|
2311
|
+
* @memberof CustomersApiListCustomers
|
|
2312
|
+
*/
|
|
2313
|
+
readonly refundedOrderCount?: number
|
|
2314
|
+
|
|
2212
2315
|
/**
|
|
2213
2316
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2214
2317
|
* @type {number}
|
|
@@ -2247,7 +2350,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
2247
2350
|
* @memberof CustomersApi
|
|
2248
2351
|
*/
|
|
2249
2352
|
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2250
|
-
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2353
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2251
2354
|
}
|
|
2252
2355
|
|
|
2253
2356
|
/**
|
|
@@ -2271,10 +2374,18 @@ export class CustomersApi extends BaseAPI {
|
|
|
2271
2374
|
* @memberof CustomersApi
|
|
2272
2375
|
*/
|
|
2273
2376
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2274
|
-
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2377
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2275
2378
|
}
|
|
2276
2379
|
}
|
|
2277
2380
|
|
|
2381
|
+
/**
|
|
2382
|
+
* @export
|
|
2383
|
+
*/
|
|
2384
|
+
export const ExportCustomersGenderEnum = {
|
|
2385
|
+
Male: 'male',
|
|
2386
|
+
Female: 'female'
|
|
2387
|
+
} as const;
|
|
2388
|
+
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
2278
2389
|
/**
|
|
2279
2390
|
* @export
|
|
2280
2391
|
*/
|
|
@@ -2283,6 +2394,8 @@ export const ExportCustomersSortByEnum = {
|
|
|
2283
2394
|
LifetimeValue2: '-lifetimeValue',
|
|
2284
2395
|
TotalOrderCount: '+totalOrderCount',
|
|
2285
2396
|
TotalOrderCount2: '-totalOrderCount',
|
|
2397
|
+
RefundedOrderCount: '+refundedOrderCount',
|
|
2398
|
+
RefundedOrderCount2: '-refundedOrderCount',
|
|
2286
2399
|
LastPurchased: '+lastPurchased',
|
|
2287
2400
|
LastPurchased2: '-lastPurchased'
|
|
2288
2401
|
} as const;
|
|
@@ -2295,10 +2408,20 @@ export const ListCustomersSortByEnum = {
|
|
|
2295
2408
|
LifetimeValue2: '-lifetimeValue',
|
|
2296
2409
|
TotalOrderCount: '+totalOrderCount',
|
|
2297
2410
|
TotalOrderCount2: '-totalOrderCount',
|
|
2411
|
+
RefundedOrderCount: '+refundedOrderCount',
|
|
2412
|
+
RefundedOrderCount2: '-refundedOrderCount',
|
|
2298
2413
|
LastPurchased: '+lastPurchased',
|
|
2299
2414
|
LastPurchased2: '-lastPurchased'
|
|
2300
2415
|
} as const;
|
|
2301
2416
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2417
|
+
/**
|
|
2418
|
+
* @export
|
|
2419
|
+
*/
|
|
2420
|
+
export const ListCustomersGenderEnum = {
|
|
2421
|
+
Male: 'male',
|
|
2422
|
+
Female: 'female'
|
|
2423
|
+
} as const;
|
|
2424
|
+
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
2302
2425
|
|
|
2303
2426
|
|
|
2304
2427
|
/**
|
|
@@ -2535,6 +2658,64 @@ export const EnquiriesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2535
2658
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2536
2659
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2537
2660
|
|
|
2661
|
+
return {
|
|
2662
|
+
url: toPathString(localVarUrlObj),
|
|
2663
|
+
options: localVarRequestOptions,
|
|
2664
|
+
};
|
|
2665
|
+
},
|
|
2666
|
+
/**
|
|
2667
|
+
* Update a customer enquiry
|
|
2668
|
+
* @summary Update customer enquiry
|
|
2669
|
+
* @param {string} project Project unique identifier
|
|
2670
|
+
* @param {string} platformId The platform identifier
|
|
2671
|
+
* @param {string} enquiryId The enquiry identifier
|
|
2672
|
+
* @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
|
|
2673
|
+
* @param {*} [options] Override http request option.
|
|
2674
|
+
* @throws {RequiredError}
|
|
2675
|
+
*/
|
|
2676
|
+
updateCustomerEnquiry: async (project: string, platformId: string, enquiryId: string, updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2677
|
+
// verify required parameter 'project' is not null or undefined
|
|
2678
|
+
assertParamExists('updateCustomerEnquiry', 'project', project)
|
|
2679
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2680
|
+
assertParamExists('updateCustomerEnquiry', 'platformId', platformId)
|
|
2681
|
+
// verify required parameter 'enquiryId' is not null or undefined
|
|
2682
|
+
assertParamExists('updateCustomerEnquiry', 'enquiryId', enquiryId)
|
|
2683
|
+
// verify required parameter 'updateCustomerEnquiryRequest' is not null or undefined
|
|
2684
|
+
assertParamExists('updateCustomerEnquiry', 'updateCustomerEnquiryRequest', updateCustomerEnquiryRequest)
|
|
2685
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}`
|
|
2686
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2687
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
2688
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2689
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2690
|
+
let baseOptions;
|
|
2691
|
+
if (configuration) {
|
|
2692
|
+
baseOptions = configuration.baseOptions;
|
|
2693
|
+
}
|
|
2694
|
+
|
|
2695
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
2696
|
+
const localVarHeaderParameter = {} as any;
|
|
2697
|
+
const localVarQueryParameter = {} as any;
|
|
2698
|
+
|
|
2699
|
+
// authentication session-oauth required
|
|
2700
|
+
// oauth required
|
|
2701
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2702
|
+
|
|
2703
|
+
// authentication api-key required
|
|
2704
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2705
|
+
|
|
2706
|
+
if (project !== undefined) {
|
|
2707
|
+
localVarQueryParameter['project'] = project;
|
|
2708
|
+
}
|
|
2709
|
+
|
|
2710
|
+
|
|
2711
|
+
|
|
2712
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2713
|
+
|
|
2714
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2715
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2716
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2717
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerEnquiryRequest, localVarRequestOptions, configuration)
|
|
2718
|
+
|
|
2538
2719
|
return {
|
|
2539
2720
|
url: toPathString(localVarUrlObj),
|
|
2540
2721
|
options: localVarRequestOptions,
|
|
@@ -2614,6 +2795,22 @@ export const EnquiriesApiFp = function(configuration?: Configuration) {
|
|
|
2614
2795
|
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.listCustomerEnquiryLogs']?.[localVarOperationServerIndex]?.url;
|
|
2615
2796
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2616
2797
|
},
|
|
2798
|
+
/**
|
|
2799
|
+
* Update a customer enquiry
|
|
2800
|
+
* @summary Update customer enquiry
|
|
2801
|
+
* @param {string} project Project unique identifier
|
|
2802
|
+
* @param {string} platformId The platform identifier
|
|
2803
|
+
* @param {string} enquiryId The enquiry identifier
|
|
2804
|
+
* @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
|
|
2805
|
+
* @param {*} [options] Override http request option.
|
|
2806
|
+
* @throws {RequiredError}
|
|
2807
|
+
*/
|
|
2808
|
+
async updateCustomerEnquiry(project: string, platformId: string, enquiryId: string, updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Enquiry>> {
|
|
2809
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCustomerEnquiry(project, platformId, enquiryId, updateCustomerEnquiryRequest, options);
|
|
2810
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2811
|
+
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.updateCustomerEnquiry']?.[localVarOperationServerIndex]?.url;
|
|
2812
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2813
|
+
},
|
|
2617
2814
|
}
|
|
2618
2815
|
};
|
|
2619
2816
|
|
|
@@ -2664,6 +2861,16 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
|
|
|
2664
2861
|
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response> {
|
|
2665
2862
|
return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2666
2863
|
},
|
|
2864
|
+
/**
|
|
2865
|
+
* Update a customer enquiry
|
|
2866
|
+
* @summary Update customer enquiry
|
|
2867
|
+
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
2868
|
+
* @param {*} [options] Override http request option.
|
|
2869
|
+
* @throws {RequiredError}
|
|
2870
|
+
*/
|
|
2871
|
+
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry> {
|
|
2872
|
+
return localVarFp.updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(axios, basePath));
|
|
2873
|
+
},
|
|
2667
2874
|
};
|
|
2668
2875
|
};
|
|
2669
2876
|
|
|
@@ -2807,6 +3014,41 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
|
2807
3014
|
readonly enquiryId: string
|
|
2808
3015
|
}
|
|
2809
3016
|
|
|
3017
|
+
/**
|
|
3018
|
+
* Request parameters for updateCustomerEnquiry operation in EnquiriesApi.
|
|
3019
|
+
* @export
|
|
3020
|
+
* @interface EnquiriesApiUpdateCustomerEnquiryRequest
|
|
3021
|
+
*/
|
|
3022
|
+
export interface EnquiriesApiUpdateCustomerEnquiryRequest {
|
|
3023
|
+
/**
|
|
3024
|
+
* Project unique identifier
|
|
3025
|
+
* @type {string}
|
|
3026
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3027
|
+
*/
|
|
3028
|
+
readonly project: string
|
|
3029
|
+
|
|
3030
|
+
/**
|
|
3031
|
+
* The platform identifier
|
|
3032
|
+
* @type {string}
|
|
3033
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3034
|
+
*/
|
|
3035
|
+
readonly platformId: string
|
|
3036
|
+
|
|
3037
|
+
/**
|
|
3038
|
+
* The enquiry identifier
|
|
3039
|
+
* @type {string}
|
|
3040
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3041
|
+
*/
|
|
3042
|
+
readonly enquiryId: string
|
|
3043
|
+
|
|
3044
|
+
/**
|
|
3045
|
+
* Enquiry update
|
|
3046
|
+
* @type {UpdateCustomerEnquiryRequest}
|
|
3047
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
3048
|
+
*/
|
|
3049
|
+
readonly updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest
|
|
3050
|
+
}
|
|
3051
|
+
|
|
2810
3052
|
/**
|
|
2811
3053
|
* EnquiriesApi - object-oriented interface
|
|
2812
3054
|
* @export
|
|
@@ -2861,6 +3103,18 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
2861
3103
|
public listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig) {
|
|
2862
3104
|
return EnquiriesApiFp(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
2863
3105
|
}
|
|
3106
|
+
|
|
3107
|
+
/**
|
|
3108
|
+
* Update a customer enquiry
|
|
3109
|
+
* @summary Update customer enquiry
|
|
3110
|
+
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
3111
|
+
* @param {*} [options] Override http request option.
|
|
3112
|
+
* @throws {RequiredError}
|
|
3113
|
+
* @memberof EnquiriesApi
|
|
3114
|
+
*/
|
|
3115
|
+
public updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig) {
|
|
3116
|
+
return EnquiriesApiFp(this.configuration).updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3117
|
+
}
|
|
2864
3118
|
}
|
|
2865
3119
|
|
|
2866
3120
|
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED