@teemill/platform 0.6.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/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.6.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
@@ -168,10 +225,10 @@ export interface Fulfillment {
168
225
  'status'?: OrderStatus;
169
226
  /**
170
227
  *
171
- * @type {FulfillmentFulfiller}
228
+ * @type {Fulfiller}
172
229
  * @memberof Fulfillment
173
230
  */
174
- 'fulfiller'?: FulfillmentFulfiller;
231
+ 'fulfiller'?: Fulfiller;
175
232
  /**
176
233
  *
177
234
  * @type {Array<FulfillmentItem>}
@@ -205,38 +262,6 @@ export interface Fulfillment {
205
262
  }
206
263
 
207
264
 
208
- /**
209
- * The fulfiller that will be processing this order.
210
- * @export
211
- * @interface FulfillmentFulfiller
212
- */
213
- export interface FulfillmentFulfiller {
214
- /**
215
- *
216
- * @type {FulfillmentFulfillerLocation}
217
- * @memberof FulfillmentFulfiller
218
- */
219
- 'location'?: FulfillmentFulfillerLocation;
220
- }
221
- /**
222
- *
223
- * @export
224
- * @interface FulfillmentFulfillerLocation
225
- */
226
- export interface FulfillmentFulfillerLocation {
227
- /**
228
- *
229
- * @type {string}
230
- * @memberof FulfillmentFulfillerLocation
231
- */
232
- 'city'?: string | null;
233
- /**
234
- *
235
- * @type {string}
236
- * @memberof FulfillmentFulfillerLocation
237
- */
238
- 'country'?: string | null;
239
- }
240
265
  /**
241
266
  *
242
267
  * @export
@@ -727,6 +752,19 @@ export interface StatusHistoryItem {
727
752
  }
728
753
 
729
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
+ }
730
768
  /**
731
769
  *
732
770
  * @export
@@ -827,6 +865,162 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
827
865
 
828
866
 
829
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
+
830
1024
  setSearchParams(localVarUrlObj, localVarQueryParameter);
831
1025
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
832
1026
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -908,6 +1102,64 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
908
1102
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
909
1103
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
910
1104
 
1105
+ return {
1106
+ url: toPathString(localVarUrlObj),
1107
+ options: localVarRequestOptions,
1108
+ };
1109
+ },
1110
+ /**
1111
+ * Update a fulfillment that belongs to an order placed through the platform
1112
+ * @summary Update fulfillment
1113
+ * @param {string} project Project unique identifier
1114
+ * @param {string} platformId The platform identifier
1115
+ * @param {string} fulfillmentId The fulfillment identifier
1116
+ * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
1117
+ * @param {*} [options] Override http request option.
1118
+ * @throws {RequiredError}
1119
+ */
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
+
911
1163
  return {
912
1164
  url: toPathString(localVarUrlObj),
913
1165
  options: localVarRequestOptions,
@@ -940,31 +1192,92 @@ export const OrdersApiFp = function(configuration?: Configuration) {
940
1192
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
941
1193
  },
942
1194
  /**
943
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
944
- * @summary List orders
1195
+ * Get a fulfillment for a platform by a given fulfillment ID.
1196
+ * @summary Get fulfillment
945
1197
  * @param {string} project Project unique identifier
946
1198
  * @param {string} platformId The platform identifier
947
- * @param {number} [pageToken] Page reference token
948
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
949
- * @param {string} [search] Search term to filter based on order reference, customer name and email
950
- * @param {string} [start] Start of date range to filter by when orders were placed
951
- * @param {string} [end] End of date range to filter by when orders were placed
1199
+ * @param {string} fulfillmentId The fulfillment identifier
952
1200
  * @param {*} [options] Override http request option.
953
1201
  * @throws {RequiredError}
954
1202
  */
955
- 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>> {
956
- const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, options);
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);
957
1205
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
958
- const localVarOperationServerBasePath = operationServerMap['OrdersApi.listOrders']?.[localVarOperationServerIndex]?.url;
1206
+ const localVarOperationServerBasePath = operationServerMap['OrdersApi.getFulfillment']?.[localVarOperationServerIndex]?.url;
959
1207
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
960
1208
  },
