@teemill/platform 0.5.0 → 0.7.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 +2 -2
- package/api.ts +1177 -69
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +657 -1
- package/dist/api.js +677 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +657 -1
- package/dist/esm/api.js +677 -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/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 Currently this API is in development and is not yet publicly accessible. All paths and models are subject to change. For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.7.0
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -148,6 +148,63 @@ export interface ExportOrders202Response {
|
|
|
148
148
|
*/
|
|
149
149
|
'message'?: string;
|
|
150
150
|
}
|
|
151
|
+
/**
|
|
152
|
+
* The fulfiller that will be processing this order.
|
|
153
|
+
* @export
|
|
154
|
+
* @interface Fulfiller
|
|
155
|
+
*/
|
|
156
|
+
export interface Fulfiller {
|
|
157
|
+
/**
|
|
158
|
+
* Unique object identifier
|
|
159
|
+
* @type {string}
|
|
160
|
+
* @memberof Fulfiller
|
|
161
|
+
*/
|
|
162
|
+
'id'?: string;
|
|
163
|
+
/**
|
|
164
|
+
*
|
|
165
|
+
* @type {FulfillerLocation}
|
|
166
|
+
* @memberof Fulfiller
|
|
167
|
+
*/
|
|
168
|
+
'location'?: FulfillerLocation;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @export
|
|
173
|
+
* @interface FulfillerLocation
|
|
174
|
+
*/
|
|
175
|
+
export interface FulfillerLocation {
|
|
176
|
+
/**
|
|
177
|
+
*
|
|
178
|
+
* @type {string}
|
|
179
|
+
* @memberof FulfillerLocation
|
|
180
|
+
*/
|
|
181
|
+
'city'?: string | null;
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @type {string}
|
|
185
|
+
* @memberof FulfillerLocation
|
|
186
|
+
*/
|
|
187
|
+
'country'?: string | null;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
*
|
|
191
|
+
* @export
|
|
192
|
+
* @interface FulfillersResponse
|
|
193
|
+
*/
|
|
194
|
+
export interface FulfillersResponse {
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @type {Array<Fulfiller>}
|
|
198
|
+
* @memberof FulfillersResponse
|
|
199
|
+
*/
|
|
200
|
+
'fulfillers'?: Array<Fulfiller>;
|
|
201
|
+
/**
|
|
202
|
+
*
|
|
203
|
+
* @type {number}
|
|
204
|
+
* @memberof FulfillersResponse
|
|
205
|
+
*/
|
|
206
|
+
'nextPageToken'?: number;
|
|
207
|
+
}
|
|
151
208
|
/**
|
|
152
209
|
*
|
|
153
210
|
* @export
|
|
@@ -166,6 +223,12 @@ export interface Fulfillment {
|
|
|
166
223
|
* @memberof Fulfillment
|
|
167
224
|
*/
|
|
168
225
|
'status'?: OrderStatus;
|
|
226
|
+
/**
|
|
227
|
+
*
|
|
228
|
+
* @type {Fulfiller}
|
|
229
|
+
* @memberof Fulfillment
|
|
230
|
+
*/
|
|
231
|
+
'fulfiller'?: Fulfiller;
|
|
169
232
|
/**
|
|
170
233
|
*
|
|
171
234
|
* @type {Array<FulfillmentItem>}
|
|
@@ -224,6 +287,56 @@ export interface FulfillmentItem {
|
|
|
224
287
|
*/
|
|
225
288
|
'quantity'?: number;
|
|
226
289
|
}
|
|
290
|
+
/**
|
|
291
|
+
* Image description
|
|
292
|
+
* @export
|
|
293
|
+
* @interface Image
|
|
294
|
+
*/
|
|
295
|
+
export interface Image {
|
|
296
|
+
/**
|
|
297
|
+
* Unique object identifier
|
|
298
|
+
* @type {string}
|
|
299
|
+
* @memberof Image
|
|
300
|
+
*/
|
|
301
|
+
'id'?: string;
|
|
302
|
+
/**
|
|
303
|
+
*
|
|
304
|
+
* @type {string}
|
|
305
|
+
* @memberof Image
|
|
306
|
+
*/
|
|
307
|
+
'src'?: string;
|
|
308
|
+
/**
|
|
309
|
+
*
|
|
310
|
+
* @type {string}
|
|
311
|
+
* @memberof Image
|
|
312
|
+
*/
|
|
313
|
+
'alt'?: string;
|
|
314
|
+
/**
|
|
315
|
+
*
|
|
316
|
+
* @type {number}
|
|
317
|
+
* @memberof Image
|
|
318
|
+
*/
|
|
319
|
+
'sortOrder'?: number;
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
*
|
|
323
|
+
* @export
|
|
324
|
+
* @interface Option
|
|
325
|
+
*/
|
|
326
|
+
export interface Option {
|
|
327
|
+
/**
|
|
328
|
+
* Option name
|
|
329
|
+
* @type {string}
|
|
330
|
+
* @memberof Option
|
|
331
|
+
*/
|
|
332
|
+
'name': string;
|
|
333
|
+
/**
|
|
334
|
+
* Option value
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof Option
|
|
337
|
+
*/
|
|
338
|
+
'value': string;
|
|
339
|
+
}
|
|
227
340
|
/**
|
|
228
341
|
*
|
|
229
342
|
* @export
|
|
@@ -353,12 +466,30 @@ export interface OrderItem {
|
|
|
353
466
|
* @memberof OrderItem
|
|
354
467
|
*/
|
|
355
468
|
'variantRef': string;
|
|
469
|
+
/**
|
|
470
|
+
* Options associated to an order item\'s variant, such as color and size.
|
|
471
|
+
* @type {Array<Option>}
|
|
472
|
+
* @memberof OrderItem
|
|
473
|
+
*/
|
|
474
|
+
'options'?: Array<Option>;
|
|
356
475
|
/**
|
|
357
476
|
*
|
|
358
477
|
* @type {number}
|
|
359
478
|
* @memberof OrderItem
|
|
360
479
|
*/
|
|
361
480
|
'quantity': number;
|
|
481
|
+
/**
|
|
482
|
+
* The name of the product
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof OrderItem
|
|
485
|
+
*/
|
|
486
|
+
'name'?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Images
|
|
489
|
+
* @type {Array<Image>}
|
|
490
|
+
* @memberof OrderItem
|
|
491
|
+
*/
|
|
492
|
+
'images'?: Array<Image>;
|
|
362
493
|
/**
|
|
363
494
|
*
|
|
364
495
|
* @type {Price}
|
|
@@ -621,6 +752,19 @@ export interface StatusHistoryItem {
|
|
|
621
752
|
}
|
|
622
753
|
|
|
623
754
|
|
|
755
|
+
/**
|
|
756
|
+
*
|
|
757
|
+
* @export
|
|
758
|
+
* @interface UpdateFulfillmentRequest
|
|
759
|
+
*/
|
|
760
|
+
export interface UpdateFulfillmentRequest {
|
|
761
|
+
/**
|
|
762
|
+
* Unique object identifier
|
|
763
|
+
* @type {string}
|
|
764
|
+
* @memberof UpdateFulfillmentRequest
|
|
765
|
+
*/
|
|
766
|
+
'fulfillerId'?: string;
|
|
767
|
+
}
|
|
624
768
|
/**
|
|
625
769
|
*
|
|
626
770
|
* @export
|
|
@@ -721,6 +865,162 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
721
865
|
|
|
722
866
|
|
|
723
867
|
|
|
868
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
869
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
870
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
871
|
+
|
|
872
|
+
return {
|
|
873
|
+
url: toPathString(localVarUrlObj),
|
|
874
|
+
options: localVarRequestOptions,
|
|
875
|
+
};
|
|
876
|
+
},
|
|
877
|
+
/**
|
|
878
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
879
|
+
* @summary Get fulfillment
|
|
880
|
+
* @param {string} project Project unique identifier
|
|
881
|
+
* @param {string} platformId The platform identifier
|
|
882
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
883
|
+
* @param {*} [options] Override http request option.
|
|
884
|
+
* @throws {RequiredError}
|
|
885
|
+
*/
|
|
886
|
+
getFulfillment: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
887
|
+
// verify required parameter 'project' is not null or undefined
|
|
888
|
+
assertParamExists('getFulfillment', 'project', project)
|
|
889
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
890
|
+
assertParamExists('getFulfillment', 'platformId', platformId)
|
|
891
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
892
|
+
assertParamExists('getFulfillment', 'fulfillmentId', fulfillmentId)
|
|
893
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
894
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
895
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
896
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
897
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
898
|
+
let baseOptions;
|
|
899
|
+
if (configuration) {
|
|
900
|
+
baseOptions = configuration.baseOptions;
|
|
901
|
+
}
|
|
902
|
+
|
|
903
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
904
|
+
const localVarHeaderParameter = {} as any;
|
|
905
|
+
const localVarQueryParameter = {} as any;
|
|
906
|
+
|
|
907
|
+
// authentication session-oauth required
|
|
908
|
+
// oauth required
|
|
909
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
910
|
+
|
|
911
|
+
// authentication api-key required
|
|
912
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
913
|
+
|
|
914
|
+
if (project !== undefined) {
|
|
915
|
+
localVarQueryParameter['project'] = project;
|
|
916
|
+
}
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
921
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
922
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
923
|
+
|
|
924
|
+
return {
|
|
925
|
+
url: toPathString(localVarUrlObj),
|
|
926
|
+
options: localVarRequestOptions,
|
|
927
|
+
};
|
|
928
|
+
},
|
|
929
|
+
/**
|
|
930
|
+
* Get an order for a platform by a given order ID.
|
|
931
|
+
* @summary Get order
|
|
932
|
+
* @param {string} project Project unique identifier
|
|
933
|
+
* @param {string} platformId The platform identifier
|
|
934
|
+
* @param {string} orderId The order identifier
|
|
935
|
+
* @param {*} [options] Override http request option.
|
|
936
|
+
* @throws {RequiredError}
|
|
937
|
+
*/
|
|
938
|
+
getOrder: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
939
|
+
// verify required parameter 'project' is not null or undefined
|
|
940
|
+
assertParamExists('getOrder', 'project', project)
|
|
941
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
942
|
+
assertParamExists('getOrder', 'platformId', platformId)
|
|
943
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
944
|
+
assertParamExists('getOrder', 'orderId', orderId)
|
|
945
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}`
|
|
946
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
947
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
948
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
949
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
950
|
+
let baseOptions;
|
|
951
|
+
if (configuration) {
|
|
952
|
+
baseOptions = configuration.baseOptions;
|
|
953
|
+
}
|
|
954
|
+
|
|
955
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
956
|
+
const localVarHeaderParameter = {} as any;
|
|
957
|
+
const localVarQueryParameter = {} as any;
|
|
958
|
+
|
|
959
|
+
// authentication session-oauth required
|
|
960
|
+
// oauth required
|
|
961
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
962
|
+
|
|
963
|
+
// authentication api-key required
|
|
964
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
965
|
+
|
|
966
|
+
if (project !== undefined) {
|
|
967
|
+
localVarQueryParameter['project'] = project;
|
|
968
|
+
}
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
973
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
974
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
975
|
+
|
|
976
|
+
return {
|
|
977
|
+
url: toPathString(localVarUrlObj),
|
|
978
|
+
options: localVarRequestOptions,
|
|
979
|
+
};
|
|
980
|
+
},
|
|
981
|
+
/**
|
|
982
|
+
* List available fulfillers for a given fulfillment
|
|
983
|
+
* @summary List available fulfillers
|
|
984
|
+
* @param {string} project Project unique identifier
|
|
985
|
+
* @param {string} platformId The platform identifier
|
|
986
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
987
|
+
* @param {*} [options] Override http request option.
|
|
988
|
+
* @throws {RequiredError}
|
|
989
|
+
*/
|
|
990
|
+
listAvailableFulfillers: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
991
|
+
// verify required parameter 'project' is not null or undefined
|
|
992
|
+
assertParamExists('listAvailableFulfillers', 'project', project)
|
|
993
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
994
|
+
assertParamExists('listAvailableFulfillers', 'platformId', platformId)
|
|
995
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
996
|
+
assertParamExists('listAvailableFulfillers', 'fulfillmentId', fulfillmentId)
|
|
997
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers`
|
|
998
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
999
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
1000
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1001
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1002
|
+
let baseOptions;
|
|
1003
|
+
if (configuration) {
|
|
1004
|
+
baseOptions = configuration.baseOptions;
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1008
|
+
const localVarHeaderParameter = {} as any;
|
|
1009
|
+
const localVarQueryParameter = {} as any;
|
|
1010
|
+
|
|
1011
|
+
// authentication session-oauth required
|
|
1012
|
+
// oauth required
|
|
1013
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1014
|
+
|
|
1015
|
+
// authentication api-key required
|
|
1016
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1017
|
+
|
|
1018
|
+
if (project !== undefined) {
|
|
1019
|
+
localVarQueryParameter['project'] = project;
|
|
1020
|
+
}
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
|
|
724
1024
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
725
1025
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
726
1026
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -807,50 +1107,169 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
807
1107
|
options: localVarRequestOptions,
|
|
808
1108
|
};
|
|
809
1109
|
},
|
|
810
|
-
}
|
|
811
|
-
};
|
|
812
|
-
|
|
813
|
-
/**
|
|
814
|
-
* OrdersApi - functional programming interface
|
|
815
|
-
* @export
|
|
816
|
-
*/
|
|
817
|
-
export const OrdersApiFp = function(configuration?: Configuration) {
|
|
818
|
-
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
|
|
819
|
-
return {
|
|
820
|
-
/**
|
|
821
|
-
* Export orders as a CSV file
|
|
822
|
-
* @summary Export orders
|
|
823
|
-
* @param {string} project Project unique identifier
|
|
824
|
-
* @param {string} platformId The platform identifier
|
|
825
|
-
* @param {string} start Start of date range to filter by when orders were placed
|
|
826
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
827
|
-
* @param {*} [options] Override http request option.
|
|
828
|
-
* @throws {RequiredError}
|
|
829
|
-
*/
|
|
830
|
-
async exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
831
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, options);
|
|
832
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
833
|
-
const localVarOperationServerBasePath = operationServerMap['OrdersApi.exportOrders']?.[localVarOperationServerIndex]?.url;
|
|
834
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
835
|
-
},
|
|
836
1110
|
/**
|
|
837
|
-
*
|
|
838
|
-
* @summary
|
|
1111
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1112
|
+
* @summary Update fulfillment
|
|
839
1113
|
* @param {string} project Project unique identifier
|
|
840
1114
|
* @param {string} platformId The platform identifier
|
|
841
|
-
* @param {
|
|
842
|
-
* @param {
|
|
843
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
844
|
-
* @param {string} [start] Start of date range to filter by when orders were placed
|
|
845
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1115
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1116
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
846
1117
|
* @param {*} [options] Override http request option.
|
|
847
1118
|
* @throws {RequiredError}
|
|
848
1119
|
*/
|
|
849
|
-
async
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
1120
|
+
updateFulfillment: async (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1121
|
+
// verify required parameter 'project' is not null or undefined
|
|
1122
|
+
assertParamExists('updateFulfillment', 'project', project)
|
|
1123
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1124
|
+
assertParamExists('updateFulfillment', 'platformId', platformId)
|
|
1125
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
1126
|
+
assertParamExists('updateFulfillment', 'fulfillmentId', fulfillmentId)
|
|
1127
|
+
// verify required parameter 'updateFulfillmentRequest' is not null or undefined
|
|
1128
|
+
assertParamExists('updateFulfillment', 'updateFulfillmentRequest', updateFulfillmentRequest)
|
|
1129
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
1130
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1131
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
1132
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1133
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1134
|
+
let baseOptions;
|
|
1135
|
+
if (configuration) {
|
|
1136
|
+
baseOptions = configuration.baseOptions;
|
|
1137
|
+
}
|
|
1138
|
+
|
|
1139
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
1140
|
+
const localVarHeaderParameter = {} as any;
|
|
1141
|
+
const localVarQueryParameter = {} as any;
|
|
1142
|
+
|
|
1143
|
+
// authentication session-oauth required
|
|
1144
|
+
// oauth required
|
|
1145
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1146
|
+
|
|
1147
|
+
// authentication api-key required
|
|
1148
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1149
|
+
|
|
1150
|
+
if (project !== undefined) {
|
|
1151
|
+
localVarQueryParameter['project'] = project;
|
|
1152
|
+
}
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1157
|
+
|
|
1158
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1159
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1160
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1161
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateFulfillmentRequest, localVarRequestOptions, configuration)
|
|
1162
|
+
|
|
1163
|
+
return {
|
|
1164
|
+
url: toPathString(localVarUrlObj),
|
|
1165
|
+
options: localVarRequestOptions,
|
|
1166
|
+
};
|
|
1167
|
+
},
|
|
1168
|
+
}
|
|
1169
|
+
};
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* OrdersApi - functional programming interface
|
|
1173
|
+
* @export
|
|
1174
|
+
*/
|
|
1175
|
+
export const OrdersApiFp = function(configuration?: Configuration) {
|
|
1176
|
+
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
|
|
1177
|
+
return {
|
|
1178
|
+
/**
|
|
1179
|
+
* Export orders as a CSV file
|
|
1180
|
+
* @summary Export orders
|
|
1181
|
+
* @param {string} project Project unique identifier
|
|
1182
|
+
* @param {string} platformId The platform identifier
|
|
1183
|
+
* @param {string} start Start of date range to filter by when orders were placed
|
|
1184
|
+
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1185
|
+
* @param {*} [options] Override http request option.
|
|
1186
|
+
* @throws {RequiredError}
|
|
1187
|
+
*/
|
|
1188
|
+
async exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
1189
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, options);
|
|
1190
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1191
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.exportOrders']?.[localVarOperationServerIndex]?.url;
|
|
1192
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1193
|
+
},
|
|
1194
|
+
/**
|
|
1195
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1196
|
+
* @summary Get fulfillment
|
|
1197
|
+
* @param {string} project Project unique identifier
|
|
1198
|
+
* @param {string} platformId The platform identifier
|
|
1199
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1200
|
+
* @param {*} [options] Override http request option.
|
|
1201
|
+
* @throws {RequiredError}
|
|
1202
|
+
*/
|
|
1203
|
+
async getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
|
|
1204
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getFulfillment(project, platformId, fulfillmentId, options);
|
|
1205
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1206
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getFulfillment']?.[localVarOperationServerIndex]?.url;
|
|
1207
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1208
|
+
},
|
|
1209
|
+
/**
|
|
1210
|
+
* Get an order for a platform by a given order ID.
|
|
1211
|
+
* @summary Get order
|
|
1212
|
+
* @param {string} project Project unique identifier
|
|
1213
|
+
* @param {string} platformId The platform identifier
|
|
1214
|
+
* @param {string} orderId The order identifier
|
|
1215
|
+
* @param {*} [options] Override http request option.
|
|
1216
|
+
* @throws {RequiredError}
|
|
1217
|
+
*/
|
|
1218
|
+
async getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
1219
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(project, platformId, orderId, options);
|
|
1220
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1221
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
1222
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1223
|
+
},
|
|
1224
|
+
/**
|
|
1225
|
+
* List available fulfillers for a given fulfillment
|
|
1226
|
+
* @summary List available fulfillers
|
|
1227
|
+
* @param {string} project Project unique identifier
|
|
1228
|
+
* @param {string} platformId The platform identifier
|
|
1229
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1230
|
+
* @param {*} [options] Override http request option.
|
|
1231
|
+
* @throws {RequiredError}
|
|
1232
|
+
*/
|
|
1233
|
+
async listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>> {
|
|
1234
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableFulfillers(project, platformId, fulfillmentId, options);
|
|
1235
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1236
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listAvailableFulfillers']?.[localVarOperationServerIndex]?.url;
|
|
1237
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1238
|
+
},
|
|
1239
|
+
/**
|
|
1240
|
+
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1241
|
+
* @summary List orders
|
|
1242
|
+
* @param {string} project Project unique identifier
|
|
1243
|
+
* @param {string} platformId The platform identifier
|
|
1244
|
+
* @param {number} [pageToken] Page reference token
|
|
1245
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1246
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1247
|
+
* @param {string} [start] Start of date range to filter by when orders were placed
|
|
1248
|
+
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1249
|
+
* @param {*} [options] Override http request option.
|
|
1250
|
+
* @throws {RequiredError}
|
|
1251
|
+
*/
|
|
1252
|
+
async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
|
|
1253
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, options);
|
|
1254
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1255
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
1256
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1257
|
+
},
|
|
1258
|
+
/**
|
|
1259
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1260
|
+
* @summary Update fulfillment
|
|
1261
|
+
* @param {string} project Project unique identifier
|
|
1262
|
+
* @param {string} platformId The platform identifier
|
|
1263
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1264
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
1265
|
+
* @param {*} [options] Override http request option.
|
|
1266
|
+
* @throws {RequiredError}
|
|
1267
|
+
*/
|
|
1268
|
+
async updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
|
|
1269
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateFulfillment(project, platformId, fulfillmentId, updateFulfillmentRequest, options);
|
|
1270
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1271
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.updateFulfillment']?.[localVarOperationServerIndex]?.url;
|
|
1272
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
854
1273
|
},
|
|
855
1274
|
}
|
|
856
1275
|
};
|
|
@@ -872,6 +1291,36 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
872
1291
|
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
873
1292
|
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
874
1293
|
},
|
|
1294
|
+
/**
|
|
1295
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1296
|
+
* @summary Get fulfillment
|
|
1297
|
+
* @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
1298
|
+
* @param {*} [options] Override http request option.
|
|
1299
|
+
* @throws {RequiredError}
|
|
1300
|
+
*/
|
|
1301
|
+
getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
|
|
1302
|
+
return localVarFp.getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
1303
|
+
},
|
|
1304
|
+
/**
|
|
1305
|
+
* Get an order for a platform by a given order ID.
|
|
1306
|
+
* @summary Get order
|
|
1307
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
1308
|
+
* @param {*} [options] Override http request option.
|
|
1309
|
+
* @throws {RequiredError}
|
|
1310
|
+
*/
|
|
1311
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
1312
|
+
return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
1313
|
+
},
|
|
1314
|
+
/**
|
|
1315
|
+
* List available fulfillers for a given fulfillment
|
|
1316
|
+
* @summary List available fulfillers
|
|
1317
|
+
* @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
1318
|
+
* @param {*} [options] Override http request option.
|
|
1319
|
+
* @throws {RequiredError}
|
|
1320
|
+
*/
|
|
1321
|
+
listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse> {
|
|
1322
|
+
return localVarFp.listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
1323
|
+
},
|
|
875
1324
|
/**
|
|
876
1325
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
877
1326
|
* @summary List orders
|
|
@@ -882,6 +1331,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
882
1331
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
883
1332
|
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
884
1333
|
},
|
|
1334
|
+
/**
|
|
1335
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1336
|
+
* @summary Update fulfillment
|
|
1337
|
+
* @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
1338
|
+
* @param {*} [options] Override http request option.
|
|
1339
|
+
* @throws {RequiredError}
|
|
1340
|
+
*/
|
|
1341
|
+
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
|
|
1342
|
+
return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
|
|
1343
|
+
},
|
|
885
1344
|
};
|
|
886
1345
|
};
|
|
887
1346
|
|
|
@@ -920,6 +1379,90 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
920
1379
|
readonly end?: string
|
|
921
1380
|
}
|
|
922
1381
|
|
|
1382
|
+
/**
|
|
1383
|
+
* Request parameters for getFulfillment operation in OrdersApi.
|
|
1384
|
+
* @export
|
|
1385
|
+
* @interface OrdersApiGetFulfillmentRequest
|
|
1386
|
+
*/
|
|
1387
|
+
export interface OrdersApiGetFulfillmentRequest {
|
|
1388
|
+
/**
|
|
1389
|
+
* Project unique identifier
|
|
1390
|
+
* @type {string}
|
|
1391
|
+
* @memberof OrdersApiGetFulfillment
|
|
1392
|
+
*/
|
|
1393
|
+
readonly project: string
|
|
1394
|
+
|
|
1395
|
+
/**
|
|
1396
|
+
* The platform identifier
|
|
1397
|
+
* @type {string}
|
|
1398
|
+
* @memberof OrdersApiGetFulfillment
|
|
1399
|
+
*/
|
|
1400
|
+
readonly platformId: string
|
|
1401
|
+
|
|
1402
|
+
/**
|
|
1403
|
+
* The fulfillment identifier
|
|
1404
|
+
* @type {string}
|
|
1405
|
+
* @memberof OrdersApiGetFulfillment
|
|
1406
|
+
*/
|
|
1407
|
+
readonly fulfillmentId: string
|
|
1408
|
+
}
|
|
1409
|
+
|
|
1410
|
+
/**
|
|
1411
|
+
* Request parameters for getOrder operation in OrdersApi.
|
|
1412
|
+
* @export
|
|
1413
|
+
* @interface OrdersApiGetOrderRequest
|
|
1414
|
+
*/
|
|
1415
|
+
export interface OrdersApiGetOrderRequest {
|
|
1416
|
+
/**
|
|
1417
|
+
* Project unique identifier
|
|
1418
|
+
* @type {string}
|
|
1419
|
+
* @memberof OrdersApiGetOrder
|
|
1420
|
+
*/
|
|
1421
|
+
readonly project: string
|
|
1422
|
+
|
|
1423
|
+
/**
|
|
1424
|
+
* The platform identifier
|
|
1425
|
+
* @type {string}
|
|
1426
|
+
* @memberof OrdersApiGetOrder
|
|
1427
|
+
*/
|
|
1428
|
+
readonly platformId: string
|
|
1429
|
+
|
|
1430
|
+
/**
|
|
1431
|
+
* The order identifier
|
|
1432
|
+
* @type {string}
|
|
1433
|
+
* @memberof OrdersApiGetOrder
|
|
1434
|
+
*/
|
|
1435
|
+
readonly orderId: string
|
|
1436
|
+
}
|
|
1437
|
+
|
|
1438
|
+
/**
|
|
1439
|
+
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
1440
|
+
* @export
|
|
1441
|
+
* @interface OrdersApiListAvailableFulfillersRequest
|
|
1442
|
+
*/
|
|
1443
|
+
export interface OrdersApiListAvailableFulfillersRequest {
|
|
1444
|
+
/**
|
|
1445
|
+
* Project unique identifier
|
|
1446
|
+
* @type {string}
|
|
1447
|
+
* @memberof OrdersApiListAvailableFulfillers
|
|
1448
|
+
*/
|
|
1449
|
+
readonly project: string
|
|
1450
|
+
|
|
1451
|
+
/**
|
|
1452
|
+
* The platform identifier
|
|
1453
|
+
* @type {string}
|
|
1454
|
+
* @memberof OrdersApiListAvailableFulfillers
|
|
1455
|
+
*/
|
|
1456
|
+
readonly platformId: string
|
|
1457
|
+
|
|
1458
|
+
/**
|
|
1459
|
+
* The fulfillment identifier
|
|
1460
|
+
* @type {string}
|
|
1461
|
+
* @memberof OrdersApiListAvailableFulfillers
|
|
1462
|
+
*/
|
|
1463
|
+
readonly fulfillmentId: string
|
|
1464
|
+
}
|
|
1465
|
+
|
|
923
1466
|
/**
|
|
924
1467
|
* Request parameters for listOrders operation in OrdersApi.
|
|
925
1468
|
* @export
|
|
@@ -976,6 +1519,41 @@ export interface OrdersApiListOrdersRequest {
|
|
|
976
1519
|
readonly end?: string
|
|
977
1520
|
}
|
|
978
1521
|
|
|
1522
|
+
/**
|
|
1523
|
+
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
1524
|
+
* @export
|
|
1525
|
+
* @interface OrdersApiUpdateFulfillmentRequest
|
|
1526
|
+
*/
|
|
1527
|
+
export interface OrdersApiUpdateFulfillmentRequest {
|
|
1528
|
+
/**
|
|
1529
|
+
* Project unique identifier
|
|
1530
|
+
* @type {string}
|
|
1531
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1532
|
+
*/
|
|
1533
|
+
readonly project: string
|
|
1534
|
+
|
|
1535
|
+
/**
|
|
1536
|
+
* The platform identifier
|
|
1537
|
+
* @type {string}
|
|
1538
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1539
|
+
*/
|
|
1540
|
+
readonly platformId: string
|
|
1541
|
+
|
|
1542
|
+
/**
|
|
1543
|
+
* The fulfillment identifier
|
|
1544
|
+
* @type {string}
|
|
1545
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1546
|
+
*/
|
|
1547
|
+
readonly fulfillmentId: string
|
|
1548
|
+
|
|
1549
|
+
/**
|
|
1550
|
+
*
|
|
1551
|
+
* @type {UpdateFulfillmentRequest}
|
|
1552
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1553
|
+
*/
|
|
1554
|
+
readonly updateFulfillmentRequest: UpdateFulfillmentRequest
|
|
1555
|
+
}
|
|
1556
|
+
|
|
979
1557
|
/**
|
|
980
1558
|
* OrdersApi - object-oriented interface
|
|
981
1559
|
* @export
|
|
@@ -995,6 +1573,42 @@ export class OrdersApi extends BaseAPI {
|
|
|
995
1573
|
return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
996
1574
|
}
|
|
997
1575
|
|
|
1576
|
+
/**
|
|
1577
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1578
|
+
* @summary Get fulfillment
|
|
1579
|
+
* @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
1580
|
+
* @param {*} [options] Override http request option.
|
|
1581
|
+
* @throws {RequiredError}
|
|
1582
|
+
* @memberof OrdersApi
|
|
1583
|
+
*/
|
|
1584
|
+
public getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig) {
|
|
1585
|
+
return OrdersApiFp(this.configuration).getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
1586
|
+
}
|
|
1587
|
+
|
|
1588
|
+
/**
|
|
1589
|
+
* Get an order for a platform by a given order ID.
|
|
1590
|
+
* @summary Get order
|
|
1591
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
1592
|
+
* @param {*} [options] Override http request option.
|
|
1593
|
+
* @throws {RequiredError}
|
|
1594
|
+
* @memberof OrdersApi
|
|
1595
|
+
*/
|
|
1596
|
+
public getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig) {
|
|
1597
|
+
return OrdersApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
1598
|
+
}
|
|
1599
|
+
|
|
1600
|
+
/**
|
|
1601
|
+
* List available fulfillers for a given fulfillment
|
|
1602
|
+
* @summary List available fulfillers
|
|
1603
|
+
* @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
1604
|
+
* @param {*} [options] Override http request option.
|
|
1605
|
+
* @throws {RequiredError}
|
|
1606
|
+
* @memberof OrdersApi
|
|
1607
|
+
*/
|
|
1608
|
+
public listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig) {
|
|
1609
|
+
return OrdersApiFp(this.configuration).listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
1610
|
+
}
|
|
1611
|
+
|
|
998
1612
|
/**
|
|
999
1613
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1000
1614
|
* @summary List orders
|
|
@@ -1006,6 +1620,18 @@ export class OrdersApi extends BaseAPI {
|
|
|
1006
1620
|
public listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
1007
1621
|
return OrdersApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1008
1622
|
}
|
|
1623
|
+
|
|
1624
|
+
/**
|
|
1625
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1626
|
+
* @summary Update fulfillment
|
|
1627
|
+
* @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
1628
|
+
* @param {*} [options] Override http request option.
|
|
1629
|
+
* @throws {RequiredError}
|
|
1630
|
+
* @memberof OrdersApi
|
|
1631
|
+
*/
|
|
1632
|
+
public updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig) {
|
|
1633
|
+
return OrdersApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1634
|
+
}
|
|
1009
1635
|
}
|
|
1010
1636
|
|
|
1011
1637
|
|
|
@@ -1017,24 +1643,184 @@ export class OrdersApi extends BaseAPI {
|
|
|
1017
1643
|
export const PlatformApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1018
1644
|
return {
|
|
1019
1645
|
/**
|
|
1020
|
-
* Export orders as a CSV file
|
|
1021
|
-
* @summary Export orders
|
|
1646
|
+
* Export orders as a CSV file
|
|
1647
|
+
* @summary Export orders
|
|
1648
|
+
* @param {string} project Project unique identifier
|
|
1649
|
+
* @param {string} platformId The platform identifier
|
|
1650
|
+
* @param {string} start Start of date range to filter by when orders were placed
|
|
1651
|
+
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1652
|
+
* @param {*} [options] Override http request option.
|
|
1653
|
+
* @throws {RequiredError}
|
|
1654
|
+
*/
|
|
1655
|
+
exportOrders: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1656
|
+
// verify required parameter 'project' is not null or undefined
|
|
1657
|
+
assertParamExists('exportOrders', 'project', project)
|
|
1658
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1659
|
+
assertParamExists('exportOrders', 'platformId', platformId)
|
|
1660
|
+
// verify required parameter 'start' is not null or undefined
|
|
1661
|
+
assertParamExists('exportOrders', 'start', start)
|
|
1662
|
+
const localVarPath = `/v1/platform/{platformId}/orders/export`
|
|
1663
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1664
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1665
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1666
|
+
let baseOptions;
|
|
1667
|
+
if (configuration) {
|
|
1668
|
+
baseOptions = configuration.baseOptions;
|
|
1669
|
+
}
|
|
1670
|
+
|
|
1671
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1672
|
+
const localVarHeaderParameter = {} as any;
|
|
1673
|
+
const localVarQueryParameter = {} as any;
|
|
1674
|
+
|
|
1675
|
+
// authentication session-oauth required
|
|
1676
|
+
// oauth required
|
|
1677
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1678
|
+
|
|
1679
|
+
// authentication api-key required
|
|
1680
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1681
|
+
|
|
1682
|
+
if (project !== undefined) {
|
|
1683
|
+
localVarQueryParameter['project'] = project;
|
|
1684
|
+
}
|
|
1685
|
+
|
|
1686
|
+
if (start !== undefined) {
|
|
1687
|
+
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
1688
|
+
(start as any).toISOString() :
|
|
1689
|
+
start;
|
|
1690
|
+
}
|
|
1691
|
+
|
|
1692
|
+
if (end !== undefined) {
|
|
1693
|
+
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
1694
|
+
(end as any).toISOString() :
|
|
1695
|
+
end;
|
|
1696
|
+
}
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1701
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1702
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1703
|
+
|
|
1704
|
+
return {
|
|
1705
|
+
url: toPathString(localVarUrlObj),
|
|
1706
|
+
options: localVarRequestOptions,
|
|
1707
|
+
};
|
|
1708
|
+
},
|
|
1709
|
+
/**
|
|
1710
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1711
|
+
* @summary Get fulfillment
|
|
1712
|
+
* @param {string} project Project unique identifier
|
|
1713
|
+
* @param {string} platformId The platform identifier
|
|
1714
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1715
|
+
* @param {*} [options] Override http request option.
|
|
1716
|
+
* @throws {RequiredError}
|
|
1717
|
+
*/
|
|
1718
|
+
getFulfillment: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1719
|
+
// verify required parameter 'project' is not null or undefined
|
|
1720
|
+
assertParamExists('getFulfillment', 'project', project)
|
|
1721
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1722
|
+
assertParamExists('getFulfillment', 'platformId', platformId)
|
|
1723
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
1724
|
+
assertParamExists('getFulfillment', 'fulfillmentId', fulfillmentId)
|
|
1725
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
1726
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1727
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
1728
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1729
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1730
|
+
let baseOptions;
|
|
1731
|
+
if (configuration) {
|
|
1732
|
+
baseOptions = configuration.baseOptions;
|
|
1733
|
+
}
|
|
1734
|
+
|
|
1735
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1736
|
+
const localVarHeaderParameter = {} as any;
|
|
1737
|
+
const localVarQueryParameter = {} as any;
|
|
1738
|
+
|
|
1739
|
+
// authentication session-oauth required
|
|
1740
|
+
// oauth required
|
|
1741
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1742
|
+
|
|
1743
|
+
// authentication api-key required
|
|
1744
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1745
|
+
|
|
1746
|
+
if (project !== undefined) {
|
|
1747
|
+
localVarQueryParameter['project'] = project;
|
|
1748
|
+
}
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1753
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1754
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1755
|
+
|
|
1756
|
+
return {
|
|
1757
|
+
url: toPathString(localVarUrlObj),
|
|
1758
|
+
options: localVarRequestOptions,
|
|
1759
|
+
};
|
|
1760
|
+
},
|
|
1761
|
+
/**
|
|
1762
|
+
* Get an order for a platform by a given order ID.
|
|
1763
|
+
* @summary Get order
|
|
1764
|
+
* @param {string} project Project unique identifier
|
|
1765
|
+
* @param {string} platformId The platform identifier
|
|
1766
|
+
* @param {string} orderId The order identifier
|
|
1767
|
+
* @param {*} [options] Override http request option.
|
|
1768
|
+
* @throws {RequiredError}
|
|
1769
|
+
*/
|
|
1770
|
+
getOrder: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1771
|
+
// verify required parameter 'project' is not null or undefined
|
|
1772
|
+
assertParamExists('getOrder', 'project', project)
|
|
1773
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1774
|
+
assertParamExists('getOrder', 'platformId', platformId)
|
|
1775
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
1776
|
+
assertParamExists('getOrder', 'orderId', orderId)
|
|
1777
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}`
|
|
1778
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1779
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
1780
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1781
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1782
|
+
let baseOptions;
|
|
1783
|
+
if (configuration) {
|
|
1784
|
+
baseOptions = configuration.baseOptions;
|
|
1785
|
+
}
|
|
1786
|
+
|
|
1787
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1788
|
+
const localVarHeaderParameter = {} as any;
|
|
1789
|
+
const localVarQueryParameter = {} as any;
|
|
1790
|
+
|
|
1791
|
+
// authentication session-oauth required
|
|
1792
|
+
// oauth required
|
|
1793
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1794
|
+
|
|
1795
|
+
// authentication api-key required
|
|
1796
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1797
|
+
|
|
1798
|
+
if (project !== undefined) {
|
|
1799
|
+
localVarQueryParameter['project'] = project;
|
|
1800
|
+
}
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1805
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1806
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1807
|
+
|
|
1808
|
+
return {
|
|
1809
|
+
url: toPathString(localVarUrlObj),
|
|
1810
|
+
options: localVarRequestOptions,
|
|
1811
|
+
};
|
|
1812
|
+
},
|
|
1813
|
+
/**
|
|
1814
|
+
*
|
|
1815
|
+
* @summary Get platform details
|
|
1022
1816
|
* @param {string} project Project unique identifier
|
|
1023
|
-
* @param {string} platformId The platform identifier
|
|
1024
|
-
* @param {string} start Start of date range to filter by when orders were placed
|
|
1025
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1026
1817
|
* @param {*} [options] Override http request option.
|
|
1027
1818
|
* @throws {RequiredError}
|
|
1028
1819
|
*/
|
|
1029
|
-
|
|
1820
|
+
getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1030
1821
|
// verify required parameter 'project' is not null or undefined
|
|
1031
|
-
assertParamExists('
|
|
1032
|
-
|
|
1033
|
-
assertParamExists('exportOrders', 'platformId', platformId)
|
|
1034
|
-
// verify required parameter 'start' is not null or undefined
|
|
1035
|
-
assertParamExists('exportOrders', 'start', start)
|
|
1036
|
-
const localVarPath = `/v1/platform/{platformId}/orders/export`
|
|
1037
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1822
|
+
assertParamExists('getPlatform', 'project', project)
|
|
1823
|
+
const localVarPath = `/v1/platform`;
|
|
1038
1824
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1039
1825
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1040
1826
|
let baseOptions;
|
|
@@ -1057,18 +1843,6 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1057
1843
|
localVarQueryParameter['project'] = project;
|
|
1058
1844
|
}
|
|
1059
1845
|
|
|
1060
|
-
if (start !== undefined) {
|
|
1061
|
-
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
1062
|
-
(start as any).toISOString() :
|
|
1063
|
-
start;
|
|
1064
|
-
}
|
|
1065
|
-
|
|
1066
|
-
if (end !== undefined) {
|
|
1067
|
-
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
1068
|
-
(end as any).toISOString() :
|
|
1069
|
-
end;
|
|
1070
|
-
}
|
|
1071
|
-
|
|
1072
1846
|
|
|
1073
1847
|
|
|
1074
1848
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1081,16 +1855,24 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1081
1855
|
};
|
|
1082
1856
|
},
|
|
1083
1857
|
/**
|
|
1084
|
-
*
|
|
1085
|
-
* @summary
|
|
1858
|
+
* List available fulfillers for a given fulfillment
|
|
1859
|
+
* @summary List available fulfillers
|
|
1086
1860
|
* @param {string} project Project unique identifier
|
|
1861
|
+
* @param {string} platformId The platform identifier
|
|
1862
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1087
1863
|
* @param {*} [options] Override http request option.
|
|
1088
1864
|
* @throws {RequiredError}
|
|
1089
1865
|
*/
|
|
1090
|
-
|
|
1866
|
+
listAvailableFulfillers: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1091
1867
|
// verify required parameter 'project' is not null or undefined
|
|
1092
|
-
assertParamExists('
|
|
1093
|
-
|
|
1868
|
+
assertParamExists('listAvailableFulfillers', 'project', project)
|
|
1869
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1870
|
+
assertParamExists('listAvailableFulfillers', 'platformId', platformId)
|
|
1871
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
1872
|
+
assertParamExists('listAvailableFulfillers', 'fulfillmentId', fulfillmentId)
|
|
1873
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers`
|
|
1874
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1875
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
1094
1876
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1095
1877
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1096
1878
|
let baseOptions;
|
|
@@ -1201,6 +1983,64 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
1201
1983
|
options: localVarRequestOptions,
|
|
1202
1984
|
};
|
|
1203
1985
|
},
|
|
1986
|
+
/**
|
|
1987
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1988
|
+
* @summary Update fulfillment
|
|
1989
|
+
* @param {string} project Project unique identifier
|
|
1990
|
+
* @param {string} platformId The platform identifier
|
|
1991
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1992
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
1993
|
+
* @param {*} [options] Override http request option.
|
|
1994
|
+
* @throws {RequiredError}
|
|
1995
|
+
*/
|
|
1996
|
+
updateFulfillment: async (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1997
|
+
// verify required parameter 'project' is not null or undefined
|
|
1998
|
+
assertParamExists('updateFulfillment', 'project', project)
|
|
1999
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2000
|
+
assertParamExists('updateFulfillment', 'platformId', platformId)
|
|
2001
|
+
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
2002
|
+
assertParamExists('updateFulfillment', 'fulfillmentId', fulfillmentId)
|
|
2003
|
+
// verify required parameter 'updateFulfillmentRequest' is not null or undefined
|
|
2004
|
+
assertParamExists('updateFulfillment', 'updateFulfillmentRequest', updateFulfillmentRequest)
|
|
2005
|
+
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
2006
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
2007
|
+
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
2008
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2009
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2010
|
+
let baseOptions;
|
|
2011
|
+
if (configuration) {
|
|
2012
|
+
baseOptions = configuration.baseOptions;
|
|
2013
|
+
}
|
|
2014
|
+
|
|
2015
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
2016
|
+
const localVarHeaderParameter = {} as any;
|
|
2017
|
+
const localVarQueryParameter = {} as any;
|
|
2018
|
+
|
|
2019
|
+
// authentication session-oauth required
|
|
2020
|
+
// oauth required
|
|
2021
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2022
|
+
|
|
2023
|
+
// authentication api-key required
|
|
2024
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2025
|
+
|
|
2026
|
+
if (project !== undefined) {
|
|
2027
|
+
localVarQueryParameter['project'] = project;
|
|
2028
|
+
}
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
2033
|
+
|
|
2034
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2035
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2036
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2037
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateFulfillmentRequest, localVarRequestOptions, configuration)
|
|
2038
|
+
|
|
2039
|
+
return {
|
|
2040
|
+
url: toPathString(localVarUrlObj),
|
|
2041
|
+
options: localVarRequestOptions,
|
|
2042
|
+
};
|
|
2043
|
+
},
|
|
1204
2044
|
/**
|
|
1205
2045
|
*
|
|
1206
2046
|
* @summary Update platform
|
|
@@ -1277,6 +2117,36 @@ export const PlatformApiFp = function(configuration?: Configuration) {
|
|
|
1277
2117
|
const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportOrders']?.[localVarOperationServerIndex]?.url;
|
|
1278
2118
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1279
2119
|
},
|
|
2120
|
+
/**
|
|
2121
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2122
|
+
* @summary Get fulfillment
|
|
2123
|
+
* @param {string} project Project unique identifier
|
|
2124
|
+
* @param {string} platformId The platform identifier
|
|
2125
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
2126
|
+
* @param {*} [options] Override http request option.
|
|
2127
|
+
* @throws {RequiredError}
|
|
2128
|
+
*/
|
|
2129
|
+
async getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
|
|
2130
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getFulfillment(project, platformId, fulfillmentId, options);
|
|
2131
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2132
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getFulfillment']?.[localVarOperationServerIndex]?.url;
|
|
2133
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2134
|
+
},
|
|
2135
|
+
/**
|
|
2136
|
+
* Get an order for a platform by a given order ID.
|
|
2137
|
+
* @summary Get order
|
|
2138
|
+
* @param {string} project Project unique identifier
|
|
2139
|
+
* @param {string} platformId The platform identifier
|
|
2140
|
+
* @param {string} orderId The order identifier
|
|
2141
|
+
* @param {*} [options] Override http request option.
|
|
2142
|
+
* @throws {RequiredError}
|
|
2143
|
+
*/
|
|
2144
|
+
async getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
2145
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(project, platformId, orderId, options);
|
|
2146
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2147
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
2148
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2149
|
+
},
|
|
1280
2150
|
/**
|
|
1281
2151
|
*
|
|
1282
2152
|
* @summary Get platform details
|
|
@@ -1290,6 +2160,21 @@ export const PlatformApiFp = function(configuration?: Configuration) {
|
|
|
1290
2160
|
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
|
|
1291
2161
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1292
2162
|
},
|
|
2163
|
+
/**
|
|
2164
|
+
* List available fulfillers for a given fulfillment
|
|
2165
|
+
* @summary List available fulfillers
|
|
2166
|
+
* @param {string} project Project unique identifier
|
|
2167
|
+
* @param {string} platformId The platform identifier
|
|
2168
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
2169
|
+
* @param {*} [options] Override http request option.
|
|
2170
|
+
* @throws {RequiredError}
|
|
2171
|
+
*/
|
|
2172
|
+
async listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>> {
|
|
2173
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableFulfillers(project, platformId, fulfillmentId, options);
|
|
2174
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2175
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listAvailableFulfillers']?.[localVarOperationServerIndex]?.url;
|
|
2176
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2177
|
+
},
|
|
1293
2178
|
/**
|
|
1294
2179
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1295
2180
|
* @summary List orders
|
|
@@ -1309,6 +2194,22 @@ export const PlatformApiFp = function(configuration?: Configuration) {
|
|
|
1309
2194
|
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
1310
2195
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1311
2196
|
},
|
|
2197
|
+
/**
|
|
2198
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
2199
|
+
* @summary Update fulfillment
|
|
2200
|
+
* @param {string} project Project unique identifier
|
|
2201
|
+
* @param {string} platformId The platform identifier
|
|
2202
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
2203
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
2204
|
+
* @param {*} [options] Override http request option.
|
|
2205
|
+
* @throws {RequiredError}
|
|
2206
|
+
*/
|
|
2207
|
+
async updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
|
|
2208
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateFulfillment(project, platformId, fulfillmentId, updateFulfillmentRequest, options);
|
|
2209
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2210
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateFulfillment']?.[localVarOperationServerIndex]?.url;
|
|
2211
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2212
|
+
},
|
|
1312
2213
|
/**
|
|
1313
2214
|
*
|
|
1314
2215
|
* @summary Update platform
|
|
@@ -1343,6 +2244,26 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
|
|
|
1343
2244
|
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
1344
2245
|
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1345
2246
|
},
|
|
2247
|
+
/**
|
|
2248
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2249
|
+
* @summary Get fulfillment
|
|
2250
|
+
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
2251
|
+
* @param {*} [options] Override http request option.
|
|
2252
|
+
* @throws {RequiredError}
|
|
2253
|
+
*/
|
|
2254
|
+
getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
|
|
2255
|
+
return localVarFp.getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
2256
|
+
},
|
|
2257
|
+
/**
|
|
2258
|
+
* Get an order for a platform by a given order ID.
|
|
2259
|
+
* @summary Get order
|
|
2260
|
+
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
2261
|
+
* @param {*} [options] Override http request option.
|
|
2262
|
+
* @throws {RequiredError}
|
|
2263
|
+
*/
|
|
2264
|
+
getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
2265
|
+
return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
2266
|
+
},
|
|
1346
2267
|
/**
|
|
1347
2268
|
*
|
|
1348
2269
|
* @summary Get platform details
|
|
@@ -1353,6 +2274,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
|
|
|
1353
2274
|
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
|
|
1354
2275
|
return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
1355
2276
|
},
|
|
2277
|
+
/**
|
|
2278
|
+
* List available fulfillers for a given fulfillment
|
|
2279
|
+
* @summary List available fulfillers
|
|
2280
|
+
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
2281
|
+
* @param {*} [options] Override http request option.
|
|
2282
|
+
* @throws {RequiredError}
|
|
2283
|
+
*/
|
|
2284
|
+
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse> {
|
|
2285
|
+
return localVarFp.listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
2286
|
+
},
|
|
1356
2287
|
/**
|
|
1357
2288
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1358
2289
|
* @summary List orders
|
|
@@ -1363,6 +2294,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
|
|
|
1363
2294
|
listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
1364
2295
|
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
1365
2296
|
},
|
|
2297
|
+
/**
|
|
2298
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
2299
|
+
* @summary Update fulfillment
|
|
2300
|
+
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
2301
|
+
* @param {*} [options] Override http request option.
|
|
2302
|
+
* @throws {RequiredError}
|
|
2303
|
+
*/
|
|
2304
|
+
updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
|
|
2305
|
+
return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
|
|
2306
|
+
},
|
|
1366
2307
|
/**
|
|
1367
2308
|
*
|
|
1368
2309
|
* @summary Update platform
|
|
@@ -1411,6 +2352,62 @@ export interface PlatformApiExportOrdersRequest {
|
|
|
1411
2352
|
readonly end?: string
|
|
1412
2353
|
}
|
|
1413
2354
|
|
|
2355
|
+
/**
|
|
2356
|
+
* Request parameters for getFulfillment operation in PlatformApi.
|
|
2357
|
+
* @export
|
|
2358
|
+
* @interface PlatformApiGetFulfillmentRequest
|
|
2359
|
+
*/
|
|
2360
|
+
export interface PlatformApiGetFulfillmentRequest {
|
|
2361
|
+
/**
|
|
2362
|
+
* Project unique identifier
|
|
2363
|
+
* @type {string}
|
|
2364
|
+
* @memberof PlatformApiGetFulfillment
|
|
2365
|
+
*/
|
|
2366
|
+
readonly project: string
|
|
2367
|
+
|
|
2368
|
+
/**
|
|
2369
|
+
* The platform identifier
|
|
2370
|
+
* @type {string}
|
|
2371
|
+
* @memberof PlatformApiGetFulfillment
|
|
2372
|
+
*/
|
|
2373
|
+
readonly platformId: string
|
|
2374
|
+
|
|
2375
|
+
/**
|
|
2376
|
+
* The fulfillment identifier
|
|
2377
|
+
* @type {string}
|
|
2378
|
+
* @memberof PlatformApiGetFulfillment
|
|
2379
|
+
*/
|
|
2380
|
+
readonly fulfillmentId: string
|
|
2381
|
+
}
|
|
2382
|
+
|
|
2383
|
+
/**
|
|
2384
|
+
* Request parameters for getOrder operation in PlatformApi.
|
|
2385
|
+
* @export
|
|
2386
|
+
* @interface PlatformApiGetOrderRequest
|
|
2387
|
+
*/
|
|
2388
|
+
export interface PlatformApiGetOrderRequest {
|
|
2389
|
+
/**
|
|
2390
|
+
* Project unique identifier
|
|
2391
|
+
* @type {string}
|
|
2392
|
+
* @memberof PlatformApiGetOrder
|
|
2393
|
+
*/
|
|
2394
|
+
readonly project: string
|
|
2395
|
+
|
|
2396
|
+
/**
|
|
2397
|
+
* The platform identifier
|
|
2398
|
+
* @type {string}
|
|
2399
|
+
* @memberof PlatformApiGetOrder
|
|
2400
|
+
*/
|
|
2401
|
+
readonly platformId: string
|
|
2402
|
+
|
|
2403
|
+
/**
|
|
2404
|
+
* The order identifier
|
|
2405
|
+
* @type {string}
|
|
2406
|
+
* @memberof PlatformApiGetOrder
|
|
2407
|
+
*/
|
|
2408
|
+
readonly orderId: string
|
|
2409
|
+
}
|
|
2410
|
+
|
|
1414
2411
|
/**
|
|
1415
2412
|
* Request parameters for getPlatform operation in PlatformApi.
|
|
1416
2413
|
* @export
|
|
@@ -1425,6 +2422,34 @@ export interface PlatformApiGetPlatformRequest {
|
|
|
1425
2422
|
readonly project: string
|
|
1426
2423
|
}
|
|
1427
2424
|
|
|
2425
|
+
/**
|
|
2426
|
+
* Request parameters for listAvailableFulfillers operation in PlatformApi.
|
|
2427
|
+
* @export
|
|
2428
|
+
* @interface PlatformApiListAvailableFulfillersRequest
|
|
2429
|
+
*/
|
|
2430
|
+
export interface PlatformApiListAvailableFulfillersRequest {
|
|
2431
|
+
/**
|
|
2432
|
+
* Project unique identifier
|
|
2433
|
+
* @type {string}
|
|
2434
|
+
* @memberof PlatformApiListAvailableFulfillers
|
|
2435
|
+
*/
|
|
2436
|
+
readonly project: string
|
|
2437
|
+
|
|
2438
|
+
/**
|
|
2439
|
+
* The platform identifier
|
|
2440
|
+
* @type {string}
|
|
2441
|
+
* @memberof PlatformApiListAvailableFulfillers
|
|
2442
|
+
*/
|
|
2443
|
+
readonly platformId: string
|
|
2444
|
+
|
|
2445
|
+
/**
|
|
2446
|
+
* The fulfillment identifier
|
|
2447
|
+
* @type {string}
|
|
2448
|
+
* @memberof PlatformApiListAvailableFulfillers
|
|
2449
|
+
*/
|
|
2450
|
+
readonly fulfillmentId: string
|
|
2451
|
+
}
|
|
2452
|
+
|
|
1428
2453
|
/**
|
|
1429
2454
|
* Request parameters for listOrders operation in PlatformApi.
|
|
1430
2455
|
* @export
|
|
@@ -1481,6 +2506,41 @@ export interface PlatformApiListOrdersRequest {
|
|
|
1481
2506
|
readonly end?: string
|
|
1482
2507
|
}
|
|
1483
2508
|
|
|
2509
|
+
/**
|
|
2510
|
+
* Request parameters for updateFulfillment operation in PlatformApi.
|
|
2511
|
+
* @export
|
|
2512
|
+
* @interface PlatformApiUpdateFulfillmentRequest
|
|
2513
|
+
*/
|
|
2514
|
+
export interface PlatformApiUpdateFulfillmentRequest {
|
|
2515
|
+
/**
|
|
2516
|
+
* Project unique identifier
|
|
2517
|
+
* @type {string}
|
|
2518
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
2519
|
+
*/
|
|
2520
|
+
readonly project: string
|
|
2521
|
+
|
|
2522
|
+
/**
|
|
2523
|
+
* The platform identifier
|
|
2524
|
+
* @type {string}
|
|
2525
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
2526
|
+
*/
|
|
2527
|
+
readonly platformId: string
|
|
2528
|
+
|
|
2529
|
+
/**
|
|
2530
|
+
* The fulfillment identifier
|
|
2531
|
+
* @type {string}
|
|
2532
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
2533
|
+
*/
|
|
2534
|
+
readonly fulfillmentId: string
|
|
2535
|
+
|
|
2536
|
+
/**
|
|
2537
|
+
*
|
|
2538
|
+
* @type {UpdateFulfillmentRequest}
|
|
2539
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
2540
|
+
*/
|
|
2541
|
+
readonly updateFulfillmentRequest: UpdateFulfillmentRequest
|
|
2542
|
+
}
|
|
2543
|
+
|
|
1484
2544
|
/**
|
|
1485
2545
|
* Request parameters for updatePlatform operation in PlatformApi.
|
|
1486
2546
|
* @export
|
|
@@ -1521,6 +2581,30 @@ export class PlatformApi extends BaseAPI {
|
|
|
1521
2581
|
return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1522
2582
|
}
|
|
1523
2583
|
|
|
2584
|
+
/**
|
|
2585
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2586
|
+
* @summary Get fulfillment
|
|
2587
|
+
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
2588
|
+
* @param {*} [options] Override http request option.
|
|
2589
|
+
* @throws {RequiredError}
|
|
2590
|
+
* @memberof PlatformApi
|
|
2591
|
+
*/
|
|
2592
|
+
public getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig) {
|
|
2593
|
+
return PlatformApiFp(this.configuration).getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
2594
|
+
}
|
|
2595
|
+
|
|
2596
|
+
/**
|
|
2597
|
+
* Get an order for a platform by a given order ID.
|
|
2598
|
+
* @summary Get order
|
|
2599
|
+
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
2600
|
+
* @param {*} [options] Override http request option.
|
|
2601
|
+
* @throws {RequiredError}
|
|
2602
|
+
* @memberof PlatformApi
|
|
2603
|
+
*/
|
|
2604
|
+
public getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig) {
|
|
2605
|
+
return PlatformApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
2606
|
+
}
|
|
2607
|
+
|
|
1524
2608
|
/**
|
|
1525
2609
|
*
|
|
1526
2610
|
* @summary Get platform details
|
|
@@ -1533,6 +2617,18 @@ export class PlatformApi extends BaseAPI {
|
|
|
1533
2617
|
return PlatformApiFp(this.configuration).getPlatform(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
1534
2618
|
}
|
|
1535
2619
|
|
|
2620
|
+
/**
|
|
2621
|
+
* List available fulfillers for a given fulfillment
|
|
2622
|
+
* @summary List available fulfillers
|
|
2623
|
+
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
2624
|
+
* @param {*} [options] Override http request option.
|
|
2625
|
+
* @throws {RequiredError}
|
|
2626
|
+
* @memberof PlatformApi
|
|
2627
|
+
*/
|
|
2628
|
+
public listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig) {
|
|
2629
|
+
return PlatformApiFp(this.configuration).listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
2630
|
+
}
|
|
2631
|
+
|
|
1536
2632
|
/**
|
|
1537
2633
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1538
2634
|
* @summary List orders
|
|
@@ -1545,6 +2641,18 @@ export class PlatformApi extends BaseAPI {
|
|
|
1545
2641
|
return PlatformApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
1546
2642
|
}
|
|
1547
2643
|
|
|
2644
|
+
/**
|
|
2645
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
2646
|
+
* @summary Update fulfillment
|
|
2647
|
+
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
2648
|
+
* @param {*} [options] Override http request option.
|
|
2649
|
+
* @throws {RequiredError}
|
|
2650
|
+
* @memberof PlatformApi
|
|
2651
|
+
*/
|
|
2652
|
+
public updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig) {
|
|
2653
|
+
return PlatformApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2654
|
+
}
|
|
2655
|
+
|
|
1548
2656
|
/**
|
|
1549
2657
|
*
|
|
1550
2658
|
* @summary Update platform
|