@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/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * 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)
4
4
  *
5
- * The version of the OpenAPI document: 0.5.0
5
+ * The version of the OpenAPI document: 0.7.0
6
6
  * Contact: hello@teemill.com
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -138,6 +138,63 @@ export interface ExportOrders202Response {
138
138
  */
139
139
  'message'?: string;
140
140
  }
141
+ /**
142
+ * The fulfiller that will be processing this order.
143
+ * @export
144
+ * @interface Fulfiller
145
+ */
146
+ export interface Fulfiller {
147
+ /**
148
+ * Unique object identifier
149
+ * @type {string}
150
+ * @memberof Fulfiller
151
+ */
152
+ 'id'?: string;
153
+ /**
154
+ *
155
+ * @type {FulfillerLocation}
156
+ * @memberof Fulfiller
157
+ */
158
+ 'location'?: FulfillerLocation;
159
+ }
160
+ /**
161
+ *
162
+ * @export
163
+ * @interface FulfillerLocation
164
+ */
165
+ export interface FulfillerLocation {
166
+ /**
167
+ *
168
+ * @type {string}
169
+ * @memberof FulfillerLocation
170
+ */
171
+ 'city'?: string | null;
172
+ /**
173
+ *
174
+ * @type {string}
175
+ * @memberof FulfillerLocation
176
+ */
177
+ 'country'?: string | null;
178
+ }
179
+ /**
180
+ *
181
+ * @export
182
+ * @interface FulfillersResponse
183
+ */
184
+ export interface FulfillersResponse {
185
+ /**
186
+ *
187
+ * @type {Array<Fulfiller>}
188
+ * @memberof FulfillersResponse
189
+ */
190
+ 'fulfillers'?: Array<Fulfiller>;
191
+ /**
192
+ *
193
+ * @type {number}
194
+ * @memberof FulfillersResponse
195
+ */
196
+ 'nextPageToken'?: number;
197
+ }
141
198
  /**
142
199
  *
143
200
  * @export
@@ -156,6 +213,12 @@ export interface Fulfillment {
156
213
  * @memberof Fulfillment
157
214
  */
158
215
  'status'?: OrderStatus;
216
+ /**
217
+ *
218
+ * @type {Fulfiller}
219
+ * @memberof Fulfillment
220
+ */
221
+ 'fulfiller'?: Fulfiller;
159
222
  /**
160
223
  *
161
224
  * @type {Array<FulfillmentItem>}
@@ -212,6 +275,56 @@ export interface FulfillmentItem {
212
275
  */
213
276
  'quantity'?: number;
214
277
  }
278
+ /**
279
+ * Image description
280
+ * @export
281
+ * @interface Image
282
+ */
283
+ export interface Image {
284
+ /**
285
+ * Unique object identifier
286
+ * @type {string}
287
+ * @memberof Image
288
+ */
289
+ 'id'?: string;
290
+ /**
291
+ *
292
+ * @type {string}
293
+ * @memberof Image
294
+ */
295
+ 'src'?: string;
296
+ /**
297
+ *
298
+ * @type {string}
299
+ * @memberof Image
300
+ */
301
+ 'alt'?: string;
302
+ /**
303
+ *
304
+ * @type {number}
305
+ * @memberof Image
306
+ */
307
+ 'sortOrder'?: number;
308
+ }
309
+ /**
310
+ *
311
+ * @export
312
+ * @interface Option
313
+ */
314
+ export interface Option {
315
+ /**
316
+ * Option name
317
+ * @type {string}
318
+ * @memberof Option
319
+ */
320
+ 'name': string;
321
+ /**
322
+ * Option value
323
+ * @type {string}
324
+ * @memberof Option
325
+ */
326
+ 'value': string;
327
+ }
215
328
  /**
216
329
  *
217
330
  * @export
@@ -339,12 +452,30 @@ export interface OrderItem {
339
452
  * @memberof OrderItem
340
453
  */
341
454
  'variantRef': string;
455
+ /**
456
+ * Options associated to an order item\'s variant, such as color and size.
457
+ * @type {Array<Option>}
458
+ * @memberof OrderItem
459
+ */
460
+ 'options'?: Array<Option>;
342
461
  /**
343
462
  *
344
463
  * @type {number}
345
464
  * @memberof OrderItem
346
465
  */
347
466
  'quantity': number;
