@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/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.26.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -378,6 +378,12 @@ export interface Enquiry {
|
|
|
378
378
|
* @memberof Enquiry
|
|
379
379
|
*/
|
|
380
380
|
'chatChannelRef'?: string | null;
|
|
381
|
+
/**
|
|
382
|
+
* The unique id of the user who owns the enquiry
|
|
383
|
+
* @type {string}
|
|
384
|
+
* @memberof Enquiry
|
|
385
|
+
*/
|
|
386
|
+
'owner': string | null;
|
|
381
387
|
}
|
|
382
388
|
export declare const EnquiryStatusEnum: {
|
|
383
389
|
readonly New: "New";
|
|
@@ -874,6 +880,12 @@ export interface Order {
|
|
|
874
880
|
* @memberof Order
|
|
875
881
|
*/
|
|
876
882
|
'paymentAttempts'?: Array<PaymentAttempt>;
|
|
883
|
+
/**
|
|
884
|
+
* The integration type of the order, e.g. \"website\" or \"shopify\"
|
|
885
|
+
* @type {string}
|
|
886
|
+
* @memberof Order
|
|
887
|
+
*/
|
|
888
|
+
'integrationType'?: string;
|
|
877
889
|
}
|
|
878
890
|
/**
|
|
879
891
|
*
|
|
@@ -1529,6 +1541,12 @@ export interface Statistics {
|
|
|
1529
1541
|
* @memberof Statistics
|
|
1530
1542
|
*/
|
|
1531
1543
|
'totalOrderCount': number;
|
|
1544
|
+
/**
|
|
1545
|
+
*
|
|
1546
|
+
* @type {number}
|
|
1547
|
+
* @memberof Statistics
|
|
1548
|
+
*/
|
|
1549
|
+
'refundedOrderCount': number;
|
|
1532
1550
|
/**
|
|
1533
1551
|
*
|
|
1534
1552
|
* @type {string}
|
|
@@ -1604,6 +1622,19 @@ export interface Terms {
|
|
|
1604
1622
|
*/
|
|
1605
1623
|
'updatedAt': string;
|
|
1606
1624
|
}
|
|
1625
|
+
/**
|
|
1626
|
+
*
|
|
1627
|
+
* @export
|
|
1628
|
+
* @interface UpdateCustomerEnquiryRequest
|
|
1629
|
+
*/
|
|
1630
|
+
export interface UpdateCustomerEnquiryRequest {
|
|
1631
|
+
/**
|
|
1632
|
+
* The unique id of the user who owns the enquiry
|
|
1633
|
+
* @type {string}
|
|
1634
|
+
* @memberof UpdateCustomerEnquiryRequest
|
|
1635
|
+
*/
|
|
1636
|
+
'owner'?: string | null;
|
|
1637
|
+
}
|
|
1607
1638
|
/**
|
|
1608
1639
|
*
|
|
1609
1640
|
* @export
|
|
@@ -1714,7 +1745,10 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1714
1745
|
* @summary Export customers
|
|
1715
1746
|
* @param {string} project Project unique identifier
|
|
1716
1747
|
* @param {string} platformId The platform identifier
|
|
1748
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
1749
|
+
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1717
1750
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1751
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1718
1752
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1719
1753
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1720
1754
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -1722,7 +1756,7 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1722
1756
|
* @param {*} [options] Override http request option.
|
|
1723
1757
|
* @throws {RequiredError}
|
|
1724
1758
|
*/
|
|
1725
|
-
exportCustomers: (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1759
|
+
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<RequestArgs>;
|
|
1726
1760
|
/**
|
|
1727
1761
|
* Get a customer for a platform by a given customer ID.
|
|
1728
1762
|
* @summary Get customer
|
|
@@ -1742,14 +1776,17 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1742
1776
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1743
1777
|
* @param {string} [search] Search term to filter results
|
|
1744
1778
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1779
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
1780
|
+
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1745
1781
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1782
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1746
1783
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1747
1784
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1748
1785
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1749
1786
|
* @param {*} [options] Override http request option.
|
|
1750
1787
|
* @throws {RequiredError}
|
|
1751
1788
|
*/
|
|
1752
|
-
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<RequestArgs>;
|
|
1789
|
+
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<RequestArgs>;
|
|
1753
1790
|
};
|
|
1754
1791
|
/**
|
|
1755
1792
|
* CustomersApi - functional programming interface
|
|
@@ -1761,7 +1798,10 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1761
1798
|
* @summary Export customers
|
|
1762
1799
|
* @param {string} project Project unique identifier
|
|
1763
1800
|
* @param {string} platformId The platform identifier
|
|
1801
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
1802
|
+
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1764
1803
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1804
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1765
1805
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1766
1806
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1767
1807
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -1769,7 +1809,7 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1769
1809
|
* @param {*} [options] Override http request option.
|
|
1770
1810
|
* @throws {RequiredError}
|
|
1771
1811
|
*/
|
|
1772
|
-
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>>;
|
|
1812
|
+
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>>;
|
|
1773
1813
|
/**
|
|
1774
1814
|
* Get a customer for a platform by a given customer ID.
|
|
1775
1815
|
* @summary Get customer
|
|
@@ -1789,14 +1829,17 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1789
1829
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1790
1830
|
* @param {string} [search] Search term to filter results
|
|
1791
1831
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1832
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
1833
|
+
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1792
1834
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1835
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
1793
1836
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1794
1837
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1795
1838
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1796
1839
|
* @param {*} [options] Override http request option.
|
|
1797
1840
|
* @throws {RequiredError}
|
|
1798
1841
|
*/
|
|
1799
|
-
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>>;
|
|
1842
|
+
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>>;
|
|
1800
1843
|
};
|
|
1801
1844
|
/**
|
|
1802
1845
|
* CustomersApi - factory interface
|
|
@@ -1846,12 +1889,30 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
1846
1889
|
* @memberof CustomersApiExportCustomers
|
|
1847
1890
|
*/
|
|
1848
1891
|
readonly platformId: string;
|
|
1892
|
+
/**
|
|
1893
|
+
* Filter customers by country code
|
|
1894
|
+
* @type {Array<string>}
|
|
1895
|
+
* @memberof CustomersApiExportCustomers
|
|
1896
|
+
*/
|
|
1897
|
+
readonly countries?: Array<string>;
|
|
1898
|
+
/**
|
|
1899
|
+
* Filter customers by gender equal to the value provided
|
|
1900
|
+
* @type {'male' | 'female'}
|
|
1901
|
+
* @memberof CustomersApiExportCustomers
|
|
1902
|
+
*/
|
|
1903
|
+
readonly gender?: ExportCustomersGenderEnum;
|
|
1849
1904
|
/**
|
|
1850
1905
|
* Filter customers by total order count equal to the value provided
|
|
1851
1906
|
* @type {number}
|
|
1852
1907
|
* @memberof CustomersApiExportCustomers
|
|
1853
1908
|
*/
|
|
1854
1909
|
readonly totalOrderCount?: number;
|
|
1910
|
+
/**
|
|
1911
|
+
* Filter customers by refunded order count equal to the value provided
|
|
1912
|
+
* @type {number}
|
|
1913
|
+
* @memberof CustomersApiExportCustomers
|
|
1914
|
+
*/
|
|
1915
|
+
readonly refundedOrderCount?: number;
|
|
1855
1916
|
/**
|
|
1856
1917
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
1857
1918
|
* @type {number}
|
|
@@ -1860,7 +1921,7 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
1860
1921
|
readonly lifetimeValue?: number;
|
|
1861
1922
|
/**
|
|
1862
1923
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1863
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
1924
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
1864
1925
|
* @memberof CustomersApiExportCustomers
|
|
1865
1926
|
*/
|
|
1866
1927
|
readonly sortBy?: Array<ExportCustomersSortByEnum>;
|
|
@@ -1940,16 +2001,34 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1940
2001
|
readonly search?: string;
|
|
1941
2002
|
/**
|
|
1942
2003
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1943
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2004
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
1944
2005
|
* @memberof CustomersApiListCustomers
|
|
1945
2006
|
*/
|
|
1946
2007
|
readonly sortBy?: Array<ListCustomersSortByEnum>;
|
|
2008
|
+
/**
|
|
2009
|
+
* Filter customers by country code
|
|
2010
|
+
* @type {Array<string>}
|
|
2011
|
+
* @memberof CustomersApiListCustomers
|
|
2012
|
+
*/
|
|
2013
|
+
readonly countries?: Array<string>;
|
|
2014
|
+
/**
|
|
2015
|
+
* Filter customers by gender equal to the value provided
|
|
2016
|
+
* @type {'male' | 'female'}
|
|
2017
|
+
* @memberof CustomersApiListCustomers
|
|
2018
|
+
*/
|
|
2019
|
+
readonly gender?: ListCustomersGenderEnum;
|
|
1947
2020
|
/**
|
|
1948
2021
|
* Filter customers by total order count equal to the value provided
|
|
1949
2022
|
* @type {number}
|
|
1950
2023
|
* @memberof CustomersApiListCustomers
|
|
1951
2024
|
*/
|
|
1952
2025
|
readonly totalOrderCount?: number;
|
|
2026
|
+
/**
|
|
2027
|
+
* Filter customers by refunded order count equal to the value provided
|
|
2028
|
+
* @type {number}
|
|
2029
|
+
* @memberof CustomersApiListCustomers
|
|
2030
|
+
*/
|
|
2031
|
+
readonly refundedOrderCount?: number;
|
|
1953
2032
|
/**
|
|
1954
2033
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
1955
2034
|
* @type {number}
|
|
@@ -2004,6 +2083,14 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
2004
2083
|
*/
|
|
2005
2084
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
2006
2085
|
}
|
|
2086
|
+
/**
|
|
2087
|
+
* @export
|
|
2088
|
+
*/
|
|
2089
|
+
export declare const ExportCustomersGenderEnum: {
|
|
2090
|
+
readonly Male: "male";
|
|
2091
|
+
readonly Female: "female";
|
|
2092
|
+
};
|
|
2093
|
+
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
2007
2094
|
/**
|
|
2008
2095
|
* @export
|
|
2009
2096
|
*/
|
|
@@ -2012,6 +2099,8 @@ export declare const ExportCustomersSortByEnum: {
|
|
|
2012
2099
|
readonly LifetimeValue2: "-lifetimeValue";
|
|
2013
2100
|
readonly TotalOrderCount: "+totalOrderCount";
|
|
2014
2101
|
readonly TotalOrderCount2: "-totalOrderCount";
|
|
2102
|
+
readonly RefundedOrderCount: "+refundedOrderCount";
|
|
2103
|
+
readonly RefundedOrderCount2: "-refundedOrderCount";
|
|
2015
2104
|
readonly LastPurchased: "+lastPurchased";
|
|
2016
2105
|
readonly LastPurchased2: "-lastPurchased";
|
|
2017
2106
|
};
|
|
@@ -2024,10 +2113,20 @@ export declare const ListCustomersSortByEnum: {
|
|
|
2024
2113
|
readonly LifetimeValue2: "-lifetimeValue";
|
|
2025
2114
|
readonly TotalOrderCount: "+totalOrderCount";
|
|
2026
2115
|
readonly TotalOrderCount2: "-totalOrderCount";
|
|
2116
|
+
readonly RefundedOrderCount: "+refundedOrderCount";
|
|
2117
|
+
readonly RefundedOrderCount2: "-refundedOrderCount";
|
|
2027
2118
|
readonly LastPurchased: "+lastPurchased";
|
|
2028
2119
|
readonly LastPurchased2: "-lastPurchased";
|
|
2029
2120
|
};
|
|
2030
2121
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2122
|
+
/**
|
|
2123
|
+
* @export
|
|
2124
|
+
*/
|
|
2125
|
+
export declare const ListCustomersGenderEnum: {
|
|
2126
|
+
readonly Male: "male";
|
|
2127
|
+
readonly Female: "female";
|
|
2128
|
+
};
|
|
2129
|
+
export type ListCustomersGenderEnum = typeof ListCustomersGenderEnum[keyof typeof ListCustomersGenderEnum];
|
|
2031
2130
|
/**
|
|
2032
2131
|
* EnquiriesApi - axios parameter creator
|
|
2033
2132
|
* @export
|
|
@@ -2077,6 +2176,17 @@ export declare const EnquiriesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
2077
2176
|
* @throws {RequiredError}
|
|
2078
2177
|
*/
|
|
2079
2178
|
listCustomerEnquiryLogs: (project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2179
|
+
/**
|
|
2180
|
+
* Update a customer enquiry
|
|
2181
|
+
* @summary Update customer enquiry
|
|
2182
|
+
* @param {string} project Project unique identifier
|
|
2183
|
+
* @param {string} platformId The platform identifier
|
|
2184
|
+
* @param {string} enquiryId The enquiry identifier
|
|
2185
|
+
* @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
|
|
2186
|
+
* @param {*} [options] Override http request option.
|
|
2187
|
+
* @throws {RequiredError}
|
|
2188
|
+
*/
|
|
2189
|
+
updateCustomerEnquiry: (project: string, platformId: string, enquiryId: string, updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2080
2190
|
};
|
|
2081
2191
|
/**
|
|
2082
2192
|
* EnquiriesApi - functional programming interface
|
|
@@ -2127,6 +2237,17 @@ export declare const EnquiriesApiFp: (configuration?: Configuration) => {
|
|
|
2127
2237
|
* @throws {RequiredError}
|
|
2128
2238
|
*/
|
|
2129
2239
|
listCustomerEnquiryLogs(project: string, platformId: string, enquiryId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCustomerEnquiryLogs200Response>>;
|
|
2240
|
+
/**
|
|
2241
|
+
* Update a customer enquiry
|
|
2242
|
+
* @summary Update customer enquiry
|
|
2243
|
+
* @param {string} project Project unique identifier
|
|
2244
|
+
* @param {string} platformId The platform identifier
|
|
2245
|
+
* @param {string} enquiryId The enquiry identifier
|
|
2246
|
+
* @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
|
|
2247
|
+
* @param {*} [options] Override http request option.
|
|
2248
|
+
* @throws {RequiredError}
|
|
2249
|
+
*/
|
|
2250
|
+
updateCustomerEnquiry(project: string, platformId: string, enquiryId: string, updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Enquiry>>;
|
|
2130
2251
|
};
|
|
2131
2252
|
/**
|
|
2132
2253
|
* EnquiriesApi - factory interface
|
|
@@ -2165,6 +2286,14 @@ export declare const EnquiriesApiFactory: (configuration?: Configuration, basePa
|
|
|
2165
2286
|
* @throws {RequiredError}
|
|
2166
2287
|
*/
|
|
2167
2288
|
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListCustomerEnquiryLogs200Response>;
|
|
2289
|
+
/**
|
|
2290
|
+
* Update a customer enquiry
|
|
2291
|
+
* @summary Update customer enquiry
|
|
2292
|
+
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
2293
|
+
* @param {*} [options] Override http request option.
|
|
2294
|
+
* @throws {RequiredError}
|
|
2295
|
+
*/
|
|
2296
|
+
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): AxiosPromise<Enquiry>;
|
|
2168
2297
|
};
|
|
2169
2298
|
/**
|
|
2170
2299
|
* Request parameters for createChatChannel operation in EnquiriesApi.
|
|
@@ -2290,6 +2419,37 @@ export interface EnquiriesApiListCustomerEnquiryLogsRequest {
|
|
|
2290
2419
|
*/
|
|
2291
2420
|
readonly enquiryId: string;
|
|
2292
2421
|
}
|
|
2422
|
+
/**
|
|
2423
|
+
* Request parameters for updateCustomerEnquiry operation in EnquiriesApi.
|
|
2424
|
+
* @export
|
|
2425
|
+
* @interface EnquiriesApiUpdateCustomerEnquiryRequest
|
|
2426
|
+
*/
|
|
2427
|
+
export interface EnquiriesApiUpdateCustomerEnquiryRequest {
|
|
2428
|
+
/**
|
|
2429
|
+
* Project unique identifier
|
|
2430
|
+
* @type {string}
|
|
2431
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
2432
|
+
*/
|
|
2433
|
+
readonly project: string;
|
|
2434
|
+
/**
|
|
2435
|
+
* The platform identifier
|
|
2436
|
+
* @type {string}
|
|
2437
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
2438
|
+
*/
|
|
2439
|
+
readonly platformId: string;
|
|
2440
|
+
/**
|
|
2441
|
+
* The enquiry identifier
|
|
2442
|
+
* @type {string}
|
|
2443
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
2444
|
+
*/
|
|
2445
|
+
readonly enquiryId: string;
|
|
2446
|
+
/**
|
|
2447
|
+
* Enquiry update
|
|
2448
|
+
* @type {UpdateCustomerEnquiryRequest}
|
|
2449
|
+
* @memberof EnquiriesApiUpdateCustomerEnquiry
|
|
2450
|
+
*/
|
|
2451
|
+
readonly updateCustomerEnquiryRequest: UpdateCustomerEnquiryRequest;
|
|
2452
|
+
}
|
|
2293
2453
|
/**
|
|
2294
2454
|
* EnquiriesApi - object-oriented interface
|
|
2295
2455
|
* @export
|
|
@@ -2333,6 +2493,15 @@ export declare class EnquiriesApi extends BaseAPI {
|
|
|
2333
2493
|
* @memberof EnquiriesApi
|
|
2334
2494
|
*/
|
|
2335
2495
|
listCustomerEnquiryLogs(requestParameters: EnquiriesApiListCustomerEnquiryLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCustomerEnquiryLogs200Response, any>>;
|
|
2496
|
+
/**
|
|
2497
|
+
* Update a customer enquiry
|
|
2498
|
+
* @summary Update customer enquiry
|
|
2499
|
+
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
2500
|
+
* @param {*} [options] Override http request option.
|
|
2501
|
+
* @throws {RequiredError}
|
|
2502
|
+
* @memberof EnquiriesApi
|
|
2503
|
+
*/
|
|
2504
|
+
updateCustomerEnquiry(requestParameters: EnquiriesApiUpdateCustomerEnquiryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Enquiry, any>>;
|
|
2336
2505
|
}
|
|
2337
2506
|
/**
|
|
2338
2507
|
* OrdersApi - axios parameter creator
|
|
@@ -2371,6 +2540,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2371
2540
|
* @throws {RequiredError}
|
|
2372
2541
|
*/
|
|
2373
2542
|
getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2543
|
+
/**
|
|
2544
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2545
|
+
* @summary Get order receipt
|
|
2546
|
+
* @param {string} project Project unique identifier
|
|
2547
|
+
* @param {string} platformId The platform identifier
|
|
2548
|
+
* @param {string} orderId The order identifier
|
|
2549
|
+
* @param {*} [options] Override http request option.
|
|
2550
|
+
* @throws {RequiredError}
|
|
2551
|
+
*/
|
|
2552
|
+
getOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2374
2553
|
/**
|
|
2375
2554
|
* List available fulfillers for a given fulfillment
|
|
2376
2555
|
* @summary List available fulfillers
|
|
@@ -2406,6 +2585,16 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
2406
2585
|
* @throws {RequiredError}
|
|
2407
2586
|
*/
|
|
2408
2587
|
retryPlatformPayment: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2588
|
+
/**
|
|
2589
|
+
* 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.
|
|
2590
|
+
* @summary Send order receipt
|
|
2591
|
+
* @param {string} project Project unique identifier
|
|
2592
|
+
* @param {string} platformId The platform identifier
|
|
2593
|
+
* @param {string} orderId The order identifier
|
|
2594
|
+
* @param {*} [options] Override http request option.
|
|
2595
|
+
* @throws {RequiredError}
|
|
2596
|
+
*/
|
|
2597
|
+
sendOrderReceipt: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2409
2598
|
/**
|
|
2410
2599
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2411
2600
|
* @summary Update fulfillment
|
|
@@ -2455,6 +2644,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2455
2644
|
* @throws {RequiredError}
|
|
2456
2645
|
*/
|
|
2457
2646
|
getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2647
|
+
/**
|
|
2648
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2649
|
+
* @summary Get order receipt
|
|
2650
|
+
* @param {string} project Project unique identifier
|
|
2651
|
+
* @param {string} platformId The platform identifier
|
|
2652
|
+
* @param {string} orderId The order identifier
|
|
2653
|
+
* @param {*} [options] Override http request option.
|
|
2654
|
+
* @throws {RequiredError}
|
|
2655
|
+
*/
|
|
2656
|
+
getOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
2458
2657
|
/**
|
|
2459
2658
|
* List available fulfillers for a given fulfillment
|
|
2460
2659
|
* @summary List available fulfillers
|
|
@@ -2490,6 +2689,16 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
2490
2689
|
* @throws {RequiredError}
|
|
2491
2690
|
*/
|
|
2492
2691
|
retryPlatformPayment(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2692
|
+
/**
|
|
2693
|
+
* 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.
|
|
2694
|
+
* @summary Send order receipt
|
|
2695
|
+
* @param {string} project Project unique identifier
|
|
2696
|
+
* @param {string} platformId The platform identifier
|
|
2697
|
+
* @param {string} orderId The order identifier
|
|
2698
|
+
* @param {*} [options] Override http request option.
|
|
2699
|
+
* @throws {RequiredError}
|
|
2700
|
+
*/
|
|
2701
|
+
sendOrderReceipt(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2493
2702
|
/**
|
|
2494
2703
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2495
2704
|
* @summary Update fulfillment
|
|
@@ -2531,6 +2740,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2531
2740
|
* @throws {RequiredError}
|
|
2532
2741
|
*/
|
|
2533
2742
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2743
|
+
/**
|
|
2744
|
+
* Get an order receipt for a platform by a given order ID.
|
|
2745
|
+
* @summary Get order receipt
|
|
2746
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
2747
|
+
* @param {*} [options] Override http request option.
|
|
2748
|
+
* @throws {RequiredError}
|
|
2749
|
+
*/
|
|
2750
|
+
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
2534
2751
|
/**
|
|
2535
2752
|
* List available fulfillers for a given fulfillment
|
|
2536
2753
|
* @summary List available fulfillers
|
|
@@ -2555,6 +2772,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
2555
2772
|
* @throws {RequiredError}
|
|
2556
2773
|
*/
|
|
2557
2774
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2775
|
+
/**
|
|
2776
|
+
* 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.
|
|
2777
|
+
* @summary Send order receipt
|
|
2778
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
2779
|
+
* @param {*} [options] Override http request option.
|
|
2780
|
+
* @throws {RequiredError}
|
|
2781
|
+
*/
|
|
2782
|
+
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2558
2783
|
/**
|
|
2559
2784
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2560
2785
|
* @summary Update fulfillment
|
|
@@ -2651,6 +2876,31 @@ export interface OrdersApiGetOrderRequest {
|
|
|
2651
2876
|
*/
|
|
2652
2877
|
readonly orderId: string;
|
|
2653
2878
|
}
|
|
2879
|
+
/**
|
|
2880
|
+
* Request parameters for getOrderReceipt operation in OrdersApi.
|
|
2881
|
+
* @export
|
|
2882
|
+
* @interface OrdersApiGetOrderReceiptRequest
|
|
2883
|
+
*/
|
|
2884
|
+
export interface OrdersApiGetOrderReceiptRequest {
|
|
2885
|
+
/**
|
|
2886
|
+
* Project unique identifier
|
|
2887
|
+
* @type {string}
|
|
2888
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
2889
|
+
*/
|
|
2890
|
+
readonly project: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* The platform identifier
|
|
2893
|
+
* @type {string}
|
|
2894
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
2895
|
+
*/
|
|
2896
|
+
readonly platformId: string;
|
|
2897
|
+
/**
|
|
2898
|
+
* The order identifier
|
|
2899
|
+
* @type {string}
|
|
2900
|
+
* @memberof OrdersApiGetOrderReceipt
|
|
2901
|
+
*/
|
|
2902
|
+
readonly orderId: string;
|
|
2903
|
+
}
|
|
2654
2904
|
/**
|
|
2655
2905
|
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
2656
2906
|
* @export
|
|
@@ -2756,6 +3006,31 @@ export interface OrdersApiRetryPlatformPaymentRequest {
|
|
|
2756
3006
|
*/
|
|
2757
3007
|
readonly orderId: string;
|
|
2758
3008
|
}
|
|
3009
|
+
/**
|
|
3010
|
+
* Request parameters for sendOrderReceipt operation in OrdersApi.
|
|
3011
|
+
* @export
|
|
3012
|
+
* @interface OrdersApiSendOrderReceiptRequest
|
|
3013
|
+
*/
|
|
3014
|
+
export interface OrdersApiSendOrderReceiptRequest {
|
|
3015
|
+
/**
|
|
3016
|
+
* Project unique identifier
|
|
3017
|
+
* @type {string}
|
|
3018
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
3019
|
+
*/
|
|
3020
|
+
readonly project: string;
|
|
3021
|
+
/**
|
|
3022
|
+
* The platform identifier
|
|
3023
|
+
* @type {string}
|
|
3024
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
3025
|
+
*/
|
|
3026
|
+
readonly platformId: string;
|
|
3027
|
+
/**
|
|
3028
|
+
* The order identifier
|
|
3029
|
+
* @type {string}
|
|
3030
|
+
* @memberof OrdersApiSendOrderReceipt
|
|
3031
|
+
*/
|
|
3032
|
+
readonly orderId: string;
|
|
3033
|
+
}
|
|
2759
3034
|
/**
|
|
2760
3035
|
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
2761
3036
|
* @export
|
|
@@ -2821,6 +3096,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2821
3096
|
* @memberof OrdersApi
|
|
2822
3097
|
*/
|
|
2823
3098
|
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3099
|
+
/**
|
|
3100
|
+
* Get an order receipt for a platform by a given order ID.
|
|
3101
|
+
* @summary Get order receipt
|
|
3102
|
+
* @param {OrdersApiGetOrderReceiptRequest} requestParameters Request parameters.
|
|
3103
|
+
* @param {*} [options] Override http request option.
|
|
3104
|
+
* @throws {RequiredError}
|
|
3105
|
+
* @memberof OrdersApi
|
|
3106
|
+
*/
|
|
3107
|
+
getOrderReceipt(requestParameters: OrdersApiGetOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
|
|
2824
3108
|
/**
|
|
2825
3109
|
* List available fulfillers for a given fulfillment
|
|
2826
3110
|
* @summary List available fulfillers
|
|
@@ -2848,6 +3132,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2848
3132
|
* @memberof OrdersApi
|
|
2849
3133
|
*/
|
|
2850
3134
|
retryPlatformPayment(requestParameters: OrdersApiRetryPlatformPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3135
|
+
/**
|
|
3136
|
+
* 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.
|
|
3137
|
+
* @summary Send order receipt
|
|
3138
|
+
* @param {OrdersApiSendOrderReceiptRequest} requestParameters Request parameters.
|
|
3139
|
+
* @param {*} [options] Override http request option.
|
|
3140
|
+
* @throws {RequiredError}
|
|
3141
|
+
* @memberof OrdersApi
|
|
3142
|
+
*/
|
|
3143
|
+
sendOrderReceipt(requestParameters: OrdersApiSendOrderReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2851
3144
|
/**
|
|
2852
3145
|
* Update a fulfillment that belongs to an order placed through the platform
|
|
2853
3146
|
* @summary Update fulfillment
|