@teemill/gfn-catalog 3.3.2 → 3.5.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 +157 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -3
- package/dist/api.d.ts +101 -2
- 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 +101 -2
- 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.5.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.5.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.5.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -181,7 +181,7 @@ export interface Image {
|
|
|
181
181
|
* @type {string}
|
|
182
182
|
* @memberof Image
|
|
183
183
|
*/
|
|
184
|
-
'src'
|
|
184
|
+
'src': string;
|
|
185
185
|
/**
|
|
186
186
|
*
|
|
187
187
|
* @type {string}
|
|
@@ -343,6 +343,12 @@ export interface Product {
|
|
|
343
343
|
* @memberof Product
|
|
344
344
|
*/
|
|
345
345
|
'attributes': Array<ProductAttribute>;
|
|
346
|
+
/**
|
|
347
|
+
* Images attached to the product. For example, photos of models using/wearing the product. This property currently does not include images linked to specific variants.
|
|
348
|
+
* @type {Array<ProductImagesInner>}
|
|
349
|
+
* @memberof Product
|
|
350
|
+
*/
|
|
351
|
+
'images'?: Array<ProductImagesInner>;
|
|
346
352
|
/**
|
|
347
353
|
* Variants
|
|
348
354
|
* @type {Array<ProductVariantsInner>}
|
|
@@ -394,6 +400,37 @@ export interface ProductAttributeValuesInner {
|
|
|
394
400
|
*/
|
|
395
401
|
'value': string;
|
|
396
402
|
}
|
|
403
|
+
/**
|
|
404
|
+
*
|
|
405
|
+
* @export
|
|
406
|
+
* @interface ProductImagesInner
|
|
407
|
+
*/
|
|
408
|
+
export interface ProductImagesInner {
|
|
409
|
+
/**
|
|
410
|
+
* Unique object identifier
|
|
411
|
+
* @type {string}
|
|
412
|
+
* @memberof ProductImagesInner
|
|
413
|
+
*/
|
|
414
|
+
'id': string;
|
|
415
|
+
/**
|
|
416
|
+
*
|
|
417
|
+
* @type {string}
|
|
418
|
+
* @memberof ProductImagesInner
|
|
419
|
+
*/
|
|
420
|
+
'src': string;
|
|
421
|
+
/**
|
|
422
|
+
*
|
|
423
|
+
* @type {string}
|
|
424
|
+
* @memberof ProductImagesInner
|
|
425
|
+
*/
|
|
426
|
+
'alt'?: string;
|
|
427
|
+
/**
|
|
428
|
+
*
|
|
429
|
+
* @type {number}
|
|
430
|
+
* @memberof ProductImagesInner
|
|
431
|
+
*/
|
|
432
|
+
'sortOrder'?: number;
|
|
433
|
+
}
|
|
397
434
|
/**
|
|
398
435
|
*
|
|
399
436
|
* @export
|
|
@@ -751,6 +788,59 @@ export interface VariantsResponse {
|
|
|
751
788
|
*/
|
|
752
789
|
export const ProductsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
753
790
|
return {
|
|
791
|
+
/**
|
|
792
|
+
* Gets a GFN product by the given ID.
|
|
793
|
+
* @summary Get a GFN product
|
|
794
|
+
* @param {string} project What project it is
|
|
795
|
+
* @param {string} productId
|
|
796
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
797
|
+
* @param {*} [options] Override http request option.
|
|
798
|
+
* @throws {RequiredError}
|
|
799
|
+
*/
|
|
800
|
+
getProduct: async (project: string, productId: string, fields?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
801
|
+
// verify required parameter 'project' is not null or undefined
|
|
802
|
+
assertParamExists('getProduct', 'project', project)
|
|
803
|
+
// verify required parameter 'productId' is not null or undefined
|
|
804
|
+
assertParamExists('getProduct', 'productId', productId)
|
|
805
|
+
const localVarPath = `/v1/gfn/catalog/products/{productId}`
|
|
806
|
+
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
807
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
808
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
809
|
+
let baseOptions;
|
|
810
|
+
if (configuration) {
|
|
811
|
+
baseOptions = configuration.baseOptions;
|
|
812
|
+
}
|
|
813
|
+
|
|
814
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
815
|
+
const localVarHeaderParameter = {} as any;
|
|
816
|
+
const localVarQueryParameter = {} as any;
|
|
817
|
+
|
|
818
|
+
// authentication session-oauth required
|
|
819
|
+
// oauth required
|
|
820
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
821
|
+
|
|
822
|
+
// authentication api-key required
|
|
823
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
824
|
+
|
|
825
|
+
if (project !== undefined) {
|
|
826
|
+
localVarQueryParameter['project'] = project;
|
|
827
|
+
}
|
|
828
|
+
|
|
829
|
+
if (fields !== undefined) {
|
|
830
|
+
localVarQueryParameter['fields'] = fields;
|
|
831
|
+
}
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
836
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
837
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
838
|
+
|
|
839
|
+
return {
|
|
840
|
+
url: toPathString(localVarUrlObj),
|
|
841
|
+
options: localVarRequestOptions,
|
|
842
|
+
};
|
|
843
|
+
},
|
|
754
844
|
/**
|
|
755
845
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
756
846
|
* @summary List GFN products
|
|
@@ -825,6 +915,21 @@ export const ProductsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
825
915
|
export const ProductsApiFp = function(configuration?: Configuration) {
|
|
826
916
|
const localVarAxiosParamCreator = ProductsApiAxiosParamCreator(configuration)
|
|
827
917
|
return {
|
|
918
|
+
/**
|
|
919
|
+
* Gets a GFN product by the given ID.
|
|
920
|
+
* @summary Get a GFN product
|
|
921
|
+
* @param {string} project What project it is
|
|
922
|
+
* @param {string} productId
|
|
923
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
924
|
+
* @param {*} [options] Override http request option.
|
|
925
|
+
* @throws {RequiredError}
|
|
926
|
+
*/
|
|
927
|
+
async getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
|
|
928
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProduct(project, productId, fields, options);
|
|
929
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
930
|
+
const localVarOperationServerBasePath = operationServerMap['ProductsApi.getProduct']?.[localVarOperationServerIndex]?.url;
|
|
931
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
932
|
+
},
|
|
828
933
|
/**
|
|
829
934
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
830
935
|
* @summary List GFN products
|
|
@@ -852,6 +957,16 @@ export const ProductsApiFp = function(configuration?: Configuration) {
|
|
|
852
957
|
export const ProductsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
853
958
|
const localVarFp = ProductsApiFp(configuration)
|
|
854
959
|
return {
|
|
960
|
+
/**
|
|
961
|
+
* Gets a GFN product by the given ID.
|
|
962
|
+
* @summary Get a GFN product
|
|
963
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
964
|
+
* @param {*} [options] Override http request option.
|
|
965
|
+
* @throws {RequiredError}
|
|
966
|
+
*/
|
|
967
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
|
|
968
|
+
return localVarFp.getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(axios, basePath));
|
|
969
|
+
},
|
|
855
970
|
/**
|
|
856
971
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
857
972
|
* @summary List GFN products
|
|
@@ -865,6 +980,34 @@ export const ProductsApiFactory = function (configuration?: Configuration, baseP
|
|
|
865
980
|
};
|
|
866
981
|
};
|
|
867
982
|
|
|
983
|
+
/**
|
|
984
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
985
|
+
* @export
|
|
986
|
+
* @interface ProductsApiGetProductRequest
|
|
987
|
+
*/
|
|
988
|
+
export interface ProductsApiGetProductRequest {
|
|
989
|
+
/**
|
|
990
|
+
* What project it is
|
|
991
|
+
* @type {string}
|
|
992
|
+
* @memberof ProductsApiGetProduct
|
|
993
|
+
*/
|
|
994
|
+
readonly project: string
|
|
995
|
+
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @type {string}
|
|
999
|
+
* @memberof ProductsApiGetProduct
|
|
1000
|
+
*/
|
|
1001
|
+
readonly productId: string
|
|
1002
|
+
|
|
1003
|
+
/**
|
|
1004
|
+
* Filter response fields to only include a subset of the resource.
|
|
1005
|
+
* @type {string}
|
|
1006
|
+
* @memberof ProductsApiGetProduct
|
|
1007
|
+
*/
|
|
1008
|
+
readonly fields?: string
|
|
1009
|
+
}
|
|
1010
|
+
|
|
868
1011
|
/**
|
|
869
1012
|
* Request parameters for listProducts operation in ProductsApi.
|
|
870
1013
|
* @export
|
|
@@ -914,6 +1057,18 @@ export interface ProductsApiListProductsRequest {
|
|
|
914
1057
|
* @extends {BaseAPI}
|
|
915
1058
|
*/
|
|
916
1059
|
export class ProductsApi extends BaseAPI {
|
|
1060
|
+
/**
|
|
1061
|
+
* Gets a GFN product by the given ID.
|
|
1062
|
+
* @summary Get a GFN product
|
|
1063
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
1064
|
+
* @param {*} [options] Override http request option.
|
|
1065
|
+
* @throws {RequiredError}
|
|
1066
|
+
* @memberof ProductsApi
|
|
1067
|
+
*/
|
|
1068
|
+
public getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig) {
|
|
1069
|
+
return ProductsApiFp(this.configuration).getProduct(requestParameters.project, requestParameters.productId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
|
|
1070
|
+
}
|
|
1071
|
+
|
|
917
1072
|
/**
|
|
918
1073
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
919
1074
|
* @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.5.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.5.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.5.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.3.2/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.5.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -170,7 +170,7 @@ export interface Image {
|
|
|
170
170
|
* @type {string}
|
|
171
171
|
* @memberof Image
|
|
172
172
|
*/
|
|
173
|
-
'src'
|
|
173
|
+
'src': string;
|
|
174
174
|
/**
|
|
175
175
|
*
|
|
176
176
|
* @type {string}
|
|
@@ -332,6 +332,12 @@ export interface Product {
|
|
|
332
332
|
* @memberof Product
|
|
333
333
|
*/
|
|
334
334
|
'attributes': Array<ProductAttribute>;
|
|
335
|
+
/**
|
|
336
|
+
* Images attached to the product. For example, photos of models using/wearing the product. This property currently does not include images linked to specific variants.
|
|
337
|
+
* @type {Array<ProductImagesInner>}
|
|
338
|
+
* @memberof Product
|
|
339
|
+
*/
|
|
340
|
+
'images'?: Array<ProductImagesInner>;
|
|
335
341
|
/**
|
|
336
342
|
* Variants
|
|
337
343
|
* @type {Array<ProductVariantsInner>}
|
|
@@ -383,6 +389,37 @@ export interface ProductAttributeValuesInner {
|
|
|
383
389
|
*/
|
|
384
390
|
'value': string;
|
|
385
391
|
}
|
|
392
|
+
/**
|
|
393
|
+
*
|
|
394
|
+
* @export
|
|
395
|
+
* @interface ProductImagesInner
|
|
396
|
+
*/
|
|
397
|
+
export interface ProductImagesInner {
|
|
398
|
+
/**
|
|
399
|
+
* Unique object identifier
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof ProductImagesInner
|
|
402
|
+
*/
|
|
403
|
+
'id': string;
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof ProductImagesInner
|
|
408
|
+
*/
|
|
409
|
+
'src': string;
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof ProductImagesInner
|
|
414
|
+
*/
|
|
415
|
+
'alt'?: string;
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @type {number}
|
|
419
|
+
* @memberof ProductImagesInner
|
|
420
|
+
*/
|
|
421
|
+
'sortOrder'?: number;
|
|
422
|
+
}
|
|
386
423
|
/**
|
|
387
424
|
*
|
|
388
425
|
* @export
|
|
@@ -735,6 +772,16 @@ export interface VariantsResponse {
|
|
|
735
772
|
* @export
|
|
736
773
|
*/
|
|
737
774
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
775
|
+
/**
|
|
776
|
+
* Gets a GFN product by the given ID.
|
|
777
|
+
* @summary Get a GFN product
|
|
778
|
+
* @param {string} project What project it is
|
|
779
|
+
* @param {string} productId
|
|
780
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
781
|
+
* @param {*} [options] Override http request option.
|
|
782
|
+
* @throws {RequiredError}
|
|
783
|
+
*/
|
|
784
|
+
getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
738
785
|
/**
|
|
739
786
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
740
787
|
* @summary List GFN products
|
|
@@ -753,6 +800,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
753
800
|
* @export
|
|
754
801
|
*/
|
|
755
802
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
803
|
+
/**
|
|
804
|
+
* Gets a GFN product by the given ID.
|
|
805
|
+
* @summary Get a GFN product
|
|
806
|
+
* @param {string} project What project it is
|
|
807
|
+
* @param {string} productId
|
|
808
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
809
|
+
* @param {*} [options] Override http request option.
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
*/
|
|
812
|
+
getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
756
813
|
/**
|
|
757
814
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
758
815
|
* @summary List GFN products
|
|
@@ -771,6 +828,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
771
828
|
* @export
|
|
772
829
|
*/
|
|
773
830
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
831
|
+
/**
|
|
832
|
+
* Gets a GFN product by the given ID.
|
|
833
|
+
* @summary Get a GFN product
|
|
834
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
835
|
+
* @param {*} [options] Override http request option.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
774
839
|
/**
|
|
775
840
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
776
841
|
* @summary List GFN products
|
|
@@ -780,6 +845,31 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
780
845
|
*/
|
|
781
846
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
782
847
|
};
|
|
848
|
+
/**
|
|
849
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
850
|
+
* @export
|
|
851
|
+
* @interface ProductsApiGetProductRequest
|
|
852
|
+
*/
|
|
853
|
+
export interface ProductsApiGetProductRequest {
|
|
854
|
+
/**
|
|
855
|
+
* What project it is
|
|
856
|
+
* @type {string}
|
|
857
|
+
* @memberof ProductsApiGetProduct
|
|
858
|
+
*/
|
|
859
|
+
readonly project: string;
|
|
860
|
+
/**
|
|
861
|
+
*
|
|
862
|
+
* @type {string}
|
|
863
|
+
* @memberof ProductsApiGetProduct
|
|
864
|
+
*/
|
|
865
|
+
readonly productId: string;
|
|
866
|
+
/**
|
|
867
|
+
* Filter response fields to only include a subset of the resource.
|
|
868
|
+
* @type {string}
|
|
869
|
+
* @memberof ProductsApiGetProduct
|
|
870
|
+
*/
|
|
871
|
+
readonly fields?: string;
|
|
872
|
+
}
|
|
783
873
|
/**
|
|
784
874
|
* Request parameters for listProducts operation in ProductsApi.
|
|
785
875
|
* @export
|
|
@@ -824,6 +914,15 @@ export interface ProductsApiListProductsRequest {
|
|
|
824
914
|
* @extends {BaseAPI}
|
|
825
915
|
*/
|
|
826
916
|
export declare class ProductsApi extends BaseAPI {
|
|
917
|
+
/**
|
|
918
|
+
* Gets a GFN product by the given ID.
|
|
919
|
+
* @summary Get a GFN product
|
|
920
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
921
|
+
* @param {*} [options] Override http request option.
|
|
922
|
+
* @throws {RequiredError}
|
|
923
|
+
* @memberof ProductsApi
|
|
924
|
+
*/
|
|
925
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
827
926
|
/**
|
|
828
927
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
829
928
|
* @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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -170,7 +170,7 @@ export interface Image {
|
|
|
170
170
|
* @type {string}
|
|
171
171
|
* @memberof Image
|
|
172
172
|
*/
|
|
173
|
-
'src'
|
|
173
|
+
'src': string;
|
|
174
174
|
/**
|
|
175
175
|
*
|
|
176
176
|
* @type {string}
|
|
@@ -332,6 +332,12 @@ export interface Product {
|
|
|
332
332
|
* @memberof Product
|
|
333
333
|
*/
|
|
334
334
|
'attributes': Array<ProductAttribute>;
|
|
335
|
+
/**
|
|
336
|
+
* Images attached to the product. For example, photos of models using/wearing the product. This property currently does not include images linked to specific variants.
|
|
337
|
+
* @type {Array<ProductImagesInner>}
|
|
338
|
+
* @memberof Product
|
|
339
|
+
*/
|
|
340
|
+
'images'?: Array<ProductImagesInner>;
|
|
335
341
|
/**
|
|
336
342
|
* Variants
|
|
337
343
|
* @type {Array<ProductVariantsInner>}
|
|
@@ -383,6 +389,37 @@ export interface ProductAttributeValuesInner {
|
|
|
383
389
|
*/
|
|
384
390
|
'value': string;
|
|
385
391
|
}
|
|
392
|
+
/**
|
|
393
|
+
*
|
|
394
|
+
* @export
|
|
395
|
+
* @interface ProductImagesInner
|
|
396
|
+
*/
|
|
397
|
+
export interface ProductImagesInner {
|
|
398
|
+
/**
|
|
399
|
+
* Unique object identifier
|
|
400
|
+
* @type {string}
|
|
401
|
+
* @memberof ProductImagesInner
|
|
402
|
+
*/
|
|
403
|
+
'id': string;
|
|
404
|
+
/**
|
|
405
|
+
*
|
|
406
|
+
* @type {string}
|
|
407
|
+
* @memberof ProductImagesInner
|
|
408
|
+
*/
|
|
409
|
+
'src': string;
|
|
410
|
+
/**
|
|
411
|
+
*
|
|
412
|
+
* @type {string}
|
|
413
|
+
* @memberof ProductImagesInner
|
|
414
|
+
*/
|
|
415
|
+
'alt'?: string;
|
|
416
|
+
/**
|
|
417
|
+
*
|
|
418
|
+
* @type {number}
|
|
419
|
+
* @memberof ProductImagesInner
|
|
420
|
+
*/
|
|
421
|
+
'sortOrder'?: number;
|
|
422
|
+
}
|
|
386
423
|
/**
|
|
387
424
|
*
|
|
388
425
|
* @export
|
|
@@ -735,6 +772,16 @@ export interface VariantsResponse {
|
|
|
735
772
|
* @export
|
|
736
773
|
*/
|
|
737
774
|
export declare const ProductsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
775
|
+
/**
|
|
776
|
+
* Gets a GFN product by the given ID.
|
|
777
|
+
* @summary Get a GFN product
|
|
778
|
+
* @param {string} project What project it is
|
|
779
|
+
* @param {string} productId
|
|
780
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
781
|
+
* @param {*} [options] Override http request option.
|
|
782
|
+
* @throws {RequiredError}
|
|
783
|
+
*/
|
|
784
|
+
getProduct: (project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
738
785
|
/**
|
|
739
786
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
740
787
|
* @summary List GFN products
|
|
@@ -753,6 +800,16 @@ export declare const ProductsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
753
800
|
* @export
|
|
754
801
|
*/
|
|
755
802
|
export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
803
|
+
/**
|
|
804
|
+
* Gets a GFN product by the given ID.
|
|
805
|
+
* @summary Get a GFN product
|
|
806
|
+
* @param {string} project What project it is
|
|
807
|
+
* @param {string} productId
|
|
808
|
+
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
809
|
+
* @param {*} [options] Override http request option.
|
|
810
|
+
* @throws {RequiredError}
|
|
811
|
+
*/
|
|
812
|
+
getProduct(project: string, productId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
756
813
|
/**
|
|
757
814
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
758
815
|
* @summary List GFN products
|
|
@@ -771,6 +828,14 @@ export declare const ProductsApiFp: (configuration?: Configuration) => {
|
|
|
771
828
|
* @export
|
|
772
829
|
*/
|
|
773
830
|
export declare const ProductsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
831
|
+
/**
|
|
832
|
+
* Gets a GFN product by the given ID.
|
|
833
|
+
* @summary Get a GFN product
|
|
834
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
835
|
+
* @param {*} [options] Override http request option.
|
|
836
|
+
* @throws {RequiredError}
|
|
837
|
+
*/
|
|
838
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
774
839
|
/**
|
|
775
840
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
776
841
|
* @summary List GFN products
|
|
@@ -780,6 +845,31 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
780
845
|
*/
|
|
781
846
|
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
782
847
|
};
|
|
848
|
+
/**
|
|
849
|
+
* Request parameters for getProduct operation in ProductsApi.
|
|
850
|
+
* @export
|
|
851
|
+
* @interface ProductsApiGetProductRequest
|
|
852
|
+
*/
|
|
853
|
+
export interface ProductsApiGetProductRequest {
|
|
854
|
+
/**
|
|
855
|
+
* What project it is
|
|
856
|
+
* @type {string}
|
|
857
|
+
* @memberof ProductsApiGetProduct
|
|
858
|
+
*/
|
|
859
|
+
readonly project: string;
|
|
860
|
+
/**
|
|
861
|
+
*
|
|
862
|
+
* @type {string}
|
|
863
|
+
* @memberof ProductsApiGetProduct
|
|
864
|
+
*/
|
|
865
|
+
readonly productId: string;
|
|
866
|
+
/**
|
|
867
|
+
* Filter response fields to only include a subset of the resource.
|
|
868
|
+
* @type {string}
|
|
869
|
+
* @memberof ProductsApiGetProduct
|
|
870
|
+
*/
|
|
871
|
+
readonly fields?: string;
|
|
872
|
+
}
|
|
783
873
|
/**
|
|
784
874
|
* Request parameters for listProducts operation in ProductsApi.
|
|
785
875
|
* @export
|
|
@@ -824,6 +914,15 @@ export interface ProductsApiListProductsRequest {
|
|
|
824
914
|
* @extends {BaseAPI}
|
|
825
915
|
*/
|
|
826
916
|
export declare class ProductsApi extends BaseAPI {
|
|
917
|
+
/**
|
|
918
|
+
* Gets a GFN product by the given ID.
|
|
919
|
+
* @summary Get a GFN product
|
|
920
|
+
* @param {ProductsApiGetProductRequest} requestParameters Request parameters.
|
|
921
|
+
* @param {*} [options] Override http request option.
|
|
922
|
+
* @throws {RequiredError}
|
|
923
|
+
* @memberof ProductsApi
|
|
924
|
+
*/
|
|
925
|
+
getProduct(requestParameters: ProductsApiGetProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
827
926
|
/**
|
|
828
927
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
829
928
|
* @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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.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.5.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|