467
+ /**
468
+ * The name of the product
469
+ * @type {string}
470
+ * @memberof OrderItem
471
+ */
472
+ 'name'?: string;
473
+ /**
474
+ * Images
475
+ * @type {Array<Image>}
476
+ * @memberof OrderItem
477
+ */
478
+ 'images'?: Array<Image>;
348
479
  /**
349
480
  *
350
481
  * @type {Price}
@@ -603,6 +734,19 @@ export interface StatusHistoryItem {
603
734
  */
604
735
  'createdAt'?: string;
605
736
  }
737
+ /**
738
+ *
739
+ * @export
740
+ * @interface UpdateFulfillmentRequest
741
+ */
742
+ export interface UpdateFulfillmentRequest {
743
+ /**
744
+ * Unique object identifier
745
+ * @type {string}
746
+ * @memberof UpdateFulfillmentRequest
747
+ */
748
+ 'fulfillerId'?: string;
749
+ }
606
750
  /**
607
751
  *
608
752
  * @export
@@ -659,6 +803,36 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
659
803
  * @throws {RequiredError}
660
804
  */
661
805
  exportOrders: (project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
806
+ /**
807
+ * Get a fulfillment for a platform by a given fulfillment ID.
808
+ * @summary Get fulfillment
809
+ * @param {string} project Project unique identifier
810
+ * @param {string} platformId The platform identifier
811
+ * @param {string} fulfillmentId The fulfillment identifier
812
+ * @param {*} [options] Override http request option.
813
+ * @throws {RequiredError}
814
+ */
815
+ getFulfillment: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
816
+ /**
817
+ * Get an order for a platform by a given order ID.
818
+ * @summary Get order
819
+ * @param {string} project Project unique identifier
820
+ * @param {string} platformId The platform identifier
821
+ * @param {string} orderId The order identifier
822
+ * @param {*} [options] Override http request option.
823
+ * @throws {RequiredError}
824
+ */
825
+ getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
826
+ /**
827
+ * List available fulfillers for a given fulfillment
828
+ * @summary List available fulfillers
829
+ * @param {string} project Project unique identifier
830
+ * @param {string} platformId The platform identifier
831
+ * @param {string} fulfillmentId The fulfillment identifier
832
+ * @param {*} [options] Override http request option.
833
+ * @throws {RequiredError}
834
+ */
835
+ listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
662
836
  /**
663
837
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
664
838
  * @summary List orders
@@ -673,6 +847,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
673
847
  * @throws {RequiredError}
674
848
  */
675
849
  listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
850
+ /**
851
+ * Update a fulfillment that belongs to an order placed through the platform
852
+ * @summary Update fulfillment
853
+ * @param {string} project Project unique identifier
854
+ * @param {string} platformId The platform identifier
855
+ * @param {string} fulfillmentId The fulfillment identifier
856
+ * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
857
+ * @param {*} [options] Override http request option.
858
+ * @throws {RequiredError}
859
+ */
860
+ updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
676
861
  };
677
862
  /**
678
863
  * OrdersApi - functional programming interface
@@ -690,6 +875,36 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
690
875
  * @throws {RequiredError}
691
876
  */
692
877
  exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
878
+ /**
879
+ * Get a fulfillment for a platform by a given fulfillment ID.
880
+ * @summary Get fulfillment
881
+ * @param {string} project Project unique identifier
882
+ * @param {string} platformId The platform identifier
883
+ * @param {string} fulfillmentId The fulfillment identifier
884
+ * @param {*} [options] Override http request option.
885
+ * @throws {RequiredError}
886
+ */
887
+ getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
888
+ /**
889
+ * Get an order for a platform by a given order ID.
890
+ * @summary Get order
891
+ * @param {string} project Project unique identifier
892
+ * @param {string} platformId The platform identifier
893
+ * @param {string} orderId The order identifier
894
+ * @param {*} [options] Override http request option.
895
+ * @throws {RequiredError}
896
+ */
897
+ getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
898
+ /**
899
+ * List available fulfillers for a given fulfillment
900
+ * @summary List available fulfillers
901
+ * @param {string} project Project unique identifier
902
+ * @param {string} platformId The platform identifier
903
+ * @param {string} fulfillmentId The fulfillment identifier
904
+ * @param {*} [options] Override http request option.
905
+ * @throws {RequiredError}
906
+ */
907
+ listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
693
908
  /**
694
909
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
695
910
  * @summary List orders
@@ -704,6 +919,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
704
919
  * @throws {RequiredError}
705
920
  */
