@teemill/platform 0.32.0 → 0.33.1
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 +14 -2
- package/api.ts +894 -3
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +573 -3
- package/dist/api.js +487 -2
- 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 +573 -3
- package/dist/esm/api.js +482 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AmendOrderRequestAmendmentsInner.md +2 -0
- package/docs/AmendOrderRequestAmendmentsInnerReason.md +22 -0
- package/docs/CreatePixelRequest.md +24 -0
- package/docs/CreatePixelRequestFilters.md +24 -0
- package/docs/Pixel.md +26 -0
- package/docs/PixelsApi.md +341 -0
- package/docs/PixelsResponse.md +22 -0
- package/docs/ReturnOrderRequest.md +1 -1
- package/docs/ReturnOrderRequestReturnsInner.md +28 -0
- package/docs/ReturnOrderRequestReturnsInnerReason.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.33.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -68,6 +68,10 @@ export const PaymentAttemptStatusEnum = {
|
|
|
68
68
|
Pending: 'pending',
|
|
69
69
|
Cancelled: 'cancelled'
|
|
70
70
|
};
|
|
71
|
+
export const ReturnOrderRequestReturnsInnerActionEnum = {
|
|
72
|
+
Refund: 'refund',
|
|
73
|
+
Exchange: 'exchange'
|
|
74
|
+
};
|
|
71
75
|
/**
|
|
72
76
|
* CustomersApi - axios parameter creator
|
|
73
77
|
* @export
|
|
@@ -2673,6 +2677,483 @@ export class PaymentApi extends BaseAPI {
|
|
|
2673
2677
|
return PaymentApiFp(this.configuration).getStripePaymentAccount(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
2674
2678
|
}
|
|
2675
2679
|
}
|
|
2680
|
+
/**
|
|
2681
|
+
* PixelsApi - axios parameter creator
|
|
2682
|
+
* @export
|
|
2683
|
+
*/
|
|
2684
|
+
export const PixelsApiAxiosParamCreator = function (configuration) {
|
|
2685
|
+
return {
|
|
2686
|
+
/**
|
|
2687
|
+
*
|
|
2688
|
+
* @summary Create a pixel
|
|
2689
|
+
* @param {string} project Project unique identifier
|
|
2690
|
+
* @param {string} platformId The platform identifier
|
|
2691
|
+
* @param {number} [pageToken] Page reference token
|
|
2692
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2693
|
+
* @param {string} [search] Search term to filter results
|
|
2694
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
2695
|
+
* @param {*} [options] Override http request option.
|
|
2696
|
+
* @throws {RequiredError}
|
|
2697
|
+
*/
|
|
2698
|
+
createPixel: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, createPixelRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, createPixelRequest_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, createPixelRequest, options = {}) {
|
|
2699
|
+
// verify required parameter 'project' is not null or undefined
|
|
2700
|
+
assertParamExists('createPixel', 'project', project);
|
|
2701
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2702
|
+
assertParamExists('createPixel', 'platformId', platformId);
|
|
2703
|
+
const localVarPath = `/v1/platform/{platformId}/pixels`
|
|
2704
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2705
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2706
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2707
|
+
let baseOptions;
|
|
2708
|
+
if (configuration) {
|
|
2709
|
+
baseOptions = configuration.baseOptions;
|
|
2710
|
+
}
|
|
2711
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
2712
|
+
const localVarHeaderParameter = {};
|
|
2713
|
+
const localVarQueryParameter = {};
|
|
2714
|
+
// authentication session-oauth required
|
|
2715
|
+
// oauth required
|
|
2716
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2717
|
+
// authentication api-key required
|
|
2718
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2719
|
+
if (project !== undefined) {
|
|
2720
|
+
localVarQueryParameter['project'] = project;
|
|
2721
|
+
}
|
|
2722
|
+
if (pageToken !== undefined) {
|
|
2723
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2724
|
+
}
|
|
2725
|
+
if (pageSize !== undefined) {
|
|
2726
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2727
|
+
}
|
|
2728
|
+
if (search !== undefined) {
|
|
2729
|
+
localVarQueryParameter['search'] = search;
|
|
2730
|
+
}
|
|
2731
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2732
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2733
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2734
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2735
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createPixelRequest, localVarRequestOptions, configuration);
|
|
2736
|
+
return {
|
|
2737
|
+
url: toPathString(localVarUrlObj),
|
|
2738
|
+
options: localVarRequestOptions,
|
|
2739
|
+
};
|
|
2740
|
+
}),
|
|
2741
|
+
/**
|
|
2742
|
+
* Delete a pixel
|
|
2743
|
+
* @summary Delete a pixel
|
|
2744
|
+
* @param {string} project Project unique identifier
|
|
2745
|
+
* @param {string} platformId The platform identifier
|
|
2746
|
+
* @param {string} pixelId The pixel identifier
|
|
2747
|
+
* @param {*} [options] Override http request option.
|
|
2748
|
+
* @throws {RequiredError}
|
|
2749
|
+
*/
|
|
2750
|
+
deletePixel: (project_1, platformId_1, pixelId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pixelId_1, ...args_1], void 0, function* (project, platformId, pixelId, options = {}) {
|
|
2751
|
+
// verify required parameter 'project' is not null or undefined
|
|
2752
|
+
assertParamExists('deletePixel', 'project', project);
|
|
2753
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2754
|
+
assertParamExists('deletePixel', 'platformId', platformId);
|
|
2755
|
+
// verify required parameter 'pixelId' is not null or undefined
|
|
2756
|
+
assertParamExists('deletePixel', 'pixelId', pixelId);
|
|
2757
|
+
const localVarPath = `/v1/platform/{platformId}/pixels/{pixelId}`
|
|
2758
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2759
|
+
.replace(`{${"pixelId"}}`, encodeURIComponent(String(pixelId)));
|
|
2760
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2761
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2762
|
+
let baseOptions;
|
|
2763
|
+
if (configuration) {
|
|
2764
|
+
baseOptions = configuration.baseOptions;
|
|
2765
|
+
}
|
|
2766
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
2767
|
+
const localVarHeaderParameter = {};
|
|
2768
|
+
const localVarQueryParameter = {};
|
|
2769
|
+
// authentication session-oauth required
|
|
2770
|
+
// oauth required
|
|
2771
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2772
|
+
// authentication api-key required
|
|
2773
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2774
|
+
if (project !== undefined) {
|
|
2775
|
+
localVarQueryParameter['project'] = project;
|
|
2776
|
+
}
|
|
2777
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2778
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2779
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2780
|
+
return {
|
|
2781
|
+
url: toPathString(localVarUrlObj),
|
|
2782
|
+
options: localVarRequestOptions,
|
|
2783
|
+
};
|
|
2784
|
+
}),
|
|
2785
|
+
/**
|
|
2786
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
2787
|
+
* @summary Get pixel
|
|
2788
|
+
* @param {string} project Project unique identifier
|
|
2789
|
+
* @param {string} platformId The platform identifier
|
|
2790
|
+
* @param {string} pixelId The pixel identifier
|
|
2791
|
+
* @param {*} [options] Override http request option.
|
|
2792
|
+
* @throws {RequiredError}
|
|
2793
|
+
*/
|
|
2794
|
+
getPixel: (project_1, platformId_1, pixelId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pixelId_1, ...args_1], void 0, function* (project, platformId, pixelId, options = {}) {
|
|
2795
|
+
// verify required parameter 'project' is not null or undefined
|
|
2796
|
+
assertParamExists('getPixel', 'project', project);
|
|
2797
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2798
|
+
assertParamExists('getPixel', 'platformId', platformId);
|
|
2799
|
+
// verify required parameter 'pixelId' is not null or undefined
|
|
2800
|
+
assertParamExists('getPixel', 'pixelId', pixelId);
|
|
2801
|
+
const localVarPath = `/v1/platform/{platformId}/pixels/{pixelId}`
|
|
2802
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2803
|
+
.replace(`{${"pixelId"}}`, encodeURIComponent(String(pixelId)));
|
|
2804
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2805
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2806
|
+
let baseOptions;
|
|
2807
|
+
if (configuration) {
|
|
2808
|
+
baseOptions = configuration.baseOptions;
|
|
2809
|
+
}
|
|
2810
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2811
|
+
const localVarHeaderParameter = {};
|
|
2812
|
+
const localVarQueryParameter = {};
|
|
2813
|
+
// authentication session-oauth required
|
|
2814
|
+
// oauth required
|
|
2815
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2816
|
+
// authentication api-key required
|
|
2817
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2818
|
+
if (project !== undefined) {
|
|
2819
|
+
localVarQueryParameter['project'] = project;
|
|
2820
|
+
}
|
|
2821
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2822
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2823
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2824
|
+
return {
|
|
2825
|
+
url: toPathString(localVarUrlObj),
|
|
2826
|
+
options: localVarRequestOptions,
|
|
2827
|
+
};
|
|
2828
|
+
}),
|
|
2829
|
+
/**
|
|
2830
|
+
* List pixels for a platform
|
|
2831
|
+
* @summary List pixels
|
|
2832
|
+
* @param {string} project Project unique identifier
|
|
2833
|
+
* @param {string} platformId The platform identifier
|
|
2834
|
+
* @param {number} [pageToken] Page reference token
|
|
2835
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2836
|
+
* @param {string} [search] Search term to filter results
|
|
2837
|
+
* @param {*} [options] Override http request option.
|
|
2838
|
+
* @throws {RequiredError}
|
|
2839
|
+
*/
|
|
2840
|
+
listPixels: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, options = {}) {
|
|
2841
|
+
// verify required parameter 'project' is not null or undefined
|
|
2842
|
+
assertParamExists('listPixels', 'project', project);
|
|
2843
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2844
|
+
assertParamExists('listPixels', 'platformId', platformId);
|
|
2845
|
+
const localVarPath = `/v1/platform/{platformId}/pixels`
|
|
2846
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2847
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2848
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2849
|
+
let baseOptions;
|
|
2850
|
+
if (configuration) {
|
|
2851
|
+
baseOptions = configuration.baseOptions;
|
|
2852
|
+
}
|
|
2853
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
2854
|
+
const localVarHeaderParameter = {};
|
|
2855
|
+
const localVarQueryParameter = {};
|
|
2856
|
+
// authentication session-oauth required
|
|
2857
|
+
// oauth required
|
|
2858
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2859
|
+
// authentication api-key required
|
|
2860
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2861
|
+
if (project !== undefined) {
|
|
2862
|
+
localVarQueryParameter['project'] = project;
|
|
2863
|
+
}
|
|
2864
|
+
if (pageToken !== undefined) {
|
|
2865
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2866
|
+
}
|
|
2867
|
+
if (pageSize !== undefined) {
|
|
2868
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2869
|
+
}
|
|
2870
|
+
if (search !== undefined) {
|
|
2871
|
+
localVarQueryParameter['search'] = search;
|
|
2872
|
+
}
|
|
2873
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2874
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2875
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2876
|
+
return {
|
|
2877
|
+
url: toPathString(localVarUrlObj),
|
|
2878
|
+
options: localVarRequestOptions,
|
|
2879
|
+
};
|
|
2880
|
+
}),
|
|
2881
|
+
/**
|
|
2882
|
+
* Update a pixel
|
|
2883
|
+
* @summary Update a pixel
|
|
2884
|
+
* @param {string} project Project unique identifier
|
|
2885
|
+
* @param {string} platformId The platform identifier
|
|
2886
|
+
* @param {string} pixelId The pixel identifier
|
|
2887
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
*/
|
|
2891
|
+
updatePixel: (project_1, platformId_1, pixelId_1, createPixelRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pixelId_1, createPixelRequest_1, ...args_1], void 0, function* (project, platformId, pixelId, createPixelRequest, options = {}) {
|
|
2892
|
+
// verify required parameter 'project' is not null or undefined
|
|
2893
|
+
assertParamExists('updatePixel', 'project', project);
|
|
2894
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2895
|
+
assertParamExists('updatePixel', 'platformId', platformId);
|
|
2896
|
+
// verify required parameter 'pixelId' is not null or undefined
|
|
2897
|
+
assertParamExists('updatePixel', 'pixelId', pixelId);
|
|
2898
|
+
const localVarPath = `/v1/platform/{platformId}/pixels/{pixelId}`
|
|
2899
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2900
|
+
.replace(`{${"pixelId"}}`, encodeURIComponent(String(pixelId)));
|
|
2901
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2902
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2903
|
+
let baseOptions;
|
|
2904
|
+
if (configuration) {
|
|
2905
|
+
baseOptions = configuration.baseOptions;
|
|
2906
|
+
}
|
|
2907
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
2908
|
+
const localVarHeaderParameter = {};
|
|
2909
|
+
const localVarQueryParameter = {};
|
|
2910
|
+
// authentication session-oauth required
|
|
2911
|
+
// oauth required
|
|
2912
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
2913
|
+
// authentication api-key required
|
|
2914
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
2915
|
+
if (project !== undefined) {
|
|
2916
|
+
localVarQueryParameter['project'] = project;
|
|
2917
|
+
}
|
|
2918
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2919
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2920
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2921
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
2922
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createPixelRequest, localVarRequestOptions, configuration);
|
|
2923
|
+
return {
|
|
2924
|
+
url: toPathString(localVarUrlObj),
|
|
2925
|
+
options: localVarRequestOptions,
|
|
2926
|
+
};
|
|
2927
|
+
}),
|
|
2928
|
+
};
|
|
2929
|
+
};
|
|
2930
|
+
/**
|
|
2931
|
+
* PixelsApi - functional programming interface
|
|
2932
|
+
* @export
|
|
2933
|
+
*/
|
|
2934
|
+
export const PixelsApiFp = function (configuration) {
|
|
2935
|
+
const localVarAxiosParamCreator = PixelsApiAxiosParamCreator(configuration);
|
|
2936
|
+
return {
|
|
2937
|
+
/**
|
|
2938
|
+
*
|
|
2939
|
+
* @summary Create a pixel
|
|
2940
|
+
* @param {string} project Project unique identifier
|
|
2941
|
+
* @param {string} platformId The platform identifier
|
|
2942
|
+
* @param {number} [pageToken] Page reference token
|
|
2943
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2944
|
+
* @param {string} [search] Search term to filter results
|
|
2945
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
2946
|
+
* @param {*} [options] Override http request option.
|
|
2947
|
+
* @throws {RequiredError}
|
|
2948
|
+
*/
|
|
2949
|
+
createPixel(project, platformId, pageToken, pageSize, search, createPixelRequest, options) {
|
|
2950
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2951
|
+
var _a, _b, _c;
|
|
2952
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createPixel(project, platformId, pageToken, pageSize, search, createPixelRequest, options);
|
|
2953
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2954
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PixelsApi.createPixel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2955
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2956
|
+
});
|
|
2957
|
+
},
|
|
2958
|
+
/**
|
|
2959
|
+
* Delete a pixel
|
|
2960
|
+
* @summary Delete a pixel
|
|
2961
|
+
* @param {string} project Project unique identifier
|
|
2962
|
+
* @param {string} platformId The platform identifier
|
|
2963
|
+
* @param {string} pixelId The pixel identifier
|
|
2964
|
+
* @param {*} [options] Override http request option.
|
|
2965
|
+
* @throws {RequiredError}
|
|
2966
|
+
*/
|
|
2967
|
+
deletePixel(project, platformId, pixelId, options) {
|
|
2968
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2969
|
+
var _a, _b, _c;
|
|
2970
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deletePixel(project, platformId, pixelId, options);
|
|
2971
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2972
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PixelsApi.deletePixel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2973
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2974
|
+
});
|
|
2975
|
+
},
|
|
2976
|
+
/**
|
|
2977
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
2978
|
+
* @summary Get pixel
|
|
2979
|
+
* @param {string} project Project unique identifier
|
|
2980
|
+
* @param {string} platformId The platform identifier
|
|
2981
|
+
* @param {string} pixelId The pixel identifier
|
|
2982
|
+
* @param {*} [options] Override http request option.
|
|
2983
|
+
* @throws {RequiredError}
|
|
2984
|
+
*/
|
|
2985
|
+
getPixel(project, platformId, pixelId, options) {
|
|
2986
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
2987
|
+
var _a, _b, _c;
|
|
2988
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getPixel(project, platformId, pixelId, options);
|
|
2989
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
2990
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PixelsApi.getPixel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
2991
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2992
|
+
});
|
|
2993
|
+
},
|
|
2994
|
+
/**
|
|
2995
|
+
* List pixels for a platform
|
|
2996
|
+
* @summary List pixels
|
|
2997
|
+
* @param {string} project Project unique identifier
|
|
2998
|
+
* @param {string} platformId The platform identifier
|
|
2999
|
+
* @param {number} [pageToken] Page reference token
|
|
3000
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3001
|
+
* @param {string} [search] Search term to filter results
|
|
3002
|
+
* @param {*} [options] Override http request option.
|
|
3003
|
+
* @throws {RequiredError}
|
|
3004
|
+
*/
|
|
3005
|
+
listPixels(project, platformId, pageToken, pageSize, search, options) {
|
|
3006
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3007
|
+
var _a, _b, _c;
|
|
3008
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listPixels(project, platformId, pageToken, pageSize, search, options);
|
|
3009
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3010
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PixelsApi.listPixels']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3011
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3012
|
+
});
|
|
3013
|
+
},
|
|
3014
|
+
/**
|
|
3015
|
+
* Update a pixel
|
|
3016
|
+
* @summary Update a pixel
|
|
3017
|
+
* @param {string} project Project unique identifier
|
|
3018
|
+
* @param {string} platformId The platform identifier
|
|
3019
|
+
* @param {string} pixelId The pixel identifier
|
|
3020
|
+
* @param {CreatePixelRequest} [createPixelRequest]
|
|
3021
|
+
* @param {*} [options] Override http request option.
|
|
3022
|
+
* @throws {RequiredError}
|
|
3023
|
+
*/
|
|
3024
|
+
updatePixel(project, platformId, pixelId, createPixelRequest, options) {
|
|
3025
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
3026
|
+
var _a, _b, _c;
|
|
3027
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updatePixel(project, platformId, pixelId, createPixelRequest, options);
|
|
3028
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
3029
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['PixelsApi.updatePixel']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
3030
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3031
|
+
});
|
|
3032
|
+
},
|
|
3033
|
+
};
|
|
3034
|
+
};
|
|
3035
|
+
/**
|
|
3036
|
+
* PixelsApi - factory interface
|
|
3037
|
+
* @export
|
|
3038
|
+
*/
|
|
3039
|
+
export const PixelsApiFactory = function (configuration, basePath, axios) {
|
|
3040
|
+
const localVarFp = PixelsApiFp(configuration);
|
|
3041
|
+
return {
|
|
3042
|
+
/**
|
|
3043
|
+
*
|
|
3044
|
+
* @summary Create a pixel
|
|
3045
|
+
* @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
|
|
3046
|
+
* @param {*} [options] Override http request option.
|
|
3047
|
+
* @throws {RequiredError}
|
|
3048
|
+
*/
|
|
3049
|
+
createPixel(requestParameters, options) {
|
|
3050
|
+
return localVarFp.createPixel(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createPixelRequest, options).then((request) => request(axios, basePath));
|
|
3051
|
+
},
|
|
3052
|
+
/**
|
|
3053
|
+
* Delete a pixel
|
|
3054
|
+
* @summary Delete a pixel
|
|
3055
|
+
* @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
|
|
3056
|
+
* @param {*} [options] Override http request option.
|
|
3057
|
+
* @throws {RequiredError}
|
|
3058
|
+
*/
|
|
3059
|
+
deletePixel(requestParameters, options) {
|
|
3060
|
+
return localVarFp.deletePixel(requestParameters.project, requestParameters.platformId, requestParameters.pixelId, options).then((request) => request(axios, basePath));
|
|
3061
|
+
},
|
|
3062
|
+
/**
|
|
3063
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
3064
|
+
* @summary Get pixel
|
|
3065
|
+
* @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
|
|
3066
|
+
* @param {*} [options] Override http request option.
|
|
3067
|
+
* @throws {RequiredError}
|
|
3068
|
+
*/
|
|
3069
|
+
getPixel(requestParameters, options) {
|
|
3070
|
+
return localVarFp.getPixel(requestParameters.project, requestParameters.platformId, requestParameters.pixelId, options).then((request) => request(axios, basePath));
|
|
3071
|
+
},
|
|
3072
|
+
/**
|
|
3073
|
+
* List pixels for a platform
|
|
3074
|
+
* @summary List pixels
|
|
3075
|
+
* @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
|
|
3076
|
+
* @param {*} [options] Override http request option.
|
|
3077
|
+
* @throws {RequiredError}
|
|
3078
|
+
*/
|
|
3079
|
+
listPixels(requestParameters, options) {
|
|
3080
|
+
return localVarFp.listPixels(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
3081
|
+
},
|
|
3082
|
+
/**
|
|
3083
|
+
* Update a pixel
|
|
3084
|
+
* @summary Update a pixel
|
|
3085
|
+
* @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
|
|
3086
|
+
* @param {*} [options] Override http request option.
|
|
3087
|
+
* @throws {RequiredError}
|
|
3088
|
+
*/
|
|
3089
|
+
updatePixel(requestParameters, options) {
|
|
3090
|
+
return localVarFp.updatePixel(requestParameters.project, requestParameters.platformId, requestParameters.pixelId, requestParameters.createPixelRequest, options).then((request) => request(axios, basePath));
|
|
3091
|
+
},
|
|
3092
|
+
};
|
|
3093
|
+
};
|
|
3094
|
+
/**
|
|
3095
|
+
* PixelsApi - object-oriented interface
|
|
3096
|
+
* @export
|
|
3097
|
+
* @class PixelsApi
|
|
3098
|
+
* @extends {BaseAPI}
|
|
3099
|
+
*/
|
|
3100
|
+
export class PixelsApi extends BaseAPI {
|
|
3101
|
+
/**
|
|
3102
|
+
*
|
|
3103
|
+
* @summary Create a pixel
|
|
3104
|
+
* @param {PixelsApiCreatePixelRequest} requestParameters Request parameters.
|
|
3105
|
+
* @param {*} [options] Override http request option.
|
|
3106
|
+
* @throws {RequiredError}
|
|
3107
|
+
* @memberof PixelsApi
|
|
3108
|
+
*/
|
|
3109
|
+
createPixel(requestParameters, options) {
|
|
3110
|
+
return PixelsApiFp(this.configuration).createPixel(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.createPixelRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3111
|
+
}
|
|
3112
|
+
/**
|
|
3113
|
+
* Delete a pixel
|
|
3114
|
+
* @summary Delete a pixel
|
|
3115
|
+
* @param {PixelsApiDeletePixelRequest} requestParameters Request parameters.
|
|
3116
|
+
* @param {*} [options] Override http request option.
|
|
3117
|
+
* @throws {RequiredError}
|
|
3118
|
+
* @memberof PixelsApi
|
|
3119
|
+
*/
|
|
3120
|
+
deletePixel(requestParameters, options) {
|
|
3121
|
+
return PixelsApiFp(this.configuration).deletePixel(requestParameters.project, requestParameters.platformId, requestParameters.pixelId, options).then((request) => request(this.axios, this.basePath));
|
|
3122
|
+
}
|
|
3123
|
+
/**
|
|
3124
|
+
* Get a pixel for a platform by a given pixel ID.
|
|
3125
|
+
* @summary Get pixel
|
|
3126
|
+
* @param {PixelsApiGetPixelRequest} requestParameters Request parameters.
|
|
3127
|
+
* @param {*} [options] Override http request option.
|
|
3128
|
+
* @throws {RequiredError}
|
|
3129
|
+
* @memberof PixelsApi
|
|
3130
|
+
*/
|
|
3131
|
+
getPixel(requestParameters, options) {
|
|
3132
|
+
return PixelsApiFp(this.configuration).getPixel(requestParameters.project, requestParameters.platformId, requestParameters.pixelId, options).then((request) => request(this.axios, this.basePath));
|
|
3133
|
+
}
|
|
3134
|
+
/**
|
|
3135
|
+
* List pixels for a platform
|
|
3136
|
+
* @summary List pixels
|
|
3137
|
+
* @param {PixelsApiListPixelsRequest} requestParameters Request parameters.
|
|
3138
|
+
* @param {*} [options] Override http request option.
|
|
3139
|
+
* @throws {RequiredError}
|
|
3140
|
+
* @memberof PixelsApi
|
|
3141
|
+
*/
|
|
3142
|
+
listPixels(requestParameters, options) {
|
|
3143
|
+
return PixelsApiFp(this.configuration).listPixels(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
3144
|
+
}
|
|
3145
|
+
/**
|
|
3146
|
+
* Update a pixel
|
|
3147
|
+
* @summary Update a pixel
|
|
3148
|
+
* @param {PixelsApiUpdatePixelRequest} requestParameters Request parameters.
|
|
3149
|
+
* @param {*} [options] Override http request option.
|
|
3150
|
+
* @throws {RequiredError}
|
|
3151
|
+
* @memberof PixelsApi
|
|
3152
|
+
*/
|
|
3153
|
+
updatePixel(requestParameters, options) {
|
|
3154
|
+
return PixelsApiFp(this.configuration).updatePixel(requestParameters.project, requestParameters.platformId, requestParameters.pixelId, requestParameters.createPixelRequest, options).then((request) => request(this.axios, this.basePath));
|
|
3155
|
+
}
|
|
3156
|
+
}
|
|
2676
3157
|
/**
|
|
2677
3158
|
* PlatformApi - axios parameter creator
|
|
2678
3159
|
* @export
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**action** | **string** | | [default to undefined]
|
|
10
10
|
**quantity** | **number** | The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order. | [default to undefined]
|
|
11
11
|
**newVariantRef** | **string** | A reference to the variant being ordered | [optional] [default to undefined]
|
|
12
|
+
**reason** | [**AmendOrderRequestAmendmentsInnerReason**](AmendOrderRequestAmendmentsInnerReason.md) | | [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,6 +21,7 @@ const instance: AmendOrderRequestAmendmentsInner = {
|
|
|
20
21
|
action,
|
|
21
22
|
quantity,
|
|
22
23
|
newVariantRef,
|
|
24
|
+
reason,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
25
27
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AmendOrderRequestAmendmentsInnerReason
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**reasonRef** | **string** | A reference to the resource location | [default to undefined]
|
|
9
|
+
**additionalComments** | **string** | Additional comments as to why the item is being returned or exchanged. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AmendOrderRequestAmendmentsInnerReason } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: AmendOrderRequestAmendmentsInnerReason = {
|
|
17
|
+
reasonRef,
|
|
18
|
+
additionalComments,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|