@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/dist/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.6.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
@@ -158,10 +215,10 @@ export interface Fulfillment {
158
215
  'status'?: OrderStatus;
159
216
  /**
160
217
  *
161
- * @type {FulfillmentFulfiller}
218
+ * @type {Fulfiller}
162
219
  * @memberof Fulfillment
163
220
  */
164
- 'fulfiller'?: FulfillmentFulfiller;
221
+ 'fulfiller'?: Fulfiller;
165
222
  /**
166
223
  *
167
224
  * @type {Array<FulfillmentItem>}
@@ -193,38 +250,6 @@ export interface Fulfillment {
193
250
  */
194
251
  'packageWeight'?: number;
195
252
  }
196
- /**
197
- * The fulfiller that will be processing this order.
198
- * @export
199
- * @interface FulfillmentFulfiller
200
- */
201
- export interface FulfillmentFulfiller {
202
- /**
203
- *
204
- * @type {FulfillmentFulfillerLocation}
205
- * @memberof FulfillmentFulfiller
206
- */
207
- 'location'?: FulfillmentFulfillerLocation;
208
- }
209
- /**
210
- *
211
- * @export
212
- * @interface FulfillmentFulfillerLocation
213
- */
214
- export interface FulfillmentFulfillerLocation {
215
- /**
216
- *
217
- * @type {string}
218
- * @memberof FulfillmentFulfillerLocation
219
- */
220
- 'city'?: string | null;
221
- /**
222
- *
223
- * @type {string}
224
- * @memberof FulfillmentFulfillerLocation
225
- */
226
- 'country'?: string | null;
227
- }
228
253
  /**
229
254
  *
230
255
  * @export
@@ -709,6 +734,19 @@ export interface StatusHistoryItem {
709
734
  */
710
735
  'createdAt'?: string;
711
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
+ }
712
750
  /**
713
751
  *
714
752
  * @export
@@ -765,6 +803,36 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
765
803
  * @throws {RequiredError}
766
804
  */
767
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>;
768
836
  /**
769
837
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
770
838
  * @summary List orders
@@ -779,6 +847,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
779
847
  * @throws {RequiredError}
780
848
  */
781
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>;
782
861
  };
783
862
  /**
784
863
  * OrdersApi - functional programming interface
@@ -796,6 +875,36 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
796
875
  * @throws {RequiredError}
797
876
  */
798
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>>;
799
908
  /**
800
909
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
801
910
  * @summary List orders
@@ -810,6 +919,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
810
919
  * @throws {RequiredError}
811
920
  */
812
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>>;
813
933
  };
814
934
  /**
815
935
  * OrdersApi - factory interface
@@ -824,6 +944,30 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
824
944
  * @throws {RequiredError}
825
945
  */
826
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>;
827
971
  /**
828
972
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
829
973
  * @summary List orders
@@ -832,6 +976,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
832
976
  * @throws {RequiredError}
833
977
  */
834
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>;
835
987
  };
836
988
  /**
837
989
  * Request parameters for exportOrders operation in OrdersApi.
@@ -864,6 +1016,81 @@ export interface OrdersApiExportOrdersRequest {
864
1016
  */
865
1017
  readonly end?: string;
866
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
+ }
867
1094
  /**
868
1095
  * Request parameters for listOrders operation in OrdersApi.
869
1096
  * @export
@@ -913,6 +1140,37 @@ export interface OrdersApiListOrdersRequest {
913
1140
  */
914
1141
  readonly end?: string;
915
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
+ }
916
1174
  /**
917
1175
  * OrdersApi - object-oriented interface
918
1176
  * @export
@@ -929,6 +1187,33 @@ export declare class OrdersApi extends BaseAPI {
929
1187
  * @memberof OrdersApi
930
1188
  */
931
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>>;
932
1217
  /**
933
1218
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
934
1219
  * @summary List orders
@@ -938,6 +1223,15 @@ export declare class OrdersApi extends BaseAPI {
938
1223
  * @memberof OrdersApi
939
1224
  */