706
921
  listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
922
+ /**
923
+ * Update a fulfillment that belongs to an order placed through the platform
924
+ * @summary Update fulfillment
925
+ * @param {string} project Project unique identifier
926
+ * @param {string} platformId The platform identifier
927
+ * @param {string} fulfillmentId The fulfillment identifier
928
+ * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
929
+ * @param {*} [options] Override http request option.
930
+ * @throws {RequiredError}
931
+ */
932
+ updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
707
933
  };
708
934
  /**
709
935
  * OrdersApi - factory interface
@@ -718,6 +944,30 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
718
944
  * @throws {RequiredError}
719
945
  */
720
946
  exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
947
+ /**
948
+ * Get a fulfillment for a platform by a given fulfillment ID.
949
+ * @summary Get fulfillment
950
+ * @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
951
+ * @param {*} [options] Override http request option.
952
+ * @throws {RequiredError}
953
+ */
954
+ getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
955
+ /**
956
+ * Get an order for a platform by a given order ID.
957
+ * @summary Get order
958
+ * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
959
+ * @param {*} [options] Override http request option.
960
+ * @throws {RequiredError}
961
+ */
962
+ getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
963
+ /**
964
+ * List available fulfillers for a given fulfillment
965
+ * @summary List available fulfillers
966
+ * @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
967
+ * @param {*} [options] Override http request option.
968
+ * @throws {RequiredError}
969
+ */
970
+ listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
721
971
  /**
722
972
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
723
973
  * @summary List orders
@@ -726,6 +976,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
726
976
  * @throws {RequiredError}
727
977
  */
728
978
  listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
979
+ /**
980
+ * Update a fulfillment that belongs to an order placed through the platform
981
+ * @summary Update fulfillment
982
+ * @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
983
+ * @param {*} [options] Override http request option.
984
+ * @throws {RequiredError}
985
+ */
986
+ updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
729
987
  };
730
988
  /**
731
989
  * Request parameters for exportOrders operation in OrdersApi.
@@ -758,6 +1016,81 @@ export interface OrdersApiExportOrdersRequest {
758
1016
  */
759
1017
  readonly end?: string;
760
1018
  }
1019
+ /**
1020
+ * Request parameters for getFulfillment operation in OrdersApi.
1021
+ * @export
1022
+ * @interface OrdersApiGetFulfillmentRequest
1023
+ */
1024
+ export interface OrdersApiGetFulfillmentRequest {
1025
+ /**
1026
+ * Project unique identifier
1027
+ * @type {string}
1028
+ * @memberof OrdersApiGetFulfillment
1029
+ */
1030
+ readonly project: string;
1031
+ /**
1032
+ * The platform identifier
1033
+ * @type {string}
1034
+ * @memberof OrdersApiGetFulfillment
1035
+ */
1036
+ readonly platformId: string;
1037
+ /**
1038
+ * The fulfillment identifier
1039
+ * @type {string}
1040
+ * @memberof OrdersApiGetFulfillment
1041
+ */
1042
+ readonly fulfillmentId: string;
1043
+ }
1044
+ /**
1045
+ * Request parameters for getOrder operation in OrdersApi.
1046
+ * @export
1047
+ * @interface OrdersApiGetOrderRequest
1048
+ */
1049
+ export interface OrdersApiGetOrderRequest {
1050
+ /**
1051
+ * Project unique identifier
1052
+ * @type {string}
1053
+ * @memberof OrdersApiGetOrder
1054
+ */
1055
+ readonly project: string;
1056
+ /**
1057
+ * The platform identifier
1058
+ * @type {string}
1059
+ * @memberof OrdersApiGetOrder
1060
+ */
1061
+ readonly platformId: string;
1062
+ /**
1063
+ * The order identifier
1064
+ * @type {string}
1065
+ * @memberof OrdersApiGetOrder
1066
+ */
1067
+ readonly orderId: string;
1068
+ }
1069
+ /**
1070
+ * Request parameters for listAvailableFulfillers operation in OrdersApi.
1071
+ * @export
1072
+ * @interface OrdersApiListAvailableFulfillersRequest
1073
+ */
1074
+ export interface OrdersApiListAvailableFulfillersRequest {
1075
+ /**
1076
+ * Project unique identifier
1077
+ * @type {string}
1078
+ * @memberof OrdersApiListAvailableFulfillers
1079
+ */
1080
+ readonly project: string;
1081
+ /**
1082
+ * The platform identifier
1083
+ * @type {string}
1084
+ * @memberof OrdersApiListAvailableFulfillers
1085
+ */
1086
+ readonly platformId: string;
1087
+ /**
1088
+ * The fulfillment identifier
1089
+ * @type {string}
1090
+ * @memberof OrdersApiListAvailableFulfillers
1091
+ */
1092
+ readonly fulfillmentId: string;
1093
+ }
761
1094
  /**
762
1095
  * Request parameters for listOrders operation in OrdersApi.
763
1096
  * @export
@@ -807,6 +1140,37 @@ export interface OrdersApiListOrdersRequest {
807
1140
  */
