@teemill/gfn-catalog 3.4.0 → 3.6.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 +144 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -3
- package/dist/api.d.ts +88 -1
- package/dist/api.js +84 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +2 -2
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +88 -1
- package/dist/esm/api.js +84 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +2 -2
- 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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/gfn-catalog@3.
|
|
1
|
+
## @teemill/gfn-catalog@3.6.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/gfn-catalog@3.
|
|
39
|
+
npm install @teemill/gfn-catalog@3.6.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -355,6 +355,12 @@ export interface Product {
|
|
|
355
355
|
* @memberof Product
|
|
356
356
|
*/
|
|
357
357
|
'variants': Array<ProductVariantsInner>;
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @type {ProductBrand}
|
|
361
|
+
* @memberof Product
|
|
362
|
+
*/
|
|
363
|
+
'brand'?: ProductBrand;
|
|
358
364
|
}
|
|
359
365
|
/**
|
|
360
366
|
*
|
|
@@ -400,6 +406,25 @@ export interface ProductAttributeValuesInner {
|
|
|
400
406
|
*/
|
|
401
407
|
'value': string;
|
|
402
408
|
}
|
|
409
|
+
/**
|
|
410
|
+
*
|
|
411
|
+
* @export
|
|
412
|
+
* @interface ProductBrand
|
|
413
|
+
*/
|
|
414
|
+
export interface ProductBrand {
|
|
415
|
+
/**
|
|
416
|
+
* the name of the brand that manufactures/supplies the product
|
|
417
|
+
* @type {string}
|
|
418
|
+
* @memberof ProductBrand
|
|
419
|
+
*/
|
|
420
|
+
'name': string;
|
|
421
|
+
/**
|
|
422
|
+
* a URL to the brand\'s logo
|
|
423
|
+
* @type {string}
|
|
424
|
+
* @memberof ProductBrand
|
|
425
|
+
*/
|
|
426
|
+
'logo'?: string;
|
|
427
|
+
}
|
|
403
428
|
/**
|
|
404
429
|
*
|
|
405
430
|
* @export
|
|
@@ -788,6 +813,59 @@ export interface VariantsResponse {
|
|
|
788
813
|
*/
|
|
789
814
|
export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
790
815
|
return {
|
|
816
|
+
/**
|
|
817
|
+
* Gets a GFN product by the given ID.
|
|
818
|
+
* @summary Get a GFN product
|
|
819
|
+
* @param {string} project What project it is
|
|
820
|
+
* @param {string} productId
|
|
821
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
822
|
+
* @param {*} [options] Override http request option.
|
|
823
|
+
* @throws {RequiredError}
|
|
824
|
+
*/
|
|
825
|
+
getProduct: async (project: string, productId: string, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
826
|
+
// verify required parameter 'project' is not null or undefined
|
|
827
|
+
assertParamExists('getProduct', 'project', project)
|
|
828
|
+
// verify required parameter 'productId' is not null or undefined
|
|
829
|
+
assertParamExists('getProduct', 'productId', productId)
|
|
830
|
+
const localVarPath = `/v1/gfn/catalog/products/{productId}`
|
|
831
|
+
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
832
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
833
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
834
|
+
let baseOptions;
|
|
835
|
+
if (configuration) {
|
|
836
|
+
baseOptions = configuration.baseOptions;
|
|
837
|
+
}
|
|
838
|
+
|
|
839
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
840
|
+
const localVarHeaderParameter = {} as any;
|
|
841
|
+
const localVarQueryParameter = {} as any;
|
|
842
|
+
|
|
843
|
+
// authentication session-oauth required
|
|
844
|
+
// oauth required
|
|
845
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
846
|
+
|
|
847
|
+
// authentication api-key required
|
|
848
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
849
|
+
|
|
850
|
+
if (project !== undefined) {
|
|
851
|
+
localVarQueryParameter['project'] = project;
|
|
852
|
+
}
|
|
853
|
+
|
|
854
|
+
if (fields !== undefined) {
|
|
855
|
+
localVarQueryParameter['fields'] = fields;
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
861
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
862
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
863
|
+
|
|
864
|
+
return {
|
|
865
|
+
url: toPathString(localVarUrlObj),
|
|
866
|
+
options: localVarRequestOptions,
|
|
867
|
+
};
|
|
868
|
+
},
|
|
791
869
|
/**
|
|
792
870
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
793
871
|
* @summary List GFN products
|
|
@@ -862,6 +940,21 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
862
940
|
export const ProductsApiFp = function(configuration?: Configuration) {
|
|
863
941
|
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
|
|
864
942
|
return {
|
|
943
|
+
/**
|
|
944
|
+
* Gets a GFN product by the given ID.
|
|
945
|
+
* @summary Get a GFN product
|
|
946
|
+
* @param {string} project What project it is
|
|
947
|
+
* @param {string} productId
|
|
948
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
949
|
+
* @param {*} [options] Override http request option.
|
|
950
|
+
* @throws {RequiredError}
|
|
951
|
+
*/
|
|
952
|
+
async getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
|
|
953
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProduct(project, productId, fields, options);
|
|
954
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
955
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProduct']?.[localVarOperationServerIndex]?.url;
|
|
956
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
957
|
+
},
|
|
865
958
|
/**
|
|
866
959
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
867
960
|
* @summary List GFN products
|
|
@@ -889,6 +982,16 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
889
982
|
export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
890
983
|
const localVarFp = ProductsApiFp(configuration)
|
|
891
984
|
return {
|
|
985
|
+
/**
|
|
986
|
+
* Gets a GFN product by the given ID.
|
|
987
|
+
* @summary Get a GFN product
|
|
988
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
989
|
+
* @param {*} [options] Override http request option.
|
|
990
|
+
* @throws {RequiredError}
|
|
991
|
+
*/
|
|
992
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
|
|
993
|
+
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
994
|
+
},
|
|
892
995
|
/**
|
|
893
996
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
894
997
|
* @summary List GFN products
|
|
@@ -902,6 +1005,34 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
902
1005
|
};
|
|
903
1006
|
};
|
|
904
1007
|
|
|
1008
|
+
/**
|
|
1009
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
1010
|
+
* @export
|
|
1011
|
+
* @interface ProductsApiGetProductRequest
|
|
1012
|
+
*/
|
|
1013
|
+
export interface ProductsApiGetProductRequest {
|
|
1014
|
+
/**
|
|
1015
|
+
* What project it is
|
|
1016
|
+
* @type {string}
|
|
1017
|
+
* @memberof ProductsApiGetProduct
|
|
1018
|
+
*/
|
|
1019
|
+
readonly project: string
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
*
|
|
1023
|
+
* @type {string}
|
|
1024
|
+
* @memberof ProductsApiGetProduct
|
|
1025
|
+
*/
|
|
1026
|
+
readonly productId: string
|
|
1027
|
+
|
|
1028
|
+
/**
|
|
1029
|
+
* Filter response fields to only include a subset of the resource.
|
|
1030
|
+
* @type {string}
|
|
1031
|
+
* @memberof ProductsApiGetProduct
|
|
1032
|
+
*/
|
|
1033
|
+
readonly fields?: string
|
|
1034
|
+
}
|
|
1035
|
+
|
|
905
1036
|
/**
|
|
906
1037
|
* Request parameters for listProducts operation in ProductsApi.
|
|
907
1038
|
* @export
|
|
@@ -951,6 +1082,18 @@ export interface ProductsApiListProductsRequest {
|
|
|
951
1082
|
* @extends {BaseAPI}
|
|
952
1083
|
*/
|
|
953
1084
|
export class ProductsApi extends BaseAPI {
|
|
1085
|
+
/**
|
|
1086
|
+
* Gets a GFN product by the given ID.
|
|
1087
|
+
* @summary Get a GFN product
|
|
1088
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
1089
|
+
* @param {*} [options] Override http request option.
|
|
1090
|
+
* @throws {RequiredError}
|
|
1091
|
+
* @memberof ProductsApi
|
|
1092
|
+
*/
|
|
1093
|
+
public getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig) {
|
|
1094
|
+
return ProductsApiFp(this.configuration).getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1095
|
+
}
|
|
1096
|
+
|
|
954
1097
|
/**
|
|
955
1098
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
956
1099
|
* @summary List GFN products
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -90,11 +90,10 @@ export class Configuration {
|
|
|
90
90
|
this.basePath = param.basePath;
|
|
91
91
|
this.serverIndex = param.serverIndex;
|
|
92
92
|
this.baseOptions = {
|
|
93
|
+
...param.baseOptions,
|
|
93
94
|
headers: {
|
|
94
95
|
...param.baseOptions?.headers,
|
|
95
|
-
'User-Agent': "OpenAPI-Generator/3.4.0/typescript-axios"
|
|
96
96
|
},
|
|
97
|
-
...param.baseOptions
|
|
98
97
|
};
|
|
99
98
|
this.formDataCtor = param.formDataCtor;
|
|
100
99
|
}
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -344,6 +344,12 @@ export interface Product {
|
|
|
344
344
|
* @memberof Product
|
|
345
345
|
*/
|
|
346
346
|
'variants': Array<ProductVariantsInner>;
|
|
347
|
+
/**
|
|
348
|
+
*
|
|
349
|
+
* @type {ProductBrand}
|
|
350
|
+
* @memberof Product
|
|
351
|
+
*/
|
|
352
|
+
'brand'?: ProductBrand;
|
|
347
353
|
}
|
|
348
354
|
/**
|
|
349
355
|
*
|
|
@@ -389,6 +395,25 @@ export interface ProductAttributeValuesInner {
|
|
|
389
395
|
*/
|
|
390
396
|
'value': string;
|
|
391
397
|
}
|
|
398
|
+
/**
|
|
399
|
+
*
|
|
400
|
+
* @export
|
|
401
|
+
* @interface ProductBrand
|
|
402
|
+
*/
|
|
403
|
+
export interface ProductBrand {
|
|
404
|
+
/**
|
|
405
|
+
* the name of the brand that manufactures/supplies the product
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof ProductBrand
|
|
408
|
+
*/
|
|
409
|
+
'name': string;
|
|
410
|
+
/**
|
|
411
|
+
* a URL to the brand\'s logo
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof ProductBrand
|
|
414
|
+
*/
|
|
415
|
+
'logo'?: string;
|
|
416
|
+
}
|
|
392
417
|
/**
|
|
393
418
|
*
|
|
394
419
|
* @export
|
|
@@ -772,6 +797,16 @@ export interface VariantsResponse {
|
|
|
772
797
|
* @export
|
|
773
798
|
*/
|
|
774
799
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
800
|
+
/**
|
|
801
|
+
* Gets a GFN product by the given ID.
|
|
802
|
+
* @summary Get a GFN product
|
|
803
|
+
* @param {string} project What project it is
|
|
804
|
+
* @param {string} productId
|
|
805
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
775
810
|
/**
|
|
776
811
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
777
812
|
* @summary List GFN products
|
|
@@ -790,6 +825,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
790
825
|
* @export
|
|
791
826
|
*/
|
|
792
827
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
828
|
+
/**
|
|
829
|
+
* Gets a GFN product by the given ID.
|
|
830
|
+
* @summary Get a GFN product
|
|
831
|
+
* @param {string} project What project it is
|
|
832
|
+
* @param {string} productId
|
|
833
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
834
|
+
* @param {*} [options] Override http request option.
|
|
835
|
+
* @throws {RequiredError}
|
|
836
|
+
*/
|
|
837
|
+
getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
793
838
|
/**
|
|
794
839
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
795
840
|
* @summary List GFN products
|
|
@@ -808,6 +853,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
808
853
|
* @export
|
|
809
854
|
*/
|
|
810
855
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
856
|
+
/**
|
|
857
|
+
* Gets a GFN product by the given ID.
|
|
858
|
+
* @summary Get a GFN product
|
|
859
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
860
|
+
* @param {*} [options] Override http request option.
|
|
861
|
+
* @throws {RequiredError}
|
|
862
|
+
*/
|
|
863
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
811
864
|
/**
|
|
812
865
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
813
866
|
* @summary List GFN products
|
|
@@ -817,6 +870,31 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
817
870
|
*/
|
|
818
871
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
819
872
|
};
|
|
873
|
+
/**
|
|
874
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
875
|
+
* @export
|
|
876
|
+
* @interface ProductsApiGetProductRequest
|
|
877
|
+
*/
|
|
878
|
+
export interface ProductsApiGetProductRequest {
|
|
879
|
+
/**
|
|
880
|
+
* What project it is
|
|
881
|
+
* @type {string}
|
|
882
|
+
* @memberof ProductsApiGetProduct
|
|
883
|
+
*/
|
|
884
|
+
readonly project: string;
|
|
885
|
+
/**
|
|
886
|
+
*
|
|
887
|
+
* @type {string}
|
|
888
|
+
* @memberof ProductsApiGetProduct
|
|
889
|
+
*/
|
|
890
|
+
readonly productId: string;
|
|
891
|
+
/**
|
|
892
|
+
* Filter response fields to only include a subset of the resource.
|
|
893
|
+
* @type {string}
|
|
894
|
+
* @memberof ProductsApiGetProduct
|
|
895
|
+
*/
|
|
896
|
+
readonly fields?: string;
|
|
897
|
+
}
|
|
820
898
|
/**
|
|
821
899
|
* Request parameters for listProducts operation in ProductsApi.
|
|
822
900
|
* @export
|
|
@@ -861,6 +939,15 @@ export interface ProductsApiListProductsRequest {
|
|
|
861
939
|
* @extends {BaseAPI}
|
|
862
940
|
*/
|
|
863
941
|
export declare class ProductsApi extends BaseAPI {
|
|
942
|
+
/**
|
|
943
|
+
* Gets a GFN product by the given ID.
|
|
944
|
+
* @summary Get a GFN product
|
|
945
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
946
|
+
* @param {*} [options] Override http request option.
|
|
947
|
+
* @throws {RequiredError}
|
|
948
|
+
* @memberof ProductsApi
|
|
949
|
+
*/
|
|
950
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
864
951
|
/**
|
|
865
952
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
866
953
|
* @summary List GFN products
|
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GFN Catalog API
|
|
6
6
|
* Use this API to access the Global Fulfillment 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -45,6 +45,50 @@ exports.TransactionTypeEnum = {
|
|
|
45
45
|
*/
|
|
46
46
|
const ProductsApiAxiosParamCreator = function (configuration) {
|
|
47
47
|
return {
|
|
48
|
+
/**
|
|
49
|
+
* Gets a GFN product by the given ID.
|
|
50
|
+
* @summary Get a GFN product
|
|
51
|
+
* @param {string} project What project it is
|
|
52
|
+
* @param {string} productId
|
|
53
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
getProduct: (project_1, productId_1, fields_1, ...args_1) => __awaiter(this, [project_1, productId_1, fields_1, ...args_1], void 0, function* (project, productId, fields, options = {}) {
|
|
58
|
+
// verify required parameter 'project' is not null or undefined
|
|
59
|
+
(0, common_1.assertParamExists)('getProduct', 'project', project);
|
|
60
|
+
// verify required parameter 'productId' is not null or undefined
|
|
61
|
+
(0, common_1.assertParamExists)('getProduct', 'productId', productId);
|
|
62
|
+
const localVarPath = `/v1/gfn/catalog/products/{productId}`
|
|
63
|
+
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
64
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
65
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
66
|
+
let baseOptions;
|
|
67
|
+
if (configuration) {
|
|
68
|
+
baseOptions = configuration.baseOptions;
|
|
69
|
+
}
|
|
70
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
71
|
+
const localVarHeaderParameter = {};
|
|
72
|
+
const localVarQueryParameter = {};
|
|
73
|
+
// authentication session-oauth required
|
|
74
|
+
// oauth required
|
|
75
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
76
|
+
// authentication api-key required
|
|
77
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
78
|
+
if (project !== undefined) {
|
|
79
|
+
localVarQueryParameter['project'] = project;
|
|
80
|
+
}
|
|
81
|
+
if (fields !== undefined) {
|
|
82
|
+
localVarQueryParameter['fields'] = fields;
|
|
83
|
+
}
|
|
84
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
85
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
86
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
87
|
+
return {
|
|
88
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
89
|
+
options: localVarRequestOptions,
|
|
90
|
+
};
|
|
91
|
+
}),
|
|
48
92
|
/**
|
|
49
93
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
50
94
|
* @summary List GFN products
|
|
@@ -107,6 +151,24 @@ exports.ProductsApiAxiosParamCreator = ProductsApiAxiosParamCreator;
|
|
|
107
151
|
const ProductsApiFp = function (configuration) {
|
|
108
152
|
const localVarAxiosParamCreator = (0, exports.ProductsApiAxiosParamCreator)(configuration);
|
|
109
153
|
return {
|
|
154
|
+
/**
|
|
155
|
+
* Gets a GFN product by the given ID.
|
|
156
|
+
* @summary Get a GFN product
|
|
157
|
+
* @param {string} project What project it is
|
|
158
|
+
* @param {string} productId
|
|
159
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
getProduct(project, productId, fields, options) {
|
|
164
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
165
|
+
var _a, _b, _c;
|
|
166
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProduct(project, productId, fields, options);
|
|
167
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
168
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['ProductsApi.getProduct']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
169
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
170
|
+
});
|
|
171
|
+
},
|
|
110
172
|
/**
|
|
111
173
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
112
174
|
* @summary List GFN products
|
|
@@ -137,6 +199,16 @@ exports.ProductsApiFp = ProductsApiFp;
|
|
|
137
199
|
const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
138
200
|
const localVarFp = (0, exports.ProductsApiFp)(configuration);
|
|
139
201
|
return {
|
|
202
|
+
/**
|
|
203
|
+
* Gets a GFN product by the given ID.
|
|
204
|
+
* @summary Get a GFN product
|
|
205
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
206
|
+
* @param {*} [options] Override http request option.
|
|
207
|
+
* @throws {RequiredError}
|
|
208
|
+
*/
|
|
209
|
+
getProduct(requestParameters, options) {
|
|
210
|
+
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
211
|
+
},
|
|
140
212
|
/**
|
|
141
213
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
142
214
|
* @summary List GFN products
|
|
@@ -157,6 +229,17 @@ exports.ProductsApiFactory = ProductsApiFactory;
|
|
|
157
229
|
* @extends {BaseAPI}
|
|
158
230
|
*/
|
|
159
231
|
class ProductsApi extends base_1.BaseAPI {
|
|
232
|
+
/**
|
|
233
|
+
* Gets a GFN product by the given ID.
|
|
234
|
+
* @summary Get a GFN product
|
|
235
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
* @memberof ProductsApi
|
|
239
|
+
*/
|
|
240
|
+
getProduct(requestParameters, options) {
|
|
241
|
+
return (0, exports.ProductsApiFp)(this.configuration).getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
242
|
+
}
|
|
160
243
|
/**
|
|
161
244
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
162
245
|
* @summary List GFN products
|
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GFN Catalog API
|
|
6
6
|
* Use this API to access the Global Fulfillment 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GFN Catalog API
|
|
6
6
|
* Use this API to access the Global Fulfillment 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GFN Catalog API
|
|
6
6
|
* Use this API to access the Global Fulfillment 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -23,7 +23,7 @@ class Configuration {
|
|
|
23
23
|
this.accessToken = param.accessToken;
|
|
24
24
|
this.basePath = param.basePath;
|
|
25
25
|
this.serverIndex = param.serverIndex;
|
|
26
|
-
this.baseOptions = Object.assign({ headers: Object.assign(
|
|
26
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
27
27
|
this.formDataCtor = param.formDataCtor;
|
|
28
28
|
}
|
|
29
29
|
/**
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -344,6 +344,12 @@ export interface Product {
|
|
|
344
344
|
* @memberof Product
|
|
345
345
|
*/
|
|
346
346
|
'variants': Array<ProductVariantsInner>;
|
|
347
|
+
/**
|
|
348
|
+
*
|
|
349
|
+
* @type {ProductBrand}
|
|
350
|
+
* @memberof Product
|
|
351
|
+
*/
|
|
352
|
+
'brand'?: ProductBrand;
|
|
347
353
|
}
|
|
348
354
|
/**
|
|
349
355
|
*
|
|
@@ -389,6 +395,25 @@ export interface ProductAttributeValuesInner {
|
|
|
389
395
|
*/
|
|
390
396
|
'value': string;
|
|
391
397
|
}
|
|
398
|
+
/**
|
|
399
|
+
*
|
|
400
|
+
* @export
|
|
401
|
+
* @interface ProductBrand
|
|
402
|
+
*/
|
|
403
|
+
export interface ProductBrand {
|
|
404
|
+
/**
|
|
405
|
+
* the name of the brand that manufactures/supplies the product
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof ProductBrand
|
|
408
|
+
*/
|
|
409
|
+
'name': string;
|
|
410
|
+
/**
|
|
411
|
+
* a URL to the brand\'s logo
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof ProductBrand
|
|
414
|
+
*/
|
|
415
|
+
'logo'?: string;
|
|
416
|
+
}
|
|
392
417
|
/**
|
|
393
418
|
*
|
|
394
419
|
* @export
|
|
@@ -772,6 +797,16 @@ export interface VariantsResponse {
|
|
|
772
797
|
* @export
|
|
773
798
|
*/
|
|
774
799
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
800
|
+
/**
|
|
801
|
+
* Gets a GFN product by the given ID.
|
|
802
|
+
* @summary Get a GFN product
|
|
803
|
+
* @param {string} project What project it is
|
|
804
|
+
* @param {string} productId
|
|
805
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
806
|
+
* @param {*} [options] Override http request option.
|
|
807
|
+
* @throws {RequiredError}
|
|
808
|
+
*/
|
|
809
|
+
getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
775
810
|
/**
|
|
776
811
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
777
812
|
* @summary List GFN products
|
|
@@ -790,6 +825,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
790
825
|
* @export
|
|
791
826
|
*/
|
|
792
827
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
828
|
+
/**
|
|
829
|
+
* Gets a GFN product by the given ID.
|
|
830
|
+
* @summary Get a GFN product
|
|
831
|
+
* @param {string} project What project it is
|
|
832
|
+
* @param {string} productId
|
|
833
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
834
|
+
* @param {*} [options] Override http request option.
|
|
835
|
+
* @throws {RequiredError}
|
|
836
|
+
*/
|
|
837
|
+
getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
793
838
|
/**
|
|
794
839
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
795
840
|
* @summary List GFN products
|
|
@@ -808,6 +853,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
808
853
|
* @export
|
|
809
854
|
*/
|
|
810
855
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
856
|
+
/**
|
|
857
|
+
* Gets a GFN product by the given ID.
|
|
858
|
+
* @summary Get a GFN product
|
|
859
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
860
|
+
* @param {*} [options] Override http request option.
|
|
861
|
+
* @throws {RequiredError}
|
|
862
|
+
*/
|
|
863
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
811
864
|
/**
|
|
812
865
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
813
866
|
* @summary List GFN products
|
|
@@ -817,6 +870,31 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
817
870
|
*/
|
|
818
871
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
819
872
|
};
|
|
873
|
+
/**
|
|
874
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
875
|
+
* @export
|
|
876
|
+
* @interface ProductsApiGetProductRequest
|
|
877
|
+
*/
|
|
878
|
+
export interface ProductsApiGetProductRequest {
|
|
879
|
+
/**
|
|
880
|
+
* What project it is
|
|
881
|
+
* @type {string}
|
|
882
|
+
* @memberof ProductsApiGetProduct
|
|
883
|
+
*/
|
|
884
|
+
readonly project: string;
|
|
885
|
+
/**
|
|
886
|
+
*
|
|
887
|
+
* @type {string}
|
|
888
|
+
* @memberof ProductsApiGetProduct
|
|
889
|
+
*/
|
|
890
|
+
readonly productId: string;
|
|
891
|
+
/**
|
|
892
|
+
* Filter response fields to only include a subset of the resource.
|
|
893
|
+
* @type {string}
|
|
894
|
+
* @memberof ProductsApiGetProduct
|
|
895
|
+
*/
|
|
896
|
+
readonly fields?: string;
|
|
897
|
+
}
|
|
820
898
|
/**
|
|
821
899
|
* Request parameters for listProducts operation in ProductsApi.
|
|
822
900
|
* @export
|
|
@@ -861,6 +939,15 @@ export interface ProductsApiListProductsRequest {
|
|
|
861
939
|
* @extends {BaseAPI}
|
|
862
940
|
*/
|
|
863
941
|
export declare class ProductsApi extends BaseAPI {
|
|
942
|
+
/**
|
|
943
|
+
* Gets a GFN product by the given ID.
|
|
944
|
+
* @summary Get a GFN product
|
|
945
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
946
|
+
* @param {*} [options] Override http request option.
|
|
947
|
+
* @throws {RequiredError}
|
|
948
|
+
* @memberof ProductsApi
|
|
949
|
+
*/
|
|
950
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
864
951
|
/**
|
|
865
952
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
866
953
|
* @summary List GFN products
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -42,6 +42,50 @@ export const TransactionTypeEnum = {
|
|
|
42
42
|
*/
|
|
43
43
|
export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
44
44
|
return {
|
|
45
|
+
/**
|
|
46
|
+
* Gets a GFN product by the given ID.
|
|
47
|
+
* @summary Get a GFN product
|
|
48
|
+
* @param {string} project What project it is
|
|
49
|
+
* @param {string} productId
|
|
50
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
51
|
+
* @param {*} [options] Override http request option.
|
|
52
|
+
* @throws {RequiredError}
|
|
53
|
+
*/
|
|
54
|
+
getProduct: (project_1, productId_1, fields_1, ...args_1) => __awaiter(this, [project_1, productId_1, fields_1, ...args_1], void 0, function* (project, productId, fields, options = {}) {
|
|
55
|
+
// verify required parameter 'project' is not null or undefined
|
|
56
|
+
assertParamExists('getProduct', 'project', project);
|
|
57
|
+
// verify required parameter 'productId' is not null or undefined
|
|
58
|
+
assertParamExists('getProduct', 'productId', productId);
|
|
59
|
+
const localVarPath = `/v1/gfn/catalog/products/{productId}`
|
|
60
|
+
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
61
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
62
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
63
|
+
let baseOptions;
|
|
64
|
+
if (configuration) {
|
|
65
|
+
baseOptions = configuration.baseOptions;
|
|
66
|
+
}
|
|
67
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
68
|
+
const localVarHeaderParameter = {};
|
|
69
|
+
const localVarQueryParameter = {};
|
|
70
|
+
// authentication session-oauth required
|
|
71
|
+
// oauth required
|
|
72
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
73
|
+
// authentication api-key required
|
|
74
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
75
|
+
if (project !== undefined) {
|
|
76
|
+
localVarQueryParameter['project'] = project;
|
|
77
|
+
}
|
|
78
|
+
if (fields !== undefined) {
|
|
79
|
+
localVarQueryParameter['fields'] = fields;
|
|
80
|
+
}
|
|
81
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
83
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
84
|
+
return {
|
|
85
|
+
url: toPathString(localVarUrlObj),
|
|
86
|
+
options: localVarRequestOptions,
|
|
87
|
+
};
|
|
88
|
+
}),
|
|
45
89
|
/**
|
|
46
90
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
47
91
|
* @summary List GFN products
|
|
@@ -103,6 +147,24 @@ export const ProductsApiAxiosParamCreator = function (configuration) {
|
|
|
103
147
|
export const ProductsApiFp = function (configuration) {
|
|
104
148
|
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration);
|
|
105
149
|
return {
|
|
150
|
+
/**
|
|
151
|
+
* Gets a GFN product by the given ID.
|
|
152
|
+
* @summary Get a GFN product
|
|
153
|
+
* @param {string} project What project it is
|
|
154
|
+
* @param {string} productId
|
|
155
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
getProduct(project, productId, fields, options) {
|
|
160
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
161
|
+
var _a, _b, _c;
|
|
162
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getProduct(project, productId, fields, options);
|
|
163
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
164
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ProductsApi.getProduct']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
165
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
166
|
+
});
|
|
167
|
+
},
|
|
106
168
|
/**
|
|
107
169
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
108
170
|
* @summary List GFN products
|
|
@@ -132,6 +194,16 @@ export const ProductsApiFp = function (configuration) {
|
|
|
132
194
|
export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
133
195
|
const localVarFp = ProductsApiFp(configuration);
|
|
134
196
|
return {
|
|
197
|
+
/**
|
|
198
|
+
* Gets a GFN product by the given ID.
|
|
199
|
+
* @summary Get a GFN product
|
|
200
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
201
|
+
* @param {*} [options] Override http request option.
|
|
202
|
+
* @throws {RequiredError}
|
|
203
|
+
*/
|
|
204
|
+
getProduct(requestParameters, options) {
|
|
205
|
+
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
206
|
+
},
|
|
135
207
|
/**
|
|
136
208
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
137
209
|
* @summary List GFN products
|
|
@@ -151,6 +223,17 @@ export const ProductsApiFactory = function (configuration, basePath, axios) {
|
|
|
151
223
|
* @extends {BaseAPI}
|
|
152
224
|
*/
|
|
153
225
|
export class ProductsApi extends BaseAPI {
|
|
226
|
+
/**
|
|
227
|
+
* Gets a GFN product by the given ID.
|
|
228
|
+
* @summary Get a GFN product
|
|
229
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
230
|
+
* @param {*} [options] Override http request option.
|
|
231
|
+
* @throws {RequiredError}
|
|
232
|
+
* @memberof ProductsApi
|
|
233
|
+
*/
|
|
234
|
+
getProduct(requestParameters, options) {
|
|
235
|
+
return ProductsApiFp(this.configuration).getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
236
|
+
}
|
|
154
237
|
/**
|
|
155
238
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
156
239
|
* @summary List GFN products
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -20,7 +20,7 @@ export class Configuration {
|
|
|
20
20
|
this.accessToken = param.accessToken;
|
|
21
21
|
this.basePath = param.basePath;
|
|
22
22
|
this.serverIndex = param.serverIndex;
|
|
23
|
-
this.baseOptions = Object.assign({ headers: Object.assign(
|
|
23
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
24
24
|
this.formDataCtor = param.formDataCtor;
|
|
25
25
|
}
|
|
26
26
|
/**
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfillment 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GFN Catalog API
|
|
6
6
|
* Use this API to access the Global Fulfillment 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfillment 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: 3.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|