@teemill/platform 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +1113 -85
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +605 -39
- package/dist/api.js +697 -11
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +605 -39
- package/dist/esm/api.js +697 -11
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/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
|
+
* The version of the OpenAPI document: 0.8.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 {
|
|
218
|
+
* @type {Fulfiller}
|
|
162
219
|
* @memberof Fulfillment
|
|
163
220
|
*/
|
|
164
|
-
'fulfiller'?:
|
|
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
|
|
@@ -761,10 +799,41 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
761
799
|
* @param {string} platformId The platform identifier
|
|
762
800
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
763
801
|
* @param {string} [end] End of date range to filter by when orders were placed
|
|
802
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
803
|
+
* @param {*} [options] Override http request option.
|
|
804
|
+
* @throws {RequiredError}
|
|
805
|
+
*/
|
|
806
|
+
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
807
|
+
/**
|
|
808
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
809
|
+
* @summary Get fulfillment
|
|
810
|
+
* @param {string} project Project unique identifier
|
|
811
|
+
* @param {string} platformId The platform identifier
|
|
812
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
764
813
|
* @param {*} [options] Override http request option.
|
|
765
814
|
* @throws {RequiredError}
|
|
766
815
|
*/
|
|
767
|
-
|
|
816
|
+
getFulfillment: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
817
|
+
/**
|
|
818
|
+
* Get an order for a platform by a given order ID.
|
|
819
|
+
* @summary Get order
|
|
820
|
+
* @param {string} project Project unique identifier
|
|
821
|
+
* @param {string} platformId The platform identifier
|
|
822
|
+
* @param {string} orderId The order identifier
|
|
823
|
+
* @param {*} [options] Override http request option.
|
|
824
|
+
* @throws {RequiredError}
|
|
825
|
+
*/
|
|
826
|
+
getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
827
|
+
/**
|
|
828
|
+
* List available fulfillers for a given fulfillment
|
|
829
|
+
* @summary List available fulfillers
|
|
830
|
+
* @param {string} project Project unique identifier
|
|
831
|
+
* @param {string} platformId The platform identifier
|
|
832
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
833
|
+
* @param {*} [options] Override http request option.
|
|
834
|
+
* @throws {RequiredError}
|
|
835
|
+
*/
|
|
836
|
+
listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
768
837
|
/**
|
|
769
838
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
770
839
|
* @summary List orders
|
|
@@ -779,6 +848,17 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
779
848
|
* @throws {RequiredError}
|
|
780
849
|
*/
|
|
781
850
|
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
851
|
+
/**
|
|
852
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
853
|
+
* @summary Update fulfillment
|
|
854
|
+
* @param {string} project Project unique identifier
|
|
855
|
+
* @param {string} platformId The platform identifier
|
|
856
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
857
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
858
|
+
* @param {*} [options] Override http request option.
|
|
859
|
+
* @throws {RequiredError}
|
|
860
|
+
*/
|
|
861
|
+
updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
782
862
|
};
|
|
783
863
|
/**
|
|
784
864
|
* OrdersApi - functional programming interface
|
|
@@ -792,10 +872,41 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
792
872
|
* @param {string} platformId The platform identifier
|
|
793
873
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
794
874
|
* @param {string} [end] End of date range to filter by when orders were placed
|
|
875
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
876
|
+
* @param {*} [options] Override http request option.
|
|
877
|
+
* @throws {RequiredError}
|
|
878
|
+
*/
|
|
879
|
+
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
880
|
+
/**
|
|
881
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
882
|
+
* @summary Get fulfillment
|
|
883
|
+
* @param {string} project Project unique identifier
|
|
884
|
+
* @param {string} platformId The platform identifier
|
|
885
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
795
886
|
* @param {*} [options] Override http request option.
|
|
796
887
|
* @throws {RequiredError}
|
|
797
888
|
*/
|
|
798
|
-
|
|
889
|
+
getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
890
|
+
/**
|
|
891
|
+
* Get an order for a platform by a given order ID.
|
|
892
|
+
* @summary Get order
|
|
893
|
+
* @param {string} project Project unique identifier
|
|
894
|
+
* @param {string} platformId The platform identifier
|
|
895
|
+
* @param {string} orderId The order identifier
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
900
|
+
/**
|
|
901
|
+
* List available fulfillers for a given fulfillment
|
|
902
|
+
* @summary List available fulfillers
|
|
903
|
+
* @param {string} project Project unique identifier
|
|
904
|
+
* @param {string} platformId The platform identifier
|
|
905
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
906
|
+
* @param {*} [options] Override http request option.
|
|
907
|
+
* @throws {RequiredError}
|
|
908
|
+
*/
|
|
909
|
+
listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
|
|
799
910
|
/**
|
|
800
911
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
801
912
|
* @summary List orders
|
|
@@ -810,6 +921,17 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
810
921
|
* @throws {RequiredError}
|
|
811
922
|
*/
|
|
812
923
|
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
924
|
+
/**
|
|
925
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
926
|
+
* @summary Update fulfillment
|
|
927
|
+
* @param {string} project Project unique identifier
|
|
928
|
+
* @param {string} platformId The platform identifier
|
|
929
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
930
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
931
|
+
* @param {*} [options] Override http request option.
|
|
932
|
+
* @throws {RequiredError}
|
|
933
|
+
*/
|
|
934
|
+
updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
813
935
|
};
|
|
814
936
|
/**
|
|
815
937
|
* OrdersApi - factory interface
|
|
@@ -824,6 +946,30 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
824
946
|
* @throws {RequiredError}
|
|
825
947
|
*/
|
|
826
948
|
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
949
|
+
/**
|
|
950
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
951
|
+
* @summary Get fulfillment
|
|
952
|
+
* @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
953
|
+
* @param {*} [options] Override http request option.
|
|
954
|
+
* @throws {RequiredError}
|
|
955
|
+
*/
|
|
956
|
+
getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
957
|
+
/**
|
|
958
|
+
* Get an order for a platform by a given order ID.
|
|
959
|
+
* @summary Get order
|
|
960
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
961
|
+
* @param {*} [options] Override http request option.
|
|
962
|
+
* @throws {RequiredError}
|
|
963
|
+
*/
|
|
964
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
965
|
+
/**
|
|
966
|
+
* List available fulfillers for a given fulfillment
|
|
967
|
+
* @summary List available fulfillers
|
|
968
|
+
* @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
969
|
+
* @param {*} [options] Override http request option.
|
|
970
|
+
* @throws {RequiredError}
|
|
971
|
+
*/
|
|
972
|
+
listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
|
|
827
973
|
/**
|
|
828
974
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
829
975
|
* @summary List orders
|
|
@@ -832,6 +978,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
832
978
|
* @throws {RequiredError}
|
|
833
979
|
*/
|
|
834
980
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
981
|
+
/**
|
|
982
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
983
|
+
* @summary Update fulfillment
|
|
984
|
+
* @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
985
|
+
* @param {*} [options] Override http request option.
|
|
986
|
+
* @throws {RequiredError}
|
|
987
|
+
*/
|
|
988
|
+
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
835
989
|
};
|
|
836
990
|
/**
|
|
837
991
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
@@ -863,6 +1017,87 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
863
1017
|
* @memberof OrdersApiExportOrders
|
|
864
1018
|
*/
|
|
865
1019
|
readonly end?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
* Search term to filter based on order reference, customer name and email
|
|
1022
|
+
* @type {string}
|
|
1023
|
+
* @memberof OrdersApiExportOrders
|
|
1024
|
+
*/
|
|
1025
|
+
readonly search?: string;
|
|
1026
|
+
}
|
|
1027
|
+
/**
|
|
1028
|
+
* Request parameters for getFulfillment operation in OrdersApi.
|
|
1029
|
+
* @export
|
|
1030
|
+
* @interface OrdersApiGetFulfillmentRequest
|
|
1031
|
+
*/
|
|
1032
|
+
export interface OrdersApiGetFulfillmentRequest {
|
|
1033
|
+
/**
|
|
1034
|
+
* Project unique identifier
|
|
1035
|
+
* @type {string}
|
|
1036
|
+
* @memberof OrdersApiGetFulfillment
|
|
1037
|
+
*/
|
|
1038
|
+
readonly project: string;
|
|
1039
|
+
/**
|
|
1040
|
+
* The platform identifier
|
|
1041
|
+
* @type {string}
|
|
1042
|
+
* @memberof OrdersApiGetFulfillment
|
|
1043
|
+
*/
|
|
1044
|
+
readonly platformId: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* The fulfillment identifier
|
|
1047
|
+
* @type {string}
|
|
1048
|
+
* @memberof OrdersApiGetFulfillment
|
|
1049
|
+
*/
|
|
1050
|
+
readonly fulfillmentId: string;
|
|
1051
|
+
}
|
|
1052
|
+
/**
|
|
1053
|
+
* Request parameters for getOrder operation in OrdersApi.
|
|
1054
|
+
* @export
|
|
1055
|
+
* @interface OrdersApiGetOrderRequest
|
|
1056
|
+
*/
|
|
1057
|
+
export interface OrdersApiGetOrderRequest {
|
|
1058
|
+
/**
|
|
1059
|
+
* Project unique identifier
|
|
1060
|
+
* @type {string}
|
|
1061
|
+
* @memberof OrdersApiGetOrder
|
|
1062
|
+
*/
|
|
1063
|
+
readonly project: string;
|
|
1064
|
+
/**
|
|
1065
|
+
* The platform identifier
|
|
1066
|
+
* @type {string}
|
|
1067
|
+
* @memberof OrdersApiGetOrder
|
|
1068
|
+
*/
|
|
1069
|
+
readonly platformId: string;
|
|
1070
|
+
/**
|
|
1071
|
+
* The order identifier
|
|
1072
|
+
* @type {string}
|
|
1073
|
+
* @memberof OrdersApiGetOrder
|
|
1074
|
+
*/
|
|
1075
|
+
readonly orderId: string;
|
|
1076
|
+
}
|
|
1077
|
+
/**
|
|
1078
|
+
* Request parameters for listAvailableFulfillers operation in OrdersApi.
|
|
1079
|
+
* @export
|
|
1080
|
+
* @interface OrdersApiListAvailableFulfillersRequest
|
|
1081
|
+
*/
|
|
1082
|
+
export interface OrdersApiListAvailableFulfillersRequest {
|
|
1083
|
+
/**
|
|
1084
|
+
* Project unique identifier
|
|
1085
|
+
* @type {string}
|
|
1086
|
+
* @memberof OrdersApiListAvailableFulfillers
|
|
1087
|
+
*/
|
|
1088
|
+
readonly project: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* The platform identifier
|
|
1091
|
+
* @type {string}
|
|
1092
|
+
* @memberof OrdersApiListAvailableFulfillers
|
|
1093
|
+
*/
|
|
1094
|
+
readonly platformId: string;
|
|
1095
|
+
/**
|
|
1096
|
+
* The fulfillment identifier
|
|
1097
|
+
* @type {string}
|
|
1098
|
+
* @memberof OrdersApiListAvailableFulfillers
|
|
1099
|
+
*/
|
|
1100
|
+
readonly fulfillmentId: string;
|
|
866
1101
|
}
|
|
867
1102
|
/**
|
|
868
1103
|
* Request parameters for listOrders operation in OrdersApi.
|
|
@@ -913,6 +1148,37 @@ export interface OrdersApiListOrdersRequest {
|
|
|
913
1148
|
*/
|
|
914
1149
|
readonly end?: string;
|
|
915
1150
|
}
|
|
1151
|
+
/**
|
|
1152
|
+
* Request parameters for updateFulfillment operation in OrdersApi.
|
|
1153
|
+
* @export
|
|
1154
|
+
* @interface OrdersApiUpdateFulfillmentRequest
|
|
1155
|
+
*/
|
|
1156
|
+
export interface OrdersApiUpdateFulfillmentRequest {
|
|
1157
|
+
/**
|
|
1158
|
+
* Project unique identifier
|
|
1159
|
+
* @type {string}
|
|
1160
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1161
|
+
*/
|
|
1162
|
+
readonly project: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* The platform identifier
|
|
1165
|
+
* @type {string}
|
|
1166
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1167
|
+
*/
|
|
1168
|
+
readonly platformId: string;
|
|
1169
|
+
/**
|
|
1170
|
+
* The fulfillment identifier
|
|
1171
|
+
* @type {string}
|
|
1172
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1173
|
+
*/
|
|
1174
|
+
readonly fulfillmentId: string;
|
|
1175
|
+
/**
|
|
1176
|
+
*
|
|
1177
|
+
* @type {UpdateFulfillmentRequest}
|
|
1178
|
+
* @memberof OrdersApiUpdateFulfillment
|
|
1179
|
+
*/
|
|
1180
|
+
readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
|
|
1181
|
+
}
|
|
916
1182
|
/**
|
|
917
1183
|
* OrdersApi - object-oriented interface
|
|
918
1184
|
* @export
|
|
@@ -929,6 +1195,33 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
929
1195
|
* @memberof OrdersApi
|
|
930
1196
|
*/
|
|
931
1197
|
exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1200
|
+
* @summary Get fulfillment
|
|
1201
|
+
* @param {OrdersApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
1202
|
+
* @param {*} [options] Override http request option.
|
|
1203
|
+
* @throws {RequiredError}
|
|
1204
|
+
* @memberof OrdersApi
|
|
1205
|
+
*/
|
|
1206
|
+
getFulfillment(requestParameters: OrdersApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
1207
|
+
/**
|
|
1208
|
+
* Get an order for a platform by a given order ID.
|
|
1209
|
+
* @summary Get order
|
|
1210
|
+
* @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
|
|
1211
|
+
* @param {*} [options] Override http request option.
|
|
1212
|
+
* @throws {RequiredError}
|
|
1213
|
+
* @memberof OrdersApi
|
|
1214
|
+
*/
|
|
1215
|
+
getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
1216
|
+
/**
|
|
1217
|
+
* List available fulfillers for a given fulfillment
|
|
1218
|
+
* @summary List available fulfillers
|
|
1219
|
+
* @param {OrdersApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
1220
|
+
* @param {*} [options] Override http request option.
|
|
1221
|
+
* @throws {RequiredError}
|
|
1222
|
+
* @memberof OrdersApi
|
|
1223
|
+
*/
|
|
1224
|
+
listAvailableFulfillers(requestParameters: OrdersApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
|
|
932
1225
|
/**
|
|
933
1226
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
934
1227
|
* @summary List orders
|
|
@@ -938,6 +1231,15 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
938
1231
|
* @memberof OrdersApi
|
|
939
1232
|
*/
|
|
940
1233
|
listOrders(requestParameters: OrdersApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
1234
|
+
/**
|
|
1235
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1236
|
+
* @summary Update fulfillment
|
|
1237
|
+
* @param {OrdersApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
1238
|
+
* @param {*} [options] Override http request option.
|
|
1239
|
+
* @throws {RequiredError}
|
|
1240
|
+
* @memberof OrdersApi
|
|
1241
|
+
*/
|
|
1242
|
+
updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
941
1243
|
}
|
|
942
1244
|
/**
|
|
943
1245
|
* PlatformApi - axios parameter creator
|
|
@@ -951,10 +1253,31 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
951
1253
|
* @param {string} platformId The platform identifier
|
|
952
1254
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
953
1255
|
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1256
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
954
1257
|
* @param {*} [options] Override http request option.
|
|
955
1258
|
* @throws {RequiredError}
|
|
956
1259
|
*/
|
|
957
|
-
exportOrders: (project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1260
|
+
exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1261
|
+
/**
|
|
1262
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1263
|
+
* @summary Get fulfillment
|
|
1264
|
+
* @param {string} project Project unique identifier
|
|
1265
|
+
* @param {string} platformId The platform identifier
|
|
1266
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1267
|
+
* @param {*} [options] Override http request option.
|
|
1268
|
+
* @throws {RequiredError}
|
|
1269
|
+
*/
|
|
1270
|
+
getFulfillment: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1271
|
+
/**
|
|
1272
|
+
* Get an order for a platform by a given order ID.
|
|
1273
|
+
* @summary Get order
|
|
1274
|
+
* @param {string} project Project unique identifier
|
|
1275
|
+
* @param {string} platformId The platform identifier
|
|
1276
|
+
* @param {string} orderId The order identifier
|
|
1277
|
+
* @param {*} [options] Override http request option.
|
|
1278
|
+
* @throws {RequiredError}
|
|
1279
|
+
*/
|
|
1280
|
+
getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
958
1281
|
/**
|
|
959
1282
|
*
|
|
960
1283
|
* @summary Get platform details
|
|
@@ -963,6 +1286,16 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
963
1286
|
* @throws {RequiredError}
|
|
964
1287
|
*/
|
|
965
1288
|
getPlatform: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1289
|
+
/**
|
|
1290
|
+
* List available fulfillers for a given fulfillment
|
|
1291
|
+
* @summary List available fulfillers
|
|
1292
|
+
* @param {string} project Project unique identifier
|
|
1293
|
+
* @param {string} platformId The platform identifier
|
|
1294
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1295
|
+
* @param {*} [options] Override http request option.
|
|
1296
|
+
* @throws {RequiredError}
|
|
1297
|
+
*/
|
|
1298
|
+
listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
966
1299
|
/**
|
|
967
1300
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
968
1301
|
* @summary List orders
|
|
@@ -977,6 +1310,17 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
977
1310
|
* @throws {RequiredError}
|
|
978
1311
|
*/
|
|
979
1312
|
listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1313
|
+
/**
|
|
1314
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1315
|
+
* @summary Update fulfillment
|
|
1316
|
+
* @param {string} project Project unique identifier
|
|
1317
|
+
* @param {string} platformId The platform identifier
|
|
1318
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1319
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
1320
|
+
* @param {*} [options] Override http request option.
|
|
1321
|
+
* @throws {RequiredError}
|
|
1322
|
+
*/
|
|
1323
|
+
updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
980
1324
|
/**
|
|
981
1325
|
*
|
|
982
1326
|
* @summary Update platform
|
|
@@ -999,10 +1343,31 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
999
1343
|
* @param {string} platformId The platform identifier
|
|
1000
1344
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1001
1345
|
* @param {string} [end] End of date range to filter by when orders were placed
|
|
1346
|
+
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1002
1347
|
* @param {*} [options] Override http request option.
|
|
1003
1348
|
* @throws {RequiredError}
|
|
1004
1349
|
*/
|
|
1005
|
-
exportOrders(project: string, platformId: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1350
|
+
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1351
|
+
/**
|
|
1352
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1353
|
+
* @summary Get fulfillment
|
|
1354
|
+
* @param {string} project Project unique identifier
|
|
1355
|
+
* @param {string} platformId The platform identifier
|
|
1356
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1357
|
+
* @param {*} [options] Override http request option.
|
|
1358
|
+
* @throws {RequiredError}
|
|
1359
|
+
*/
|
|
1360
|
+
getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
1361
|
+
/**
|
|
1362
|
+
* Get an order for a platform by a given order ID.
|
|
1363
|
+
* @summary Get order
|
|
1364
|
+
* @param {string} project Project unique identifier
|
|
1365
|
+
* @param {string} platformId The platform identifier
|
|
1366
|
+
* @param {string} orderId The order identifier
|
|
1367
|
+
* @param {*} [options] Override http request option.
|
|
1368
|
+
* @throws {RequiredError}
|
|
1369
|
+
*/
|
|
1370
|
+
getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
1006
1371
|
/**
|
|
1007
1372
|
*
|
|
1008
1373
|
* @summary Get platform details
|
|
@@ -1011,6 +1376,16 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
1011
1376
|
* @throws {RequiredError}
|
|
1012
1377
|
*/
|
|
1013
1378
|
getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
1379
|
+
/**
|
|
1380
|
+
* List available fulfillers for a given fulfillment
|
|
1381
|
+
* @summary List available fulfillers
|
|
1382
|
+
* @param {string} project Project unique identifier
|
|
1383
|
+
* @param {string} platformId The platform identifier
|
|
1384
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1385
|
+
* @param {*} [options] Override http request option.
|
|
1386
|
+
* @throws {RequiredError}
|
|
1387
|
+
*/
|
|
1388
|
+
listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
|
|
1014
1389
|
/**
|
|
1015
1390
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1016
1391
|
* @summary List orders
|
|
@@ -1025,6 +1400,17 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
|
1025
1400
|
* @throws {RequiredError}
|
|
1026
1401
|
*/
|
|
1027
1402
|
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
1403
|
+
/**
|
|
1404
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1405
|
+
* @summary Update fulfillment
|
|
1406
|
+
* @param {string} project Project unique identifier
|
|
1407
|
+
* @param {string} platformId The platform identifier
|
|
1408
|
+
* @param {string} fulfillmentId The fulfillment identifier
|
|
1409
|
+
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
1410
|
+
* @param {*} [options] Override http request option.
|
|
1411
|
+
* @throws {RequiredError}
|
|
1412
|
+
*/
|
|
1413
|
+
updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
1028
1414
|
/**
|
|
1029
1415
|
*
|
|
1030
1416
|
* @summary Update platform
|
|
@@ -1048,6 +1434,22 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
1048
1434
|
* @throws {RequiredError}
|
|
1049
1435
|
*/
|
|
1050
1436
|
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
1437
|
+
/**
|
|
1438
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1439
|
+
* @summary Get fulfillment
|
|
1440
|
+
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
1441
|
+
* @param {*} [options] Override http request option.
|
|
1442
|
+
* @throws {RequiredError}
|
|
1443
|
+
*/
|
|
1444
|
+
getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Get an order for a platform by a given order ID.
|
|
1447
|
+
* @summary Get order
|
|
1448
|
+
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
1449
|
+
* @param {*} [options] Override http request option.
|
|
1450
|
+
* @throws {RequiredError}
|
|
1451
|
+
*/
|
|
1452
|
+
getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
1051
1453
|
/**
|
|
1052
1454
|
*
|
|
1053
1455
|
* @summary Get platform details
|
|
@@ -1056,6 +1458,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
1056
1458
|
* @throws {RequiredError}
|
|
1057
1459
|
*/
|
|
1058
1460
|
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
|
|
1461
|
+
/**
|
|
1462
|
+
* List available fulfillers for a given fulfillment
|
|
1463
|
+
* @summary List available fulfillers
|
|
1464
|
+
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
1465
|
+
* @param {*} [options] Override http request option.
|
|
1466
|
+
* @throws {RequiredError}
|
|
1467
|
+
*/
|
|
1468
|
+
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
|
|
1059
1469
|
/**
|
|
1060
1470
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1061
1471
|
* @summary List orders
|
|
@@ -1064,6 +1474,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
|
|
|
1064
1474
|
* @throws {RequiredError}
|
|
1065
1475
|
*/
|
|
1066
1476
|
listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
1477
|
+
/**
|
|
1478
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1479
|
+
* @summary Update fulfillment
|
|
1480
|
+
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
1481
|
+
* @param {*} [options] Override http request option.
|
|
1482
|
+
* @throws {RequiredError}
|
|
1483
|
+
*/
|
|
1484
|
+
updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
1067
1485
|
/**
|
|
1068
1486
|
*
|
|
1069
1487
|
* @summary Update platform
|
|
@@ -1103,6 +1521,62 @@ export interface PlatformApiExportOrdersRequest {
|
|
|
1103
1521
|
* @memberof PlatformApiExportOrders
|
|
1104
1522
|
*/
|
|
1105
1523
|
readonly end?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* Search term to filter based on order reference, customer name and email
|
|
1526
|
+
* @type {string}
|
|
1527
|
+
* @memberof PlatformApiExportOrders
|
|
1528
|
+
*/
|
|
1529
|
+
readonly search?: string;
|
|
1530
|
+
}
|
|
1531
|
+
/**
|
|
1532
|
+
* Request parameters for getFulfillment operation in PlatformApi.
|
|
1533
|
+
* @export
|
|
1534
|
+
* @interface PlatformApiGetFulfillmentRequest
|
|
1535
|
+
*/
|
|
1536
|
+
export interface PlatformApiGetFulfillmentRequest {
|
|
1537
|
+
/**
|
|
1538
|
+
* Project unique identifier
|
|
1539
|
+
* @type {string}
|
|
1540
|
+
* @memberof PlatformApiGetFulfillment
|
|
1541
|
+
*/
|
|
1542
|
+
readonly project: string;
|
|
1543
|
+
/**
|
|
1544
|
+
* The platform identifier
|
|
1545
|
+
* @type {string}
|
|
1546
|
+
* @memberof PlatformApiGetFulfillment
|
|
1547
|
+
*/
|
|
1548
|
+
readonly platformId: string;
|
|
1549
|
+
/**
|
|
1550
|
+
* The fulfillment identifier
|
|
1551
|
+
* @type {string}
|
|
1552
|
+
* @memberof PlatformApiGetFulfillment
|
|
1553
|
+
*/
|
|
1554
|
+
readonly fulfillmentId: string;
|
|
1555
|
+
}
|
|
1556
|
+
/**
|
|
1557
|
+
* Request parameters for getOrder operation in PlatformApi.
|
|
1558
|
+
* @export
|
|
1559
|
+
* @interface PlatformApiGetOrderRequest
|
|
1560
|
+
*/
|
|
1561
|
+
export interface PlatformApiGetOrderRequest {
|
|
1562
|
+
/**
|
|
1563
|
+
* Project unique identifier
|
|
1564
|
+
* @type {string}
|
|
1565
|
+
* @memberof PlatformApiGetOrder
|
|
1566
|
+
*/
|
|
1567
|
+
readonly project: string;
|
|
1568
|
+
/**
|
|
1569
|
+
* The platform identifier
|
|
1570
|
+
* @type {string}
|
|
1571
|
+
* @memberof PlatformApiGetOrder
|
|
1572
|
+
*/
|
|
1573
|
+
readonly platformId: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* The order identifier
|
|
1576
|
+
* @type {string}
|
|
1577
|
+
* @memberof PlatformApiGetOrder
|
|
1578
|
+
*/
|
|
1579
|
+
readonly orderId: string;
|
|
1106
1580
|
}
|
|
1107
1581
|
/**
|
|
1108
1582
|
* Request parameters for getPlatform operation in PlatformApi.
|
|
@@ -1117,6 +1591,31 @@ export interface PlatformApiGetPlatformRequest {
|
|
|
1117
1591
|
*/
|
|
1118
1592
|
readonly project: string;
|
|
1119
1593
|
}
|
|
1594
|
+
/**
|
|
1595
|
+
* Request parameters for listAvailableFulfillers operation in PlatformApi.
|
|
1596
|
+
* @export
|
|
1597
|
+
* @interface PlatformApiListAvailableFulfillersRequest
|
|
1598
|
+
*/
|
|
1599
|
+
export interface PlatformApiListAvailableFulfillersRequest {
|
|
1600
|
+
/**
|
|
1601
|
+
* Project unique identifier
|
|
1602
|
+
* @type {string}
|
|
1603
|
+
* @memberof PlatformApiListAvailableFulfillers
|
|
1604
|
+
*/
|
|
1605
|
+
readonly project: string;
|
|
1606
|
+
/**
|
|
1607
|
+
* The platform identifier
|
|
1608
|
+
* @type {string}
|
|
1609
|
+
* @memberof PlatformApiListAvailableFulfillers
|
|
1610
|
+
*/
|
|
1611
|
+
readonly platformId: string;
|
|
1612
|
+
/**
|
|
1613
|
+
* The fulfillment identifier
|
|
1614
|
+
* @type {string}
|
|
1615
|
+
* @memberof PlatformApiListAvailableFulfillers
|
|
1616
|
+
*/
|
|
1617
|
+
readonly fulfillmentId: string;
|
|
1618
|
+
}
|
|
1120
1619
|
/**
|
|
1121
1620
|
* Request parameters for listOrders operation in PlatformApi.
|
|
1122
1621
|
* @export
|
|
@@ -1166,6 +1665,37 @@ export interface PlatformApiListOrdersRequest {
|
|
|
1166
1665
|
*/
|
|
1167
1666
|
readonly end?: string;
|
|
1168
1667
|
}
|
|
1668
|
+
/**
|
|
1669
|
+
* Request parameters for updateFulfillment operation in PlatformApi.
|
|
1670
|
+
* @export
|
|
1671
|
+
* @interface PlatformApiUpdateFulfillmentRequest
|
|
1672
|
+
*/
|
|
1673
|
+
export interface PlatformApiUpdateFulfillmentRequest {
|
|
1674
|
+
/**
|
|
1675
|
+
* Project unique identifier
|
|
1676
|
+
* @type {string}
|
|
1677
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
1678
|
+
*/
|
|
1679
|
+
readonly project: string;
|
|
1680
|
+
/**
|
|
1681
|
+
* The platform identifier
|
|
1682
|
+
* @type {string}
|
|
1683
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
1684
|
+
*/
|
|
1685
|
+
readonly platformId: string;
|
|
1686
|
+
/**
|
|
1687
|
+
* The fulfillment identifier
|
|
1688
|
+
* @type {string}
|
|
1689
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
1690
|
+
*/
|
|
1691
|
+
readonly fulfillmentId: string;
|
|
1692
|
+
/**
|
|
1693
|
+
*
|
|
1694
|
+
* @type {UpdateFulfillmentRequest}
|
|
1695
|
+
* @memberof PlatformApiUpdateFulfillment
|
|
1696
|
+
*/
|
|
1697
|
+
readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
|
|
1698
|
+
}
|
|
1169
1699
|
/**
|
|
1170
1700
|
* Request parameters for updatePlatform operation in PlatformApi.
|
|
1171
1701
|
* @export
|
|
@@ -1201,6 +1731,24 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
1201
1731
|
* @memberof PlatformApi
|
|
1202
1732
|
*/
|
|
1203
1733
|
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
1734
|
+
/**
|
|
1735
|
+
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
1736
|
+
* @summary Get fulfillment
|
|
1737
|
+
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
1738
|
+
* @param {*} [options] Override http request option.
|
|
1739
|
+
* @throws {RequiredError}
|
|
1740
|
+
* @memberof PlatformApi
|
|
1741
|
+
*/
|
|
1742
|
+
getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
1743
|
+
/**
|
|
1744
|
+
* Get an order for a platform by a given order ID.
|
|
1745
|
+
* @summary Get order
|
|
1746
|
+
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
1747
|
+
* @param {*} [options] Override http request option.
|
|
1748
|
+
* @throws {RequiredError}
|
|
1749
|
+
* @memberof PlatformApi
|
|
1750
|
+
*/
|
|
1751
|
+
getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
1204
1752
|
/**
|
|
1205
1753
|
*
|
|
1206
1754
|
* @summary Get platform details
|
|
@@ -1210,6 +1758,15 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
1210
1758
|
* @memberof PlatformApi
|
|
1211
1759
|
*/
|
|
1212
1760
|
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
1761
|
+
/**
|
|
1762
|
+
* List available fulfillers for a given fulfillment
|
|
1763
|
+
* @summary List available fulfillers
|
|
1764
|
+
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
1765
|
+
* @param {*} [options] Override http request option.
|
|
1766
|
+
* @throws {RequiredError}
|
|
1767
|
+
* @memberof PlatformApi
|
|
1768
|
+
*/
|
|
1769
|
+
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
|
|
1213
1770
|
/**
|
|
1214
1771
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
1215
1772
|
* @summary List orders
|
|
@@ -1219,6 +1776,15 @@ export declare class PlatformApi extends BaseAPI {
|
|
|
1219
1776
|
* @memberof PlatformApi
|
|
1220
1777
|
*/
|
|
1221
1778
|
listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
1779
|
+
/**
|
|
1780
|
+
* Update a fulfillment that belongs to an order placed through the platform
|
|
1781
|
+
* @summary Update fulfillment
|
|
1782
|
+
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
1783
|
+
* @param {*} [options] Override http request option.
|
|
1784
|
+
* @throws {RequiredError}
|
|
1785
|
+
* @memberof PlatformApi
|
|
1786
|
+
*/
|
|
1787
|
+
updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
1222
1788
|
/**
|
|
1223
1789
|
*
|
|
1224
1790
|
* @summary Update platform
|