961
- }
962
- };
963
-
964
- /**
965
- * OrdersApi - factory interface
966
- * @export
967
- */
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);
1273
+ },
1274
+ }
1275
+ };
1276
+
1277
+ /**
1278
+ * OrdersApi - factory interface
1279
+ * @export
1280
+ */
968
1281
  export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
969
1282
  const localVarFp = OrdersApiFp(configuration)
970
1283
  return {
@@ -978,6 +1291,36 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
978
1291
  exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
979
1292
  return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
980
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
+ },
981
1324
  /**
982
1325
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
983
1326
  * @summary List orders
@@ -988,6 +1331,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
988
1331
  listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
989
1332
  return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
990
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
+ },
991
1344
  };
992
1345
  };
993
1346
 
@@ -1026,6 +1379,90 @@ export interface OrdersApiExportOrdersRequest {
1026
1379
  readonly end?: string
1027
1380
  }
1028
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
+
1029
1466
  /**
1030
1467
  * Request parameters for listOrders operation in OrdersApi.
1031
1468
  * @export
@@ -1082,6 +1519,41 @@ export interface OrdersApiListOrdersRequest {
1082
1519
  readonly end?: string
1083
1520
  }
1084
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
+
1085
1557
  /**
1086
1558
  * OrdersApi - object-oriented interface
1087
1559
  * @export
@@ -1101,6 +1573,42 @@ export class OrdersApi extends BaseAPI {
1101
1573
  return OrdersApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
1102
1574
  }
1103
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
+
1104
1612
  /**
1105
1613
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1106
1614
  * @summary List orders
@@ -1112,6 +1620,18 @@ export class OrdersApi extends BaseAPI {
1112
1620
  public listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig) {
1113
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));
1114
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
+ }
1115
1635
  }
1116
1636
 
1117
1637
 
@@ -1123,24 +1643,184 @@ export class OrdersApi extends BaseAPI {
1123
1643
  export const PlatformApiAxiosParamCreator = function (configuration?: Configuration) {
1124
1644
  return {
1125
1645
  /**
1126
- * Export orders as a CSV file
1127
- * @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
1128
1816
  * @param {string} project Project unique identifier
1129
- * @param {string} platformId The platform identifier
1130
- * @param {string} start Start of date range to filter by when orders were placed
1131
- * @param {string} [end] End of date range to filter by when orders were placed
1132
1817
  * @param {*} [options] Override http request option.
1133
1818
  * @throws {RequiredError}
1134
1819
  */
1135
- exportOrders: async (project: string, platformId: string, start: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1820
+ getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1136
1821
  // verify required parameter 'project' is not null or undefined
1137
- assertParamExists('exportOrders', 'project', project)
1138
- // verify required parameter 'platformId' is not null or undefined
1139
- assertParamExists('exportOrders', 'platformId', platformId)
1140
- // verify required parameter 'start' is not null or undefined
1141
- assertParamExists('exportOrders', 'start', start)
1142
- const localVarPath = `/v1/platform/{platformId}/orders/export`
1143
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
1822
+ assertParamExists('getPlatform', 'project', project)
1823
+ const localVarPath = `/v1/platform`;
1144
1824
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1145
1825
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1146
1826
  let baseOptions;
@@ -1163,18 +1843,6 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
1163
1843
  localVarQueryParameter['project'] = project;
1164
1844
  }
1165
1845
 
1166
- if (start !== undefined) {
1167
- localVarQueryParameter['start'] = (start as any instanceof Date) ?
1168
- (start as any).toISOString() :
1169
- start;
1170
- }
1171
-
1172
- if (end !== undefined) {
1173
- localVarQueryParameter['end'] = (end as any instanceof Date) ?
1174
- (end as any).toISOString() :
1175
- end;
1176
- }
1177
-
1178
1846
 
1179
1847
 
1180
1848
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1187,16 +1855,24 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
1187
1855
  };
1188
1856
  },