808
1141
  readonly end?: string;
809
1142
  }
1143
+ /**
1144
+ * Request parameters for updateFulfillment operation in OrdersApi.
1145
+ * @export
1146
+ * @interface OrdersApiUpdateFulfillmentRequest
1147
+ */
1148
+ export interface OrdersApiUpdateFulfillmentRequest {
1149
+ /**
1150
+ * Project unique identifier
1151
+ * @type {string}
1152
+ * @memberof OrdersApiUpdateFulfillment
1153
+ */
1154
+ readonly project: string;
1155
+ /**
1156
+ * The platform identifier
1157
+ * @type {string}
1158
+ * @memberof OrdersApiUpdateFulfillment
1159
+ */
1160
+ readonly platformId: string;
1161
+ /**
1162
+ * The fulfillment identifier
1163
+ * @type {string}
1164
+ * @memberof OrdersApiUpdateFulfillment
1165
+ */
1166
+ readonly fulfillmentId: string;
1167
+ /**
1168
+ *
1169
+ * @type {UpdateFulfillmentRequest}
1170
+ * @memberof OrdersApiUpdateFulfillment
1171
+ */
1172
+ readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
1173
+ }
810
1174
  /**
811
1175
  * OrdersApi - object-oriented interface
812
1176
  * @export
@@ -823,6 +1187,33 @@ export declare class OrdersApi extends BaseAPI {
823
1187
  * @memberof OrdersApi
824
1188
  */
825
1189
  exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
1190
+ /**
1191
+ * Get a fulfillment for a platform by a given fulfillment ID.
1192
+ * @summary Get fulfillment
1193
+ * @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
1194
+ * @param {*} [options] Override http request option.
1195
+ * @throws {RequiredError}
1196
+ * @memberof OrdersApi
1197
+ */
1198
+ getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
1199
+ /**
1200
+ * Get an order for a platform by a given order ID.
1201
+ * @summary Get order
1202
+ * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
1203
+ * @param {*} [options] Override http request option.
1204
+ * @throws {RequiredError}
1205
+ * @memberof OrdersApi
1206
+ */
1207
+ getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
1208
+ /**
1209
+ * List available fulfillers for a given fulfillment
1210
+ * @summary List available fulfillers
1211
+ * @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
1212
+ * @param {*} [options] Override http request option.
1213
+ * @throws {RequiredError}
1214
+ * @memberof OrdersApi
1215
+ */
1216
+ listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
826
1217
  /**
827
1218
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
828
1219
  * @summary List orders
@@ -832,6 +1223,15 @@ export declare class OrdersApi extends BaseAPI {
832
1223
  * @memberof OrdersApi
833
1224
  */
834
1225
  listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
1226
+ /**
1227
+ * Update a fulfillment that belongs to an order placed through the platform
1228
+ * @summary Update fulfillment
1229
+ * @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
1230
+ * @param {*} [options] Override http request option.
1231
+ * @throws {RequiredError}
1232
+ * @memberof OrdersApi
1233
+ */
1234
+ updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
835
1235
  }
836
1236
  /**
837
1237
  * PlatformApi - axios parameter creator
@@ -849,6 +1249,26 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
849
1249
  * @throws {RequiredError}
850
1250
  */