940
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>>;
941
1235
  }
942
1236
  /**
943
1237
  * PlatformApi - axios parameter creator
@@ -955,6 +1249,26 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
955
1249
  * @throws {RequiredError}
956
1250
  */
957
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>;
958
1272
  /**
959
1273
  *
960
1274
  * @summary Get platform details
@@ -963,6 +1277,16 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
963
1277
  * @throws {RequiredError}
964
1278
  */
965
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>;
966
1290
  /**
967
1291
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
968
1292
  * @summary List orders
@@ -977,6 +1301,17 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
977
1301
  * @throws {RequiredError}
978
1302
  */
979
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>;
980
1315
  /**
981
1316
  *
982
1317
  * @summary Update platform
@@ -1003,6 +1338,26 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
1003
1338
  * @throws {RequiredError}
1004
1339
  */
1005
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>>;
1006
1361
  /**
1007
1362
  *
1008
1363
  * @summary Get platform details
@@ -1011,6 +1366,16 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
1011
1366
  * @throws {RequiredError}
1012
1367
  */
1013
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>>;
1014
1379
  /**
1015
1380
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1016
1381
  * @summary List orders
@@ -1025,6 +1390,17 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
1025
1390
  * @throws {RequiredError}
1026
1391
  */
1027
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>>;
1028
1404
  /**
1029
1405
  *
1030
1406
  * @summary Update platform
@@ -1048,6 +1424,22 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
1048
1424
  * @throws {RequiredError}
1049
1425
  */
1050
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>;
1051
1443
  /**
1052
1444
  *
1053
1445
  * @summary Get platform details
@@ -1056,6 +1448,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
1056
1448
  * @throws {RequiredError}
1057
1449
  */
1058
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>;
1059
1459
  /**
1060
1460
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1061
1461
  * @summary List orders
@@ -1064,6 +1464,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
1064
1464
  * @throws {RequiredError}
1065
1465
  */
1066
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>;
1067
1475
  /**
1068
1476
  *
1069
1477
  * @summary Update platform
@@ -1104,6 +1512,56 @@ export interface PlatformApiExportOrdersRequest {
1104
1512
  */
1105
1513
  readonly end?: string;
1106
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
+ }
1107
1565
  /**
1108
1566
  * Request parameters for getPlatform operation in PlatformApi.
1109
1567
  * @export
@@ -1117,6 +1575,31 @@ export interface PlatformApiGetPlatformRequest {
1117
1575
  */
1118
1576
  readonly project: string;
1119
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
+ }
1120
1603
  /**
1121
1604
  * Request parameters for listOrders operation in PlatformApi.
1122
1605
  * @export
@@ -1166,6 +1649,37 @@ export interface PlatformApiListOrdersRequest {
1166
1649
  */
1167
1650
  readonly end?: string;
1168
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
+ }
1169
1683
  /**
1170
1684
  * Request parameters for updatePlatform operation in PlatformApi.
1171
1685
  * @export
@@ -1201,6 +1715,24 @@ export declare class PlatformApi extends BaseAPI {
1201
1715
  * @memberof PlatformApi
1202
1716
  */
1203
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>>;
1204
1736
  /**
1205
1737
  *
1206
1738
  * @summary Get platform details
@@ -1210,6 +1742,15 @@ export declare class PlatformApi extends BaseAPI {
1210
1742
  * @memberof PlatformApi
1211
1743
  */
1212
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>>;
1213
1754
  /**
1214
1755
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
1215
1756
  * @summary List orders
@@ -1219,6 +1760,15 @@ export declare class PlatformApi extends BaseAPI {
1219
1760
  * @memberof PlatformApi
1220
1761
  */
1221
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>>;
1222
1772
  /**
1223
1773
  *
1224
1774
  * @summary Update platform