@teemill/platform 0.23.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 +6 -2
- package/api.ts +507 -13
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +300 -7
- package/dist/api.js +315 -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 +300 -7
- package/dist/esm/api.js +314 -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/Order.md +2 -0
- package/docs/OrdersApi.md +126 -0
- package/docs/Statistics.md +2 -0
- package/docs/UpdateCustomerEnquiryRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.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 = {
|
|
@@ -890,6 +896,12 @@ export interface Order {
|
|
|
890
896
|
* @memberof Order
|
|
891
897
|
*/
|
|
892
898
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
899
|
+
/**
|
|
900
|
+
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
901
|
+
* @type {string}
|
|
902
|
+
* @memberof Order
|
|
903
|
+
*/
|
|
904
|
+
'integrationType'?: string;
|
|
893
905
|
}
|
|
894
906
|
|
|
895
907
|
|
|
@@ -1554,6 +1566,12 @@ export interface Statistics {
|
|
|
1554
1566
|
* @memberof Statistics
|
|
1555
1567
|
*/
|
|
1556
1568
|
'totalOrderCount': number;
|
|
1569
|
+
/**
|
|
1570
|
+
*
|
|
1571
|
+
* @type {number}
|
|
1572
|
+
* @memberof Statistics
|
|
1573
|
+
*/
|
|
1574
|
+
'refundedOrderCount': number;
|
|
1557
1575
|
/**
|
|
1558
1576
|
*
|
|
1559
1577
|
* @type {string}
|
|
@@ -1631,6 +1649,19 @@ export interface Terms {
|
|
|
1631
1649
|
*/
|
|
1632
1650
|
'updatedAt': string;
|
|
1633
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
|
+
}
|
|
1634
1665
|
/**
|
|
1635
1666
|
*
|
|
1636
1667
|
* @export
|
|
@@ -1743,7 +1774,10 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1743
1774
|
* @summary Export customers
|
|
1744
1775
|
* @param {string} project Project unique identifier
|
|
1745
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
|
|
1746
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
|
|
1747
1781
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1748
1782
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1749
1783
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -1751,7 +1785,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1751
1785
|
* @param {*} [options] Override http request option.
|
|
1752
1786
|
* @throws {RequiredError}
|
|
1753
1787
|
*/
|
|
1754
|
-
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> => {
|
|
1755
1789
|
// verify required parameter 'project' is not null or undefined
|
|
1756
1790
|
assertParamExists('exportCustomers', 'project', project)
|
|
1757
1791
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1780,10 +1814,22 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1780
1814
|
localVarQueryParameter['project'] = project;
|
|
1781
1815
|
}
|
|
1782
1816
|
|
|
1817
|
+
if (countries) {
|
|
1818
|
+
localVarQueryParameter['countries'] = countries;
|
|
1819
|
+
}
|
|
1820
|
+
|
|
1821
|
+
if (gender !== undefined) {
|
|
1822
|
+
localVarQueryParameter['gender'] = gender;
|
|
1823
|
+
}
|
|
1824
|
+
|
|
1783
1825
|
if (totalOrderCount !== undefined) {
|
|
1784
1826
|
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
1785
1827
|
}
|
|
1786
1828
|
|
|
1829
|
+
if (refundedOrderCount !== undefined) {
|
|
1830
|
+
localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
|
|
1831
|
+
}
|
|
1832
|
+
|
|
1787
1833
|
if (lifetimeValue !== undefined) {
|
|
1788
1834
|
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
1789
1835
|
}
|
|
@@ -1874,14 +1920,17 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1874
1920
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1875
1921
|
* @param {string} [search] Search term to filter results
|
|
1876
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
|
|
1877
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
|
|
1878
1927
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1879
1928
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1880
1929
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1881
1930
|
* @param {*} [options] Override http request option.
|
|
1882
1931
|
* @throws {RequiredError}
|
|
1883
1932
|
*/
|
|
1884
|
-
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> => {
|
|
1885
1934
|
// verify required parameter 'project' is not null or undefined
|
|
1886
1935
|
assertParamExists('listCustomers', 'project', project)
|
|
1887
1936
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1926,10 +1975,22 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1926
1975
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
1927
1976
|
}
|
|
1928
1977
|
|
|
1978
|
+
if (countries) {
|
|
1979
|
+
localVarQueryParameter['countries'] = countries;
|
|
1980
|
+
}
|
|
1981
|
+
|
|
1982
|
+
if (gender !== undefined) {
|
|
1983
|
+
localVarQueryParameter['gender'] = gender;
|
|
1984
|
+
}
|
|
1985
|
+
|
|
1929
1986
|
if (totalOrderCount !== undefined) {
|
|
1930
1987
|
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
1931
1988
|
}
|
|
1932
1989
|
|
|
1990
|
+
if (refundedOrderCount !== undefined) {
|
|
1991
|
+
localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
|
|
1992
|
+
}
|
|
1993
|
+
|
|
1933
1994
|
if (lifetimeValue !== undefined) {
|
|
1934
1995
|
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
1935
1996
|
}
|
|
@@ -1970,7 +2031,10 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1970
2031
|
* @summary Export customers
|
|
1971
2032
|
* @param {string} project Project unique identifier
|
|
1972
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
|
|
1973
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
|
|
1974
2038
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1975
2039
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1976
2040
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -1978,8 +2042,8 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1978
2042
|
* @param {*} [options] Override http request option.
|
|
1979
2043
|
* @throws {RequiredError}
|
|
1980
2044
|
*/
|
|
1981
|
-
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>> {
|
|
1982
|
-
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);
|
|
1983
2047
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1984
2048
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1985
2049
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2008,15 +2072,18 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2008
2072
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2009
2073
|
* @param {string} [search] Search term to filter results
|
|
2010
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
|
|
2011
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
|
|
2012
2079
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
2013
2080
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2014
2081
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2015
2082
|
* @param {*} [options] Override http request option.
|
|
2016
2083
|
* @throws {RequiredError}
|
|
2017
2084
|
*/
|
|
2018
|
-
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>> {
|
|
2019
|
-
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);
|
|
2020
2087
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2021
2088
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2022
2089
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2039,7 +2106,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2039
2106
|
* @throws {RequiredError}
|
|
2040
2107
|
*/
|
|
2041
2108
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
2042
|
-
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));
|
|
2043
2110
|
},
|
|
2044
2111
|
/**
|
|
2045
2112
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -2059,7 +2126,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2059
2126
|
* @throws {RequiredError}
|
|
2060
2127
|
*/
|
|
2061
2128
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
2062
|
-
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));
|
|
2063
2130
|
},
|
|
2064
2131
|
};
|
|
2065
2132
|
};
|
|
@@ -2084,6 +2151,20 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2084
2151
|
*/
|
|
2085
2152
|
readonly platformId: string
|
|
2086
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
|
+
|
|
2087
2168
|
/**
|
|
2088
2169
|
* Filter customers by total order count equal to the value provided
|
|
2089
2170
|
* @type {number}
|
|
@@ -2091,6 +2172,13 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2091
2172
|
*/
|
|
2092
2173
|
readonly totalOrderCount?: number
|
|
2093
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
|
+
|
|
2094
2182
|
/**
|
|
2095
2183
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2096
2184
|
* @type {number}
|
|
@@ -2100,7 +2188,7 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2100
2188
|
|
|
2101
2189
|
/**
|
|
2102
2190
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2103
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2191
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2104
2192
|
* @memberof CustomersApiExportCustomers
|
|
2105
2193
|
*/
|
|
2106
2194
|
readonly sortBy?: Array<ExportCustomersSortByEnum>
|
|
@@ -2191,11 +2279,25 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2191
2279
|
|
|
2192
2280
|
/**
|
|
2193
2281
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2194
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2282
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2195
2283
|
* @memberof CustomersApiListCustomers
|
|
2196
2284
|
*/
|
|
2197
2285
|
readonly sortBy?: Array<ListCustomersSortByEnum>
|
|
2198
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
|
+
|
|
2199
2301
|
/**
|
|
2200
2302
|
* Filter customers by total order count equal to the value provided
|
|
2201
2303
|
* @type {number}
|
|
@@ -2203,6 +2305,13 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2203
2305
|
*/
|
|
2204
2306
|
readonly totalOrderCount?: number
|
|
2205
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
|
+
|
|
2206
2315
|
/**
|
|
2207
2316
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2208
2317
|
* @type {number}
|
|
@@ -2241,7 +2350,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
2241
2350
|
* @memberof CustomersApi
|
|
2242
2351
|
*/
|
|
2243
2352
|
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2244
|
-
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));
|
|
2245
2354
|
}
|
|
2246
2355
|
|
|
2247
2356
|
/**
|
|
@@ -2265,10 +2374,18 @@ export class CustomersApi extends BaseAPI {
|
|
|
2265
2374
|
* @memberof CustomersApi
|
|
2266
2375
|
*/
|
|
2267
2376
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2268
|
-
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));
|
|
2269
2378
|
}
|
|
2270
2379
|
}
|
|
2271
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];
|
|
2272
2389
|
/**
|
|
2273
2390
|
* @export
|
|
2274
2391
|
*/
|
|
@@ -2277,6 +2394,8 @@ export const ExportCustomersSortByEnum = {
|
|
|
2277
2394
|
LifetimeValue2: '-lifetimeValue',
|
|
2278
2395
|
TotalOrderCount: '+totalOrderCount',
|
|
2279
2396
|
TotalOrderCount2: '-totalOrderCount',
|
|
2397
|
+
RefundedOrderCount: '+refundedOrderCount',
|
|
2398
|
+
RefundedOrderCount2: '-refundedOrderCount',
|
|
2280
2399
|
LastPurchased: '+lastPurchased',
|
|
2281
2400
|
LastPurchased2: '-lastPurchased'
|
|
2282
2401
|
} as const;
|
|
@@ -2289,10 +2408,20 @@ export const ListCustomersSortByEnum = {
|
|
|
2289
2408
|
LifetimeValue2: '-lifetimeValue',
|
|
2290
2409
|
TotalOrderCount: '+totalOrderCount',
|
|
2291
2410
|
TotalOrderCount2: '-totalOrderCount',
|
|
2411
|
+
RefundedOrderCount: '+refundedOrderCount',
|
|
2412
|
+
RefundedOrderCount2: '-refundedOrderCount',
|
|
2292
2413
|
LastPurchased: '+lastPurchased',
|
|
2293
2414
|
LastPurchased2: '-lastPurchased'
|
|
2294
2415
|
} as const;
|
|
2295
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];
|
|
2296
2425
|
|
|
2297
2426
|
|
|
2298
2427
|
/**
|
|
@@ -2529,6 +2658,64 @@ export const EnquiriesApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2529
2658
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2530
2659
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2531
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
|
+
|
|
2532
2719
|
return {
|
|
2533
2720
|
url: toPathString(localVarUrlObj),
|
|
2534
2721
|
options: localVarRequestOptions,
|
|
@@ -2608,6 +2795,22 @@ export const EnquiriesApiFp = function(configuration?: Configuration) {
|
|
|
2608
2795
|
const localVarOperationServerBasePath = operationServerMap['EnquiriesApi.listCustomerEnquiryLogs']?.[localVarOperationServerIndex]?.url;
|
|
2609
2796
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2610
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
|
+
},
|
|
2611
2814
|
}
|
|
2612
2815
|
};
|
|
2613
2816
|
|
|
@@ -2658,6 +2861,16 @@ export const EnquiriesApiFactory = function (configuration?: Configuration, base
|
|
|
2658
2861
|
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response> {
|
|
2659
2862
|
return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
2660
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
|
+
},
|
|
2661
2874
|
};
|
|
2662
2875
|
};
|
|
2663
2876
|
|
|
@@ -2801,6 +3014,41 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
|
2801
3014
|
readonly enquiryId: string
|
|
2802
3015
|
}
|
|
2803
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
|
+
|
|
2804
3052
|
/**
|
|
2805
3053
|
* EnquiriesApi - object-oriented interface
|
|
2806
3054
|
* @export
|
|
@@ -2855,6 +3103,18 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
2855
3103
|
public listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig) {
|
|
2856
3104
|
return EnquiriesApiFp(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
2857
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
|
+
}
|
|
2858
3118
|
}
|
|
2859
3119
|
|
|
2860
3120
|
|
|
@@ -3029,6 +3289,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3029
3289
|
|
|
3030
3290
|
|
|
3031
3291
|
|
|
3292
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3293
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3294
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3295
|
+
|
|
3296
|
+
return {
|
|
3297
|
+
url: toPathString(localVarUrlObj),
|
|
3298
|
+
options: localVarRequestOptions,
|
|
3299
|
+
};
|
|
3300
|
+
},
|
|
3301
|
+
/**
|
|
3302
|
+
* Get an order receipt for a platform by a given order ID.
|
|
3303
|
+
* @summary Get order receipt
|
|
3304
|
+
* @param {string} project Project unique identifier
|
|
3305
|
+
* @param {string} platformId The platform identifier
|
|
3306
|
+
* @param {string} orderId The order identifier
|
|
3307
|
+
* @param {*} [options] Override http request option.
|
|
3308
|
+
* @throws {RequiredError}
|
|
3309
|
+
*/
|
|
3310
|
+
getOrderReceipt: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3311
|
+
// verify required parameter 'project' is not null or undefined
|
|
3312
|
+
assertParamExists('getOrderReceipt', 'project', project)
|
|
3313
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3314
|
+
assertParamExists('getOrderReceipt', 'platformId', platformId)
|
|
3315
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
3316
|
+
assertParamExists('getOrderReceipt', 'orderId', orderId)
|
|
3317
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt`
|
|
3318
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3319
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
3320
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3321
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3322
|
+
let baseOptions;
|
|
3323
|
+
if (configuration) {
|
|
3324
|
+
baseOptions = configuration.baseOptions;
|
|
3325
|
+
}
|
|
3326
|
+
|
|
3327
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3328
|
+
const localVarHeaderParameter = {} as any;
|
|
3329
|
+
const localVarQueryParameter = {} as any;
|
|
3330
|
+
|
|
3331
|
+
// authentication session-oauth required
|
|
3332
|
+
// oauth required
|
|
3333
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3334
|
+
|
|
3335
|
+
// authentication api-key required
|
|
3336
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3337
|
+
|
|
3338
|
+
if (project !== undefined) {
|
|
3339
|
+
localVarQueryParameter['project'] = project;
|
|
3340
|
+
}
|
|
3341
|
+
|
|
3342
|
+
|
|
3343
|
+
|
|
3032
3344
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3033
3345
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3034
3346
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -3215,6 +3527,58 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3215
3527
|
|
|
3216
3528
|
|
|
3217
3529
|
|
|
3530
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3531
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3532
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3533
|
+
|
|
3534
|
+
return {
|
|
3535
|
+
url: toPathString(localVarUrlObj),
|
|
3536
|
+
options: localVarRequestOptions,
|
|
3537
|
+
};
|
|
3538
|
+
},
|
|
3539
|
+
/**
|
|
3540
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
3541
|
+
* @summary Send order receipt
|
|
3542
|
+
* @param {string} project Project unique identifier
|
|
3543
|
+
* @param {string} platformId The platform identifier
|
|
3544
|
+
* @param {string} orderId The order identifier
|
|
3545
|
+
* @param {*} [options] Override http request option.
|
|
3546
|
+
* @throws {RequiredError}
|
|
3547
|
+
*/
|
|
3548
|
+
sendOrderReceipt: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3549
|
+
// verify required parameter 'project' is not null or undefined
|
|
3550
|
+
assertParamExists('sendOrderReceipt', 'project', project)
|
|
3551
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3552
|
+
assertParamExists('sendOrderReceipt', 'platformId', platformId)
|
|
3553
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
3554
|
+
assertParamExists('sendOrderReceipt', 'orderId', orderId)
|
|
3555
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/receipt/send`
|
|
3556
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3557
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
3558
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3559
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3560
|
+
let baseOptions;
|
|
3561
|
+
if (configuration) {
|
|
3562
|
+
baseOptions = configuration.baseOptions;
|
|
3563
|
+
}
|
|
3564
|
+
|
|
3565
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3566
|
+
const localVarHeaderParameter = {} as any;
|
|
3567
|
+
const localVarQueryParameter = {} as any;
|
|
3568
|
+
|
|
3569
|
+
// authentication session-oauth required
|
|
3570
|
+
// oauth required
|
|
3571
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3572
|
+
|
|
3573
|
+
// authentication api-key required
|
|
3574
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3575
|
+
|
|
3576
|
+
if (project !== undefined) {
|
|
3577
|
+
localVarQueryParameter['project'] = project;
|
|
3578
|
+
}
|
|
3579
|
+
|
|
3580
|
+
|
|
3581
|
+
|
|
3218
3582
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3219
3583
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3220
3584
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -3339,6 +3703,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3339
3703
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
3340
3704
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3341
3705
|
},
|
|
3706
|
+
/**
|
|
3707
|
+
* Get an order receipt for a platform by a given order ID.
|
|
3708
|
+
* @summary Get order receipt
|
|
3709
|
+
* @param {string} project Project unique identifier
|
|
3710
|
+
* @param {string} platformId The platform identifier
|
|
3711
|
+
* @param {string} orderId The order identifier
|
|
3712
|
+
* @param {*} [options] Override http request option.
|
|
3713
|
+
* @throws {RequiredError}
|
|
3714
|
+
*/
|
|
3715
|
+
async getOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>> {
|
|
3716
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderReceipt(project, platformId, orderId, options);
|
|
3717
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3718
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrderReceipt']?.[localVarOperationServerIndex]?.url;
|
|
3719
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3720
|
+
},
|
|
3342
3721
|
/**
|
|
3343
3722
|
* List available fulfillers for a given fulfillment
|
|
3344
3723
|
* @summary List available fulfillers
|
|
@@ -3389,6 +3768,21 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3389
3768
|
const localVarOperationServerBasePath = operationServerMap['OrdersApi.retryPlatformPayment']?.[localVarOperationServerIndex]?.url;
|
|
3390
3769
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3391
3770
|
},
|
|
3771
|
+
/**
|
|
3772
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
3773
|
+
* @summary Send order receipt
|
|
3774
|
+
* @param {string} project Project unique identifier
|
|
3775
|
+
* @param {string} platformId The platform identifier
|
|
3776
|
+
* @param {string} orderId The order identifier
|
|
3777
|
+
* @param {*} [options] Override http request option.
|
|
3778
|
+
* @throws {RequiredError}
|
|
3779
|
+
*/
|
|
3780
|
+
async sendOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
3781
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sendOrderReceipt(project, platformId, orderId, options);
|
|
3782
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3783
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.sendOrderReceipt']?.[localVarOperationServerIndex]?.url;
|
|
3784
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3785
|
+
},
|
|
3392
3786
|
/**
|
|
3393
3787
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
3394
3788
|
* @summary Update fulfillment
|
|
@@ -3445,6 +3839,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3445
3839
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
3446
3840
|
return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3447
3841
|
},
|
|
3842
|
+
/**
|
|
3843
|
+
* Get an order receipt for a platform by a given order ID.
|
|
3844
|
+
* @summary Get order receipt
|
|
3845
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
3846
|
+
* @param {*} [options] Override http request option.
|
|
3847
|
+
* @throws {RequiredError}
|
|
3848
|
+
*/
|
|
3849
|
+
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<string> {
|
|
3850
|
+
return localVarFp.getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3851
|
+
},
|
|
3448
3852
|
/**
|
|
3449
3853
|
* List available fulfillers for a given fulfillment
|
|
3450
3854
|
* @summary List available fulfillers
|
|
@@ -3475,6 +3879,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3475
3879
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
3476
3880
|
return localVarFp.retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3477
3881
|
},
|
|
3882
|
+
/**
|
|
3883
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
3884
|
+
* @summary Send order receipt
|
|
3885
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
3886
|
+
* @param {*} [options] Override http request option.
|
|
3887
|
+
* @throws {RequiredError}
|
|
3888
|
+
*/
|
|
3889
|
+
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
3890
|
+
return localVarFp.sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3891
|
+
},
|
|
3478
3892
|
/**
|
|
3479
3893
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
3480
3894
|
* @summary Update fulfillment
|
|
@@ -3586,6 +4000,34 @@ export interface OrdersApiGetOrderRequest {
|
|
|
3586
4000
|
readonly orderId: string
|
|
3587
4001
|
}
|
|
3588
4002
|
|
|
4003
|
+
/**
|
|
4004
|
+
* Request parameters for getOrderReceipt operation in OrdersApi.
|
|
4005
|
+
* @export
|
|
4006
|
+
* @interface OrdersApiGetOrderReceiptRequest
|
|
4007
|
+
*/
|
|
4008
|
+
export interface OrdersApiGetOrderReceiptRequest {
|
|
4009
|
+
/**
|
|
4010
|
+
* Project unique identifier
|
|
4011
|
+
* @type {string}
|
|
4012
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
4013
|
+
*/
|
|
4014
|
+
readonly project: string
|
|
4015
|
+
|
|
4016
|
+
/**
|
|
4017
|
+
* The platform identifier
|
|
4018
|
+
* @type {string}
|
|
4019
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
4020
|
+
*/
|
|
4021
|
+
readonly platformId: string
|
|
4022
|
+
|
|
4023
|
+
/**
|
|
4024
|
+
* The order identifier
|
|
4025
|
+
* @type {string}
|
|
4026
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
4027
|
+
*/
|
|
4028
|
+
readonly orderId: string
|
|
4029
|
+
}
|
|
4030
|
+
|
|
3589
4031
|
/**
|
|
3590
4032
|
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
3591
4033
|
* @export
|
|
@@ -3705,6 +4147,34 @@ export interface OrdersApiRetryPlatformPaymentRequest {
|
|
|
3705
4147
|
readonly orderId: string
|
|
3706
4148
|
}
|
|
3707
4149
|
|
|
4150
|
+
/**
|
|
4151
|
+
* Request parameters for sendOrderReceipt operation in OrdersApi.
|
|
4152
|
+
* @export
|
|
4153
|
+
* @interface OrdersApiSendOrderReceiptRequest
|
|
4154
|
+
*/
|
|
4155
|
+
export interface OrdersApiSendOrderReceiptRequest {
|
|
4156
|
+
/**
|
|
4157
|
+
* Project unique identifier
|
|
4158
|
+
* @type {string}
|
|
4159
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
4160
|
+
*/
|
|
4161
|
+
readonly project: string
|
|
4162
|
+
|
|
4163
|
+
/**
|
|
4164
|
+
* The platform identifier
|
|
4165
|
+
* @type {string}
|
|
4166
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
4167
|
+
*/
|
|
4168
|
+
readonly platformId: string
|
|
4169
|
+
|
|
4170
|
+
/**
|
|
4171
|
+
* The order identifier
|
|
4172
|
+
* @type {string}
|
|
4173
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
4174
|
+
*/
|
|
4175
|
+
readonly orderId: string
|
|
4176
|
+
}
|
|
4177
|
+
|
|
3708
4178
|
/**
|
|
3709
4179
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
3710
4180
|
* @export
|
|
@@ -3783,6 +4253,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
3783
4253
|
return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
3784
4254
|
}
|
|
3785
4255
|
|
|
4256
|
+
/**
|
|
4257
|
+
* Get an order receipt for a platform by a given order ID.
|
|
4258
|
+
* @summary Get order receipt
|
|
4259
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
4260
|
+
* @param {*} [options] Override http request option.
|
|
4261
|
+
* @throws {RequiredError}
|
|
4262
|
+
* @memberof OrdersApi
|
|
4263
|
+
*/
|
|
4264
|
+
public getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig) {
|
|
4265
|
+
return OrdersApiFp(this.configuration).getOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
4266
|
+
}
|
|
4267
|
+
|
|
3786
4268
|
/**
|
|
3787
4269
|
* List available fulfillers for a given fulfillment
|
|
3788
4270
|
* @summary List available fulfillers
|
|
@@ -3819,6 +4301,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
3819
4301
|
return OrdersApiFp(this.configuration).retryPlatformPayment(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
3820
4302
|
}
|
|
3821
4303
|
|
|
4304
|
+
/**
|
|
4305
|
+
* Send an order receipt to the customer. A receipt is automatically sent when an order is paid for, so this would be to resend that receipt. Note that this is only available for website orders.
|
|
4306
|
+
* @summary Send order receipt
|
|
4307
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
4308
|
+
* @param {*} [options] Override http request option.
|
|
4309
|
+
* @throws {RequiredError}
|
|
4310
|
+
* @memberof OrdersApi
|
|
4311
|
+
*/
|
|
4312
|
+
public sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig) {
|
|
4313
|
+
return OrdersApiFp(this.configuration).sendOrderReceipt(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
4314
|
+
}
|
|
4315
|
+
|
|
3822
4316
|
/**
|
|
3823
4317
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
3824
4318
|
* @summary Update fulfillment
|