851
1251
  exportOrders: (project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1252
+ /**
1253
+ * Get a fulfillment for a platform by a given fulfillment ID.
1254
+ * @summary Get fulfillment
1255
+ * @param {string} project Project unique identifier
1256
+ * @param {string} platformId The platform identifier
1257
+ * @param {string} fulfillmentId The fulfillment identifier
1258
+ * @param {*} [options] Override http request option.
1259
+ * @throws {RequiredError}
1260
+ */
1261
+ getFulfillment: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1262
+ /**
1263
+ * Get an order for a platform by a given order ID.
1264
+ * @summary Get order
1265
+ * @param {string} project Project unique identifier
1266
+ * @param {string} platformId The platform identifier
1267
+ * @param {string} orderId The order identifier
1268
+ * @param {*} [options] Override http request option.
1269
+ * @throws {RequiredError}
1270
+ */
1271
+ getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
852
1272
  /**
853
1273
  *
854
1274
  * @summary Get platform details
@@ -857,6 +1277,16 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
857
1277
  * @throws {RequiredError}
858
1278
  */
859
1279
  getPlatform: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1280
+ /**
1281
+ * List available fulfillers for a given fulfillment
1282
+ * @summary List available fulfillers
1283
+ * @param {string} project Project unique identifier
1284
+ * @param {string} platformId The platform identifier
1285
+ * @param {string} fulfillmentId The fulfillment identifier
1286
+ * @param {*} [options] Override http request option.
1287
+ * @throws {RequiredError}
1288
+ */
1289
+ listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
860
1290
  /**
861
1291
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
862
1292
  * @summary List orders
@@ -871,6 +1301,17 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
871
1301
  * @throws {RequiredError}
872
1302
  */
873
1303
  listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1304
+ /**
1305
+ * Update a fulfillment that belongs to an order placed through the platform
1306
+ * @summary Update fulfillment
1307
+ * @param {string} project Project unique identifier
1308
+ * @param {string} platformId The platform identifier
1309
+ * @param {string} fulfillmentId The fulfillment identifier
1310
+ * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
1311
+ * @param {*} [options] Override http request option.
1312
+ * @throws {RequiredError}
1313
+ */
1314
+ updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
874
1315
  /**
875
1316
  *
876
1317
  * @summary Update platform
@@ -897,6 +1338,26 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
897
1338
  * @throws {RequiredError}
898
1339
  */
899
1340
  exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1341
+ /**
1342
+ * Get a fulfillment for a platform by a given fulfillment ID.
1343
+ * @summary Get fulfillment
1344
+ * @param {string} project Project unique identifier
1345
+ * @param {string} platformId The platform identifier
1346
+ * @param {string} fulfillmentId The fulfillment identifier
1347
+ * @param {*} [options] Override http request option.
1348
+ * @throws {RequiredError}
1349
+ */
1350
+ getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
1351
+ /**
1352
+ * Get an order for a platform by a given order ID.
1353
+ * @summary Get order
1354
+ * @param {string} project Project unique identifier
1355
+ * @param {string} platformId The platform identifier
1356
+ * @param {string} orderId The order identifier
1357
+ * @param {*} [options] Override http request option.
1358
+ * @throws {RequiredError}
1359
+ */
1360
+ getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
900
1361
  /**
901
1362
  *
902
1363
  * @summary Get platform details
@@ -905,6 +1366,16 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
905
1366
  * @throws {RequiredError}
906
1367
  */
907
1368
  getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
1369
+ /**
1370
+ * List available fulfillers for a given fulfillment
1371
+ * @summary List available fulfillers
1372
+ * @param {string} project Project unique identifier
1373
+ * @param {string} platformId The platform identifier
1374
+ * @param {string} fulfillmentId The fulfillment identifier
1375
+ * @param {*} [options] Override http request option.
1376
+ * @throws {RequiredError}
1377
+ */
1378
+ listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
908
1379
  /**
909
1380
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
910
1381
  * @summary List orders
@@ -919,6 +1390,17 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
919
1390
  * @throws {RequiredError}
920
1391
  */
921
1392
  listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
1393
+ /**
1394
+ * Update a fulfillment that belongs to an order placed through the platform
1395
+ * @summary Update fulfillment
1396
+ * @param {string} project Project unique identifier
1397
+ * @param {string} platformId The platform identifier
1398
+ * @param {string} fulfillmentId The fulfillment identifier
1399
+ * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
1400
+ * @param {*} [options] Override http request option.
1401
+ * @throws {RequiredError}
1402
+ */
1403
+ updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
922
1404
  /**
923
1405
  *
924
1406
  * @summary Update platform
@@ -942,6 +1424,22 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
942
1424
  * @throws {RequiredError}
943
1425
  */
944
1426
  exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1427
+ /**
1428
+ * Get a fulfillment for a platform by a given fulfillment ID.
1429
+ * @summary Get fulfillment
1430
+ * @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
1431
+ * @param {*} [options] Override http request option.
1432
+ * @throws {RequiredError}
1433
+ */
1434
+ getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
1435
+ /**
1436
+ * Get an order for a platform by a given order ID.
1437
+ * @summary Get order
1438
+ * @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
1439
+ * @param {*} [options] Override http request option.
1440
+ * @throws {RequiredError}
1441
+ */
1442
+ getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
945
1443
  /**
946
1444
  *
947
1445
  * @summary Get platform details
@@ -950,6 +1448,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
950
1448
  * @throws {RequiredError}
951
1449
  */
952
1450
  getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
1451
+ /**
1452
+ * List available fulfillers for a given fulfillment
1453
+ * @summary List available fulfillers
1454
+ * @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
1455
+ * @param {*} [options] Override http request option.
1456
+ * @throws {RequiredError}
1457
+ */
1458
+ listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
953
1459
  /**
954
1460
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
955
1461
  * @summary List orders
@@ -958,6 +1464,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
958
1464
  * @throws {RequiredError}
959
1465
  */
960
1466
  listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
1467
+ /**
1468
+ * Update a fulfillment that belongs to an order placed through the platform
1469
+ * @summary Update fulfillment
1470
+ * @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
1471
+ * @param {*} [options] Override http request option.
1472
+ * @throws {RequiredError}
1473
+ */
1474
+ updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
961
1475
  /**
962
1476
  *
963
1477
  * @summary Update platform
@@ -998,6 +1512,56 @@ export interface PlatformApiExportOrdersRequest {
998
1512
  */
999
1513
  readonly end?: string;
1000
1514
  }
