@teemill/gfn-catalog 2.0.0 → 2.0.3
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/.openapi-generator/FILES +0 -1
- package/.openapi-generator/VERSION +1 -1
- package/README.md +2 -2
- package/api.ts +352 -106
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +301 -88
- package/dist/api.js +60 -108
- 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 +301 -88
- package/dist/esm/api.js +60 -108
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.
|
|
7
|
+
* The version of the OpenAPI document: 2.0.3
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -298,7 +298,7 @@ export interface ProductsResponse {
|
|
|
298
298
|
* @type {number}
|
|
299
299
|
* @memberof ProductsResponse
|
|
300
300
|
*/
|
|
301
|
-
'nextPageToken'?: number;
|
|
301
|
+
'nextPageToken'?: number | null;
|
|
302
302
|
}
|
|
303
303
|
/**
|
|
304
304
|
*
|
|
@@ -373,7 +373,7 @@ export interface StockResponse {
|
|
|
373
373
|
* @type {number}
|
|
374
374
|
* @memberof StockResponse
|
|
375
375
|
*/
|
|
376
|
-
'nextPageToken'?: number;
|
|
376
|
+
'nextPageToken'?: number | null;
|
|
377
377
|
}
|
|
378
378
|
/**
|
|
379
379
|
*
|
|
@@ -584,7 +584,7 @@ export interface VariantsResponse {
|
|
|
584
584
|
* @type {number}
|
|
585
585
|
* @memberof VariantsResponse
|
|
586
586
|
*/
|
|
587
|
-
'nextPageToken'?: number;
|
|
587
|
+
'nextPageToken'?: number | null;
|
|
588
588
|
}
|
|
589
589
|
|
|
590
590
|
/**
|
|
@@ -697,20 +697,58 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
697
697
|
/**
|
|
698
698
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
699
699
|
* @summary List GFN products
|
|
700
|
-
* @param {
|
|
701
|
-
* @param {number} [pageToken] Page reference token
|
|
702
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
703
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
704
|
-
* @param {string} [search] Search terms to filter based on.
|
|
700
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
705
701
|
* @param {*} [options] Override http request option.
|
|
706
702
|
* @throws {RequiredError}
|
|
707
703
|
*/
|
|
708
|
-
listProducts(
|
|
709
|
-
return localVarFp.listProducts(project, pageToken, pageSize, fields, search, options).then((request) => request(axios, basePath));
|
|
704
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse> {
|
|
705
|
+
return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
710
706
|
},
|
|
711
707
|
};
|
|
712
708
|
};
|
|
713
709
|
|
|
710
|
+
/**
|
|
711
|
+
* Request parameters for listProducts operation in ProductsApi.
|
|
712
|
+
* @export
|
|
713
|
+
* @interface ProductsApiListProductsRequest
|
|
714
|
+
*/
|
|
715
|
+
export interface ProductsApiListProductsRequest {
|
|
716
|
+
/**
|
|
717
|
+
* What project it is
|
|
718
|
+
* @type {string}
|
|
719
|
+
* @memberof ProductsApiListProducts
|
|
720
|
+
*/
|
|
721
|
+
readonly project: string
|
|
722
|
+
|
|
723
|
+
/**
|
|
724
|
+
* Page reference token
|
|
725
|
+
* @type {number}
|
|
726
|
+
* @memberof ProductsApiListProducts
|
|
727
|
+
*/
|
|
728
|
+
readonly pageToken?: number
|
|
729
|
+
|
|
730
|
+
/**
|
|
731
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
732
|
+
* @type {number}
|
|
733
|
+
* @memberof ProductsApiListProducts
|
|
734
|
+
*/
|
|
735
|
+
readonly pageSize?: number
|
|
736
|
+
|
|
737
|
+
/**
|
|
738
|
+
* Filter response fields to only include a subset of the resource.
|
|
739
|
+
* @type {string}
|
|
740
|
+
* @memberof ProductsApiListProducts
|
|
741
|
+
*/
|
|
742
|
+
readonly fields?: string
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* Search terms to filter based on.
|
|
746
|
+
* @type {string}
|
|
747
|
+
* @memberof ProductsApiListProducts
|
|
748
|
+
*/
|
|
749
|
+
readonly search?: string
|
|
750
|
+
}
|
|
751
|
+
|
|
714
752
|
/**
|
|
715
753
|
* ProductsApi - object-oriented interface
|
|
716
754
|
* @export
|
|
@@ -721,17 +759,13 @@ export class ProductsApi extends BaseAPI {
|
|
|
721
759
|
/**
|
|
722
760
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
723
761
|
* @summary List GFN products
|
|
724
|
-
* @param {
|
|
725
|
-
* @param {number} [pageToken] Page reference token
|
|
726
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
727
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
728
|
-
* @param {string} [search] Search terms to filter based on.
|
|
762
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
729
763
|
* @param {*} [options] Override http request option.
|
|
730
764
|
* @throws {RequiredError}
|
|
731
765
|
* @memberof ProductsApi
|
|
732
766
|
*/
|
|
733
|
-
public listProducts(
|
|
734
|
-
return ProductsApiFp(this.configuration).listProducts(project, pageToken, pageSize, fields, search, options).then((request) => request(this.axios, this.basePath));
|
|
767
|
+
public listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig) {
|
|
768
|
+
return ProductsApiFp(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
735
769
|
}
|
|
736
770
|
}
|
|
737
771
|
|
|
@@ -903,30 +937,82 @@ export const StatementsApiFactory = function (configuration?: Configuration, bas
|
|
|
903
937
|
/**
|
|
904
938
|
* Gets a GFN statement by the given ID.
|
|
905
939
|
* @summary Get a GFN statement
|
|
906
|
-
* @param {
|
|
907
|
-
* @param {string} statementId
|
|
940
|
+
* @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
|
|
908
941
|
* @param {*} [options] Override http request option.
|
|
909
942
|
* @throws {RequiredError}
|
|
910
943
|
*/
|
|
911
|
-
getStatement(
|
|
912
|
-
return localVarFp.getStatement(project, statementId, options).then((request) => request(axios, basePath));
|
|
944
|
+
getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig): AxiosPromise<Statement> {
|
|
945
|
+
return localVarFp.getStatement(requestParameters.project, requestParameters.statementId, options).then((request) => request(axios, basePath));
|
|
913
946
|
},
|
|
914
947
|
/**
|
|
915
948
|
* Lists GFN statements available to the project
|
|
916
949
|
* @summary List GFN statements
|
|
917
|
-
* @param {
|
|
918
|
-
* @param {number} [pageToken] Page reference token
|
|
919
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
920
|
-
* @param {string} [search] Search term used to filter results by
|
|
950
|
+
* @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
|
|
921
951
|
* @param {*} [options] Override http request option.
|
|
922
952
|
* @throws {RequiredError}
|
|
923
953
|
*/
|
|
924
|
-
listStatements(
|
|
925
|
-
return localVarFp.listStatements(project, pageToken, pageSize, search, options).then((request) => request(axios, basePath));
|
|
954
|
+
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListStatements200Response> {
|
|
955
|
+
return localVarFp.listStatements(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
926
956
|
},
|
|
927
957
|
};
|
|
928
958
|
};
|
|
929
959
|
|
|
960
|
+
/**
|
|
961
|
+
* Request parameters for getStatement operation in StatementsApi.
|
|
962
|
+
* @export
|
|
963
|
+
* @interface StatementsApiGetStatementRequest
|
|
964
|
+
*/
|
|
965
|
+
export interface StatementsApiGetStatementRequest {
|
|
966
|
+
/**
|
|
967
|
+
* What project it is
|
|
968
|
+
* @type {string}
|
|
969
|
+
* @memberof StatementsApiGetStatement
|
|
970
|
+
*/
|
|
971
|
+
readonly project: string
|
|
972
|
+
|
|
973
|
+
/**
|
|
974
|
+
*
|
|
975
|
+
* @type {string}
|
|
976
|
+
* @memberof StatementsApiGetStatement
|
|
977
|
+
*/
|
|
978
|
+
readonly statementId: string
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
/**
|
|
982
|
+
* Request parameters for listStatements operation in StatementsApi.
|
|
983
|
+
* @export
|
|
984
|
+
* @interface StatementsApiListStatementsRequest
|
|
985
|
+
*/
|
|
986
|
+
export interface StatementsApiListStatementsRequest {
|
|
987
|
+
/**
|
|
988
|
+
* What project it is
|
|
989
|
+
* @type {string}
|
|
990
|
+
* @memberof StatementsApiListStatements
|
|
991
|
+
*/
|
|
992
|
+
readonly project: string
|
|
993
|
+
|
|
994
|
+
/**
|
|
995
|
+
* Page reference token
|
|
996
|
+
* @type {number}
|
|
997
|
+
* @memberof StatementsApiListStatements
|
|
998
|
+
*/
|
|
999
|
+
readonly pageToken?: number
|
|
1000
|
+
|
|
1001
|
+
/**
|
|
1002
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1003
|
+
* @type {number}
|
|
1004
|
+
* @memberof StatementsApiListStatements
|
|
1005
|
+
*/
|
|
1006
|
+
readonly pageSize?: number
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* Search term used to filter results by
|
|
1010
|
+
* @type {string}
|
|
1011
|
+
* @memberof StatementsApiListStatements
|
|
1012
|
+
*/
|
|
1013
|
+
readonly search?: string
|
|
1014
|
+
}
|
|
1015
|
+
|
|
930
1016
|
/**
|
|
931
1017
|
* StatementsApi - object-oriented interface
|
|
932
1018
|
* @export
|
|
@@ -937,29 +1023,25 @@ export class StatementsApi extends BaseAPI {
|
|
|
937
1023
|
/**
|
|
938
1024
|
* Gets a GFN statement by the given ID.
|
|
939
1025
|
* @summary Get a GFN statement
|
|
940
|
-
* @param {
|
|
941
|
-
* @param {string} statementId
|
|
1026
|
+
* @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
|
|
942
1027
|
* @param {*} [options] Override http request option.
|
|
943
1028
|
* @throws {RequiredError}
|
|
944
1029
|
* @memberof StatementsApi
|
|
945
1030
|
*/
|
|
946
|
-
public getStatement(
|
|
947
|
-
return StatementsApiFp(this.configuration).getStatement(project, statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1031
|
+
public getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig) {
|
|
1032
|
+
return StatementsApiFp(this.configuration).getStatement(requestParameters.project, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
|
|
948
1033
|
}
|
|
949
1034
|
|
|
950
1035
|
/**
|
|
951
1036
|
* Lists GFN statements available to the project
|
|
952
1037
|
* @summary List GFN statements
|
|
953
|
-
* @param {
|
|
954
|
-
* @param {number} [pageToken] Page reference token
|
|
955
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
956
|
-
* @param {string} [search] Search term used to filter results by
|
|
1038
|
+
* @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
|
|
957
1039
|
* @param {*} [options] Override http request option.
|
|
958
1040
|
* @throws {RequiredError}
|
|
959
1041
|
* @memberof StatementsApi
|
|
960
1042
|
*/
|
|
961
|
-
public listStatements(
|
|
962
|
-
return StatementsApiFp(this.configuration).listStatements(project, pageToken, pageSize, search, options).then((request) => request(this.axios, this.basePath));
|
|
1043
|
+
public listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig) {
|
|
1044
|
+
return StatementsApiFp(this.configuration).listStatements(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
963
1045
|
}
|
|
964
1046
|
}
|
|
965
1047
|
|
|
@@ -1133,30 +1215,82 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b
|
|
|
1133
1215
|
/**
|
|
1134
1216
|
* Exports all GFN transactions available to the project
|
|
1135
1217
|
* @summary Export GFN transactions
|
|
1136
|
-
* @param {
|
|
1137
|
-
* @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
|
|
1218
|
+
* @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
|
|
1138
1219
|
* @param {*} [options] Override http request option.
|
|
1139
1220
|
* @throws {RequiredError}
|
|
1140
1221
|
*/
|
|
1141
|
-
exportTransactions(
|
|
1142
|
-
return localVarFp.exportTransactions(project, exportTransactionsRequest, options).then((request) => request(axios, basePath));
|
|
1222
|
+
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
1223
|
+
return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
|
|
1143
1224
|
},
|
|
1144
1225
|
/**
|
|
1145
1226
|
* Lists all GFN transactions available to the project
|
|
1146
1227
|
* @summary List GFN transactions
|
|
1147
|
-
* @param {
|
|
1148
|
-
* @param {number} [pageToken] Page reference token
|
|
1149
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1150
|
-
* @param {string} [statementId]
|
|
1228
|
+
* @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
|
|
1151
1229
|
* @param {*} [options] Override http request option.
|
|
1152
1230
|
* @throws {RequiredError}
|
|
1153
1231
|
*/
|
|
1154
|
-
listTransactions(
|
|
1155
|
-
return localVarFp.listTransactions(project, pageToken, pageSize, statementId, options).then((request) => request(axios, basePath));
|
|
1232
|
+
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactions200Response> {
|
|
1233
|
+
return localVarFp.listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(axios, basePath));
|
|
1156
1234
|
},
|
|
1157
1235
|
};
|
|
1158
1236
|
};
|
|
1159
1237
|
|
|
1238
|
+
/**
|
|
1239
|
+
* Request parameters for exportTransactions operation in TransactionsApi.
|
|
1240
|
+
* @export
|
|
1241
|
+
* @interface TransactionsApiExportTransactionsRequest
|
|
1242
|
+
*/
|
|
1243
|
+
export interface TransactionsApiExportTransactionsRequest {
|
|
1244
|
+
/**
|
|
1245
|
+
* What project it is
|
|
1246
|
+
* @type {string}
|
|
1247
|
+
* @memberof TransactionsApiExportTransactions
|
|
1248
|
+
*/
|
|
1249
|
+
readonly project: string
|
|
1250
|
+
|
|
1251
|
+
/**
|
|
1252
|
+
* Period selection data for the export
|
|
1253
|
+
* @type {ExportTransactionsRequest}
|
|
1254
|
+
* @memberof TransactionsApiExportTransactions
|
|
1255
|
+
*/
|
|
1256
|
+
readonly exportTransactionsRequest: ExportTransactionsRequest
|
|
1257
|
+
}
|
|
1258
|
+
|
|
1259
|
+
/**
|
|
1260
|
+
* Request parameters for listTransactions operation in TransactionsApi.
|
|
1261
|
+
* @export
|
|
1262
|
+
* @interface TransactionsApiListTransactionsRequest
|
|
1263
|
+
*/
|
|
1264
|
+
export interface TransactionsApiListTransactionsRequest {
|
|
1265
|
+
/**
|
|
1266
|
+
* What project it is
|
|
1267
|
+
* @type {string}
|
|
1268
|
+
* @memberof TransactionsApiListTransactions
|
|
1269
|
+
*/
|
|
1270
|
+
readonly project: string
|
|
1271
|
+
|
|
1272
|
+
/**
|
|
1273
|
+
* Page reference token
|
|
1274
|
+
* @type {number}
|
|
1275
|
+
* @memberof TransactionsApiListTransactions
|
|
1276
|
+
*/
|
|
1277
|
+
readonly pageToken?: number
|
|
1278
|
+
|
|
1279
|
+
/**
|
|
1280
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1281
|
+
* @type {number}
|
|
1282
|
+
* @memberof TransactionsApiListTransactions
|
|
1283
|
+
*/
|
|
1284
|
+
readonly pageSize?: number
|
|
1285
|
+
|
|
1286
|
+
/**
|
|
1287
|
+
*
|
|
1288
|
+
* @type {string}
|
|
1289
|
+
* @memberof TransactionsApiListTransactions
|
|
1290
|
+
*/
|
|
1291
|
+
readonly statementId?: string
|
|
1292
|
+
}
|
|
1293
|
+
|
|
1160
1294
|
/**
|
|
1161
1295
|
* TransactionsApi - object-oriented interface
|
|
1162
1296
|
* @export
|
|
@@ -1167,29 +1301,25 @@ export class TransactionsApi extends BaseAPI {
|
|
|
1167
1301
|
/**
|
|
1168
1302
|
* Exports all GFN transactions available to the project
|
|
1169
1303
|
* @summary Export GFN transactions
|
|
1170
|
-
* @param {
|
|
1171
|
-
* @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
|
|
1304
|
+
* @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
|
|
1172
1305
|
* @param {*} [options] Override http request option.
|
|
1173
1306
|
* @throws {RequiredError}
|
|
1174
1307
|
* @memberof TransactionsApi
|
|
1175
1308
|
*/
|
|
1176
|
-
public exportTransactions(
|
|
1177
|
-
return TransactionsApiFp(this.configuration).exportTransactions(project, exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1309
|
+
public exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig) {
|
|
1310
|
+
return TransactionsApiFp(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
1178
1311
|
}
|
|
1179
1312
|
|
|
1180
1313
|
/**
|
|
1181
1314
|
* Lists all GFN transactions available to the project
|
|
1182
1315
|
* @summary List GFN transactions
|
|
1183
|
-
* @param {
|
|
1184
|
-
* @param {number} [pageToken] Page reference token
|
|
1185
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1186
|
-
* @param {string} [statementId]
|
|
1316
|
+
* @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
|
|
1187
1317
|
* @param {*} [options] Override http request option.
|
|
1188
1318
|
* @throws {RequiredError}
|
|
1189
1319
|
* @memberof TransactionsApi
|
|
1190
1320
|
*/
|
|
1191
|
-
public listTransactions(
|
|
1192
|
-
return TransactionsApiFp(this.configuration).listTransactions(project, pageToken, pageSize, statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1321
|
+
public listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig) {
|
|
1322
|
+
return TransactionsApiFp(this.configuration).listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
|
|
1193
1323
|
}
|
|
1194
1324
|
}
|
|
1195
1325
|
|
|
@@ -1522,58 +1652,186 @@ export const VariantsApiFactory = function (configuration?: Configuration, baseP
|
|
|
1522
1652
|
/**
|
|
1523
1653
|
* Gets the stock level for the GFN variant with the given ID.
|
|
1524
1654
|
* @summary Get GFN variant stock
|
|
1525
|
-
* @param {
|
|
1526
|
-
* @param {string} variantId Variants unique identifier
|
|
1527
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1655
|
+
* @param {VariantsApiGetStockRequest} requestParameters Request parameters.
|
|
1528
1656
|
* @param {*} [options] Override http request option.
|
|
1529
1657
|
* @throws {RequiredError}
|
|
1530
1658
|
*/
|
|
1531
|
-
getStock(
|
|
1532
|
-
return localVarFp.getStock(project, variantId, fulfillmentProjects, options).then((request) => request(axios, basePath));
|
|
1659
|
+
getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantStock> {
|
|
1660
|
+
return localVarFp.getStock(requestParameters.project, requestParameters.variantId, requestParameters.fulfillmentProjects, options).then((request) => request(axios, basePath));
|
|
1533
1661
|
},
|
|
1534
1662
|
/**
|
|
1535
1663
|
* Gets a GFN variant by the given ID.
|
|
1536
1664
|
* @summary Get a GFN variant
|
|
1537
|
-
* @param {
|
|
1538
|
-
* @param {string} variantId Variants unique identifier
|
|
1539
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1665
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1540
1666
|
* @param {*} [options] Override http request option.
|
|
1541
1667
|
* @throws {RequiredError}
|
|
1542
1668
|
*/
|
|
1543
|
-
getVariant(
|
|
1544
|
-
return localVarFp.getVariant(project, variantId, fields, options).then((request) => request(axios, basePath));
|
|
1669
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant> {
|
|
1670
|
+
return localVarFp.getVariant(requestParameters.project, requestParameters.variantId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
1545
1671
|
},
|
|
1546
1672
|
/**
|
|
1547
1673
|
* Lists the stock levels for all GFN variants available to the project.
|
|
1548
1674
|
* @summary List GFN variant stock
|
|
1549
|
-
* @param {
|
|
1550
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1551
|
-
* @param {number} [pageToken] Page reference token
|
|
1552
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1553
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1675
|
+
* @param {VariantsApiListStockRequest} requestParameters Request parameters.
|
|
1554
1676
|
* @param {*} [options] Override http request option.
|
|
1555
1677
|
* @throws {RequiredError}
|
|
1556
1678
|
*/
|
|
1557
|
-
listStock(
|
|
1558
|
-
return localVarFp.listStock(project, fulfillmentProjects, pageToken, pageSize, search, options).then((request) => request(axios, basePath));
|
|
1679
|
+
listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<StockResponse> {
|
|
1680
|
+
return localVarFp.listStock(requestParameters.project, requestParameters.fulfillmentProjects, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1559
1681
|
},
|
|
1560
1682
|
/**
|
|
1561
1683
|
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1562
1684
|
* @summary List GFN variants
|
|
1563
|
-
* @param {
|
|
1564
|
-
* @param {number} [pageToken] Page reference token
|
|
1565
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1566
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1567
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1685
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1568
1686
|
* @param {*} [options] Override http request option.
|
|
1569
1687
|
* @throws {RequiredError}
|
|
1570
1688
|
*/
|
|
1571
|
-
listVariants(
|
|
1572
|
-
return localVarFp.listVariants(project, pageToken, pageSize, fields, search, options).then((request) => request(axios, basePath));
|
|
1689
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse> {
|
|
1690
|
+
return localVarFp.listVariants(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
1573
1691
|
},
|
|
1574
1692
|
};
|
|
1575
1693
|
};
|
|
1576
1694
|
|
|
1695
|
+
/**
|
|
1696
|
+
* Request parameters for getStock operation in VariantsApi.
|
|
1697
|
+
* @export
|
|
1698
|
+
* @interface VariantsApiGetStockRequest
|
|
1699
|
+
*/
|
|
1700
|
+
export interface VariantsApiGetStockRequest {
|
|
1701
|
+
/**
|
|
1702
|
+
* What project it is
|
|
1703
|
+
* @type {string}
|
|
1704
|
+
* @memberof VariantsApiGetStock
|
|
1705
|
+
*/
|
|
1706
|
+
readonly project: string
|
|
1707
|
+
|
|
1708
|
+
/**
|
|
1709
|
+
* Variants unique identifier
|
|
1710
|
+
* @type {string}
|
|
1711
|
+
* @memberof VariantsApiGetStock
|
|
1712
|
+
*/
|
|
1713
|
+
readonly variantId: string
|
|
1714
|
+
|
|
1715
|
+
/**
|
|
1716
|
+
* Fetch stock levels from specific fulfiller projects
|
|
1717
|
+
* @type {string}
|
|
1718
|
+
* @memberof VariantsApiGetStock
|
|
1719
|
+
*/
|
|
1720
|
+
readonly fulfillmentProjects?: string
|
|
1721
|
+
}
|
|
1722
|
+
|
|
1723
|
+
/**
|
|
1724
|
+
* Request parameters for getVariant operation in VariantsApi.
|
|
1725
|
+
* @export
|
|
1726
|
+
* @interface VariantsApiGetVariantRequest
|
|
1727
|
+
*/
|
|
1728
|
+
export interface VariantsApiGetVariantRequest {
|
|
1729
|
+
/**
|
|
1730
|
+
* What project it is
|
|
1731
|
+
* @type {string}
|
|
1732
|
+
* @memberof VariantsApiGetVariant
|
|
1733
|
+
*/
|
|
1734
|
+
readonly project: string
|
|
1735
|
+
|
|
1736
|
+
/**
|
|
1737
|
+
* Variants unique identifier
|
|
1738
|
+
* @type {string}
|
|
1739
|
+
* @memberof VariantsApiGetVariant
|
|
1740
|
+
*/
|
|
1741
|
+
readonly variantId: string
|
|
1742
|
+
|
|
1743
|
+
/**
|
|
1744
|
+
* Filter response fields to only include a subset of the resource.
|
|
1745
|
+
* @type {string}
|
|
1746
|
+
* @memberof VariantsApiGetVariant
|
|
1747
|
+
*/
|
|
1748
|
+
readonly fields?: string
|
|
1749
|
+
}
|
|
1750
|
+
|
|
1751
|
+
/**
|
|
1752
|
+
* Request parameters for listStock operation in VariantsApi.
|
|
1753
|
+
* @export
|
|
1754
|
+
* @interface VariantsApiListStockRequest
|
|
1755
|
+
*/
|
|
1756
|
+
export interface VariantsApiListStockRequest {
|
|
1757
|
+
/**
|
|
1758
|
+
* What project it is
|
|
1759
|
+
* @type {string}
|
|
1760
|
+
* @memberof VariantsApiListStock
|
|
1761
|
+
*/
|
|
1762
|
+
readonly project: string
|
|
1763
|
+
|
|
1764
|
+
/**
|
|
1765
|
+
* Fetch stock levels from specific fulfiller projects
|
|
1766
|
+
* @type {string}
|
|
1767
|
+
* @memberof VariantsApiListStock
|
|
1768
|
+
*/
|
|
1769
|
+
readonly fulfillmentProjects?: string
|
|
1770
|
+
|
|
1771
|
+
/**
|
|
1772
|
+
* Page reference token
|
|
1773
|
+
* @type {number}
|
|
1774
|
+
* @memberof VariantsApiListStock
|
|
1775
|
+
*/
|
|
1776
|
+
readonly pageToken?: number
|
|
1777
|
+
|
|
1778
|
+
/**
|
|
1779
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1780
|
+
* @type {number}
|
|
1781
|
+
* @memberof VariantsApiListStock
|
|
1782
|
+
*/
|
|
1783
|
+
readonly pageSize?: number
|
|
1784
|
+
|
|
1785
|
+
/**
|
|
1786
|
+
* Search terms to filter based on.
|
|
1787
|
+
* @type {string}
|
|
1788
|
+
* @memberof VariantsApiListStock
|
|
1789
|
+
*/
|
|
1790
|
+
readonly search?: string
|
|
1791
|
+
}
|
|
1792
|
+
|
|
1793
|
+
/**
|
|
1794
|
+
* Request parameters for listVariants operation in VariantsApi.
|
|
1795
|
+
* @export
|
|
1796
|
+
* @interface VariantsApiListVariantsRequest
|
|
1797
|
+
*/
|
|
1798
|
+
export interface VariantsApiListVariantsRequest {
|
|
1799
|
+
/**
|
|
1800
|
+
* What project it is
|
|
1801
|
+
* @type {string}
|
|
1802
|
+
* @memberof VariantsApiListVariants
|
|
1803
|
+
*/
|
|
1804
|
+
readonly project: string
|
|
1805
|
+
|
|
1806
|
+
/**
|
|
1807
|
+
* Page reference token
|
|
1808
|
+
* @type {number}
|
|
1809
|
+
* @memberof VariantsApiListVariants
|
|
1810
|
+
*/
|
|
1811
|
+
readonly pageToken?: number
|
|
1812
|
+
|
|
1813
|
+
/**
|
|
1814
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1815
|
+
* @type {number}
|
|
1816
|
+
* @memberof VariantsApiListVariants
|
|
1817
|
+
*/
|
|
1818
|
+
readonly pageSize?: number
|
|
1819
|
+
|
|
1820
|
+
/**
|
|
1821
|
+
* Filter response fields to only include a subset of the resource.
|
|
1822
|
+
* @type {string}
|
|
1823
|
+
* @memberof VariantsApiListVariants
|
|
1824
|
+
*/
|
|
1825
|
+
readonly fields?: string
|
|
1826
|
+
|
|
1827
|
+
/**
|
|
1828
|
+
* Search terms to filter based on.
|
|
1829
|
+
* @type {string}
|
|
1830
|
+
* @memberof VariantsApiListVariants
|
|
1831
|
+
*/
|
|
1832
|
+
readonly search?: string
|
|
1833
|
+
}
|
|
1834
|
+
|
|
1577
1835
|
/**
|
|
1578
1836
|
* VariantsApi - object-oriented interface
|
|
1579
1837
|
* @export
|
|
@@ -1584,61 +1842,49 @@ export class VariantsApi extends BaseAPI {
|
|
|
1584
1842
|
/**
|
|
1585
1843
|
* Gets the stock level for the GFN variant with the given ID.
|
|
1586
1844
|
* @summary Get GFN variant stock
|
|
1587
|
-
* @param {
|
|
1588
|
-
* @param {string} variantId Variants unique identifier
|
|
1589
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1845
|
+
* @param {VariantsApiGetStockRequest} requestParameters Request parameters.
|
|
1590
1846
|
* @param {*} [options] Override http request option.
|
|
1591
1847
|
* @throws {RequiredError}
|
|
1592
1848
|
* @memberof VariantsApi
|
|
1593
1849
|
*/
|
|
1594
|
-
public getStock(
|
|
1595
|
-
return VariantsApiFp(this.configuration).getStock(project, variantId, fulfillmentProjects, options).then((request) => request(this.axios, this.basePath));
|
|
1850
|
+
public getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig) {
|
|
1851
|
+
return VariantsApiFp(this.configuration).getStock(requestParameters.project, requestParameters.variantId, requestParameters.fulfillmentProjects, options).then((request) => request(this.axios, this.basePath));
|
|
1596
1852
|
}
|
|
1597
1853
|
|
|
1598
1854
|
/**
|
|
1599
1855
|
* Gets a GFN variant by the given ID.
|
|
1600
1856
|
* @summary Get a GFN variant
|
|
1601
|
-
* @param {
|
|
1602
|
-
* @param {string} variantId Variants unique identifier
|
|
1603
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1857
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1604
1858
|
* @param {*} [options] Override http request option.
|
|
1605
1859
|
* @throws {RequiredError}
|
|
1606
1860
|
* @memberof VariantsApi
|
|
1607
1861
|
*/
|
|
1608
|
-
public getVariant(
|
|
1609
|
-
return VariantsApiFp(this.configuration).getVariant(project, variantId, fields, options).then((request) => request(this.axios, this.basePath));
|
|
1862
|
+
public getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig) {
|
|
1863
|
+
return VariantsApiFp(this.configuration).getVariant(requestParameters.project, requestParameters.variantId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1610
1864
|
}
|
|
1611
1865
|
|
|
1612
1866
|
/**
|
|
1613
1867
|
* Lists the stock levels for all GFN variants available to the project.
|
|
1614
1868
|
* @summary List GFN variant stock
|
|
1615
|
-
* @param {
|
|
1616
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1617
|
-
* @param {number} [pageToken] Page reference token
|
|
1618
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1619
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1869
|
+
* @param {VariantsApiListStockRequest} requestParameters Request parameters.
|
|
1620
1870
|
* @param {*} [options] Override http request option.
|
|
1621
1871
|
* @throws {RequiredError}
|
|
1622
1872
|
* @memberof VariantsApi
|
|
1623
1873
|
*/
|
|
1624
|
-
public listStock(
|
|
1625
|
-
return VariantsApiFp(this.configuration).listStock(project, fulfillmentProjects, pageToken, pageSize, search, options).then((request) => request(this.axios, this.basePath));
|
|
1874
|
+
public listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig) {
|
|
1875
|
+
return VariantsApiFp(this.configuration).listStock(requestParameters.project, requestParameters.fulfillmentProjects, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1626
1876
|
}
|
|
1627
1877
|
|
|
1628
1878
|
/**
|
|
1629
1879
|
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1630
1880
|
* @summary List GFN variants
|
|
1631
|
-
* @param {
|
|
1632
|
-
* @param {number} [pageToken] Page reference token
|
|
1633
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1634
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1635
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1881
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1636
1882
|
* @param {*} [options] Override http request option.
|
|
1637
1883
|
* @throws {RequiredError}
|
|
1638
1884
|
* @memberof VariantsApi
|
|
1639
1885
|
*/
|
|
1640
|
-
public listVariants(
|
|
1641
|
-
return VariantsApiFp(this.configuration).listVariants(project, pageToken, pageSize, fields, search, options).then((request) => request(this.axios, this.basePath));
|
|
1886
|
+
public listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig) {
|
|
1887
|
+
return VariantsApiFp(this.configuration).listVariants(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
1642
1888
|
}
|
|
1643
1889
|
}
|
|
1644
1890
|
|