1189
1857
  /**
1190
- *
1191
- * @summary Get platform details
1858
+ * List available fulfillers for a given fulfillment
1859
+ * @summary List available fulfillers
1192
1860
  * @param {string} project Project unique identifier
1861
+ * @param {string} platformId The platform identifier
1862
+ * @param {string} fulfillmentId The fulfillment identifier
1193
1863
  * @param {*} [options] Override http request option.
1194
1864
  * @throws {RequiredError}
1195
1865
  */
1196
- getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1866
+ listAvailableFulfillers: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1197
1867
  // verify required parameter 'project' is not null or undefined
1198
- assertParamExists('getPlatform', 'project', project)
1199
- const localVarPath = `/v1/platform`;
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)));
1200
1876
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
1201
1877
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1202
1878
  let baseOptions;
@@ -1307,6 +1983,64 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
1307
1983
  options: localVarRequestOptions,
1308
1984
  };
1309
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
+ },
1310
2044
  /**
1311
2045
  *
1312
2046
  * @summary Update platform
@@ -1383,6 +2117,36 @@ export const PlatformApiFp = function(configuration?: Configuration) {
1383
2117
  const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportOrders']?.[localVarOperationServerIndex]?.url;
1384
2118
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1385
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
+ },
1386
2150
  /**
1387
2151
  *
1388
2152
  * @summary Get platform details
@@ -1396,6 +2160,21 @@ export const PlatformApiFp = function(configuration?: Configuration) {
1396
2160
  const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
1397
2161
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1398
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
+ },
1399
2178
  /**
1400
2179
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1401
2180
  * @summary List orders
@@ -1415,6 +2194,22 @@ export const PlatformApiFp = function(configuration?: Configuration) {
1415
2194
  const localVarOperationServerBasePath = operationServerMap['PlatformApi.listOrders']?.[localVarOperationServerIndex]?.url;
1416
2195
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1417
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
+ },
1418
2213
  /**
1419
2214
  *
1420
2215
  * @summary Update platform
@@ -1449,6 +2244,26 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
1449
2244
  exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
1450
2245
  return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
1451
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
+ },
1452
2267
  /**
1453
2268
  *
1454
2269
  * @summary Get platform details
@@ -1459,6 +2274,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
1459
2274
  getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
1460
2275
  return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
1461
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
+ },
1462
2287
  /**
1463
2288
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1464
2289
  * @summary List orders
@@ -1469,6 +2294,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
1469
2294
  listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
1470
2295
  return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
1471
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
+ },
1472
2307
  /**
1473
2308
  *
1474
2309
  * @summary Update platform
@@ -1517,6 +2352,62 @@ export interface PlatformApiExportOrdersRequest {
1517
2352
  readonly end?: string
1518
2353
  }
1519
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
+
1520
2411
  /**
1521
2412
  * Request parameters for getPlatform operation in PlatformApi.
1522
2413
  * @export
@@ -1531,6 +2422,34 @@ export interface PlatformApiGetPlatformRequest {
1531
2422
  readonly project: string
1532
2423
  }
1533
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
+
1534
2453
  /**
1535
2454
  * Request parameters for listOrders operation in PlatformApi.
1536
2455
  * @export
@@ -1587,6 +2506,41 @@ export interface PlatformApiListOrdersRequest {
1587
2506
  readonly end?: string
1588
2507
  }
1589
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
+
1590
2544
  /**
1591
2545
  * Request parameters for updatePlatform operation in PlatformApi.
1592
2546
  * @export
@@ -1627,6 +2581,30 @@ export class PlatformApi extends BaseAPI {
1627
2581
  return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
1628
2582
  }
1629
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
+
1630
2608
  /**
1631
2609
  *
1632
2610
  * @summary Get platform details
@@ -1639,6 +2617,18 @@ export class PlatformApi extends BaseAPI {
1639
2617
  return PlatformApiFp(this.configuration).getPlatform(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
1640
2618
  }
1641
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
+
1642
2632
  /**
1643
2633
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1644
2634
  * @summary List orders
@@ -1651,6 +2641,18 @@ export class PlatformApi extends BaseAPI {
1651
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));
1652
2642
  }
1653
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
+
1654
2656
  /**
1655
2657
  *
1656
2658
  * @summary Update platform