1515
+ /**
1516
+ * Request parameters for getFulfillment operation in PlatformApi.
1517
+ * @export
1518
+ * @interface PlatformApiGetFulfillmentRequest
1519
+ */
1520
+ export interface PlatformApiGetFulfillmentRequest {
1521
+ /**
1522
+ * Project unique identifier
1523
+ * @type {string}
1524
+ * @memberof PlatformApiGetFulfillment
1525
+ */
1526
+ readonly project: string;
1527
+ /**
1528
+ * The platform identifier
1529
+ * @type {string}
1530
+ * @memberof PlatformApiGetFulfillment
1531
+ */
1532
+ readonly platformId: string;
1533
+ /**
1534
+ * The fulfillment identifier
1535
+ * @type {string}
1536
+ * @memberof PlatformApiGetFulfillment
1537
+ */
1538
+ readonly fulfillmentId: string;
1539
+ }
1540
+ /**
1541
+ * Request parameters for getOrder operation in PlatformApi.
1542
+ * @export
1543
+ * @interface PlatformApiGetOrderRequest
1544
+ */
1545
+ export interface PlatformApiGetOrderRequest {
1546
+ /**
1547
+ * Project unique identifier
1548
+ * @type {string}
1549
+ * @memberof PlatformApiGetOrder
1550
+ */
1551
+ readonly project: string;
1552
+ /**
1553
+ * The platform identifier
1554
+ * @type {string}
1555
+ * @memberof PlatformApiGetOrder
1556
+ */
1557
+ readonly platformId: string;
1558
+ /**
1559
+ * The order identifier
1560
+ * @type {string}
1561
+ * @memberof PlatformApiGetOrder
1562
+ */
1563
+ readonly orderId: string;
1564
+ }
1001
1565
  /**
1002
1566
  * Request parameters for getPlatform operation in PlatformApi.
1003
1567
  * @export
@@ -1011,6 +1575,31 @@ export interface PlatformApiGetPlatformRequest {
1011
1575
  */
1012
1576
  readonly project: string;
1013
1577
  }
1578
+ /**
1579
+ * Request parameters for listAvailableFulfillers operation in PlatformApi.
1580
+ * @export
1581
+ * @interface PlatformApiListAvailableFulfillersRequest
1582
+ */
1583
+ export interface PlatformApiListAvailableFulfillersRequest {
1584
+ /**
1585
+ * Project unique identifier
1586
+ * @type {string}
1587
+ * @memberof PlatformApiListAvailableFulfillers
1588
+ */
1589
+ readonly project: string;
1590
+ /**
1591
+ * The platform identifier
1592
+ * @type {string}
1593
+ * @memberof PlatformApiListAvailableFulfillers
1594
+ */
1595
+ readonly platformId: string;
1596
+ /**
1597
+ * The fulfillment identifier
1598
+ * @type {string}
1599
+ * @memberof PlatformApiListAvailableFulfillers
1600
+ */
1601
+ readonly fulfillmentId: string;
1602
+ }
1014
1603
  /**
1015
1604
  * Request parameters for listOrders operation in PlatformApi.
1016
1605
  * @export
@@ -1060,6 +1649,37 @@ export interface PlatformApiListOrdersRequest {
1060
1649
  */
1061
1650
  readonly end?: string;
1062
1651
  }
1652
+ /**
1653
+ * Request parameters for updateFulfillment operation in PlatformApi.
1654
+ * @export
1655
+ * @interface PlatformApiUpdateFulfillmentRequest
1656
+ */
1657
+ export interface PlatformApiUpdateFulfillmentRequest {
1658
+ /**
1659
+ * Project unique identifier
1660
+ * @type {string}
1661
+ * @memberof PlatformApiUpdateFulfillment
1662
+ */
1663
+ readonly project: string;
1664
+ /**
1665
+ * The platform identifier
1666
+ * @type {string}
1667
+ * @memberof PlatformApiUpdateFulfillment
1668
+ */
1669
+ readonly platformId: string;
1670
+ /**
1671
+ * The fulfillment identifier
1672
+ * @type {string}
1673
+ * @memberof PlatformApiUpdateFulfillment
1674
+ */
1675
+ readonly fulfillmentId: string;
1676
+ /**
1677
+ *
1678
+ * @type {UpdateFulfillmentRequest}
1679
+ * @memberof PlatformApiUpdateFulfillment
1680
+ */
1681
+ readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
1682
+ }
1063
1683
  /**
1064
1684
  * Request parameters for updatePlatform operation in PlatformApi.
1065
1685
  * @export
@@ -1095,6 +1715,24 @@ export declare class PlatformApi extends BaseAPI {
1095
1715
  * @memberof PlatformApi
1096
1716
  */
1097
1717
  exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
1718
+ /**
1719
+ * Get a fulfillment for a platform by a given fulfillment ID.
1720
+ * @summary Get fulfillment
1721
+ * @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
1722
+ * @param {*} [options] Override http request option.
1723
+ * @throws {RequiredError}
1724
+ * @memberof PlatformApi
1725
+ */
1726
+ getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
1727
+ /**
1728
+ * Get an order for a platform by a given order ID.
1729
+ * @summary Get order
1730
+ * @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
1731
+ * @param {*} [options] Override http request option.
1732
+ * @throws {RequiredError}
1733
+ * @memberof PlatformApi
1734
+ */
1735
+ getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
1098
1736
  /**
1099
1737
  *
1100
1738
  * @summary Get platform details
@@ -1104,6 +1742,15 @@ export declare class PlatformApi extends BaseAPI {
1104
1742
  * @memberof PlatformApi
1105
1743
  */
1106
1744
  getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
1745
+ /**
1746
+ * List available fulfillers for a given fulfillment
1747
+ * @summary List available fulfillers
1748
+ * @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
1749
+ * @param {*} [options] Override http request option.
1750
+ * @throws {RequiredError}
1751
+ * @memberof PlatformApi
1752
+ */
1753
+ listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
1107
1754
  /**
1108
1755
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1109
1756
  * @summary List orders
@@ -1113,6 +1760,15 @@ export declare class PlatformApi extends BaseAPI {
1113
1760
  * @memberof PlatformApi
1114
1761
  */
1115
1762
  listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
1763
+ /**
1764
+ * Update a fulfillment that belongs to an order placed through the platform
1765
+ * @summary Update fulfillment
1766
+ * @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
1767
+ * @param {*} [options] Override http request option.
1768
+ * @throws {RequiredError}
1769
+ * @memberof PlatformApi
1770
+ */
1771
+ updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
1116
1772
  /**
1117
1773
  *
1118
1774
  * @summary Update platform