@teemill/gfn-catalog 2.0.0 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -1
- package/README.md +2 -2
- package/api.ts +349 -103
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +298 -85
- package/dist/api.js +55 -103
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +298 -85
- package/dist/esm/api.js +55 -103
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/index.ts +1 -1
- package/package.json +1 -1
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.
|
|
7
|
+
* The version of the OpenAPI document: 2.0.2
|
|
8
8
|
* Contact: hello@teemill.com
|
|
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 Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.
|
|
7
|
+
* The version of the OpenAPI document: 2.0.2
|
|
8
8
|
* Contact: hello@teemill.com
|
|
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 Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.0.
|
|
7
|
+
* The version of the OpenAPI document: 2.0.2
|
|
8
8
|
* Contact: hello@teemill.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* Use this API to access the Global Fulfilment Network, which contains all the warehouse products and variants available to a given project. Warehouse products represent the base products that can be printed on. Products are the top level items, and variants are the different options available for each product. For example, a product might be a T-shirt, and each variant represents a different size and colour combination of that T-shirt. Use references to these warehouse products to create new product listings on your project via the Product Catalog API. Use the variant information to decide which options you would like to offer on each product listing.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.0.
|
|
5
|
+
* The version of the OpenAPI document: 2.0.2
|
|
6
6
|
* Contact: hello@teemill.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -619,16 +619,49 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
|
|
|
619
619
|
/**
|
|
620
620
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
621
621
|
* @summary List GFN products
|
|
622
|
-
* @param {
|
|
623
|
-
* @param {number} [pageToken] Page reference token
|
|
624
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
625
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
626
|
-
* @param {string} [search] Search terms to filter based on.
|
|
622
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
627
623
|
* @param {*} [options] Override http request option.
|
|
628
624
|
* @throws {RequiredError}
|
|
629
625
|
*/
|
|
630
|
-
listProducts(
|
|
626
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
|
|
631
627
|
};
|
|
628
|
+
/**
|
|
629
|
+
* Request parameters for listProducts operation in ProductsApi.
|
|
630
|
+
* @export
|
|
631
|
+
* @interface ProductsApiListProductsRequest
|
|
632
|
+
*/
|
|
633
|
+
export interface ProductsApiListProductsRequest {
|
|
634
|
+
/**
|
|
635
|
+
* What project it is
|
|
636
|
+
* @type {string}
|
|
637
|
+
* @memberof ProductsApiListProducts
|
|
638
|
+
*/
|
|
639
|
+
readonly project: string;
|
|
640
|
+
/**
|
|
641
|
+
* Page reference token
|
|
642
|
+
* @type {number}
|
|
643
|
+
* @memberof ProductsApiListProducts
|
|
644
|
+
*/
|
|
645
|
+
readonly pageToken?: number;
|
|
646
|
+
/**
|
|
647
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
648
|
+
* @type {number}
|
|
649
|
+
* @memberof ProductsApiListProducts
|
|
650
|
+
*/
|
|
651
|
+
readonly pageSize?: number;
|
|
652
|
+
/**
|
|
653
|
+
* Filter response fields to only include a subset of the resource.
|
|
654
|
+
* @type {string}
|
|
655
|
+
* @memberof ProductsApiListProducts
|
|
656
|
+
*/
|
|
657
|
+
readonly fields?: string;
|
|
658
|
+
/**
|
|
659
|
+
* Search terms to filter based on.
|
|
660
|
+
* @type {string}
|
|
661
|
+
* @memberof ProductsApiListProducts
|
|
662
|
+
*/
|
|
663
|
+
readonly search?: string;
|
|
664
|
+
}
|
|
632
665
|
/**
|
|
633
666
|
* ProductsApi - object-oriented interface
|
|
634
667
|
* @export
|
|
@@ -639,16 +672,12 @@ export declare class ProductsApi extends BaseAPI {
|
|
|
639
672
|
/**
|
|
640
673
|
* Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
|
|
641
674
|
* @summary List GFN products
|
|
642
|
-
* @param {
|
|
643
|
-
* @param {number} [pageToken] Page reference token
|
|
644
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
645
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
646
|
-
* @param {string} [search] Search terms to filter based on.
|
|
675
|
+
* @param {ProductsApiListProductsRequest} requestParameters Request parameters.
|
|
647
676
|
* @param {*} [options] Override http request option.
|
|
648
677
|
* @throws {RequiredError}
|
|
649
678
|
* @memberof ProductsApi
|
|
650
679
|
*/
|
|
651
|
-
listProducts(
|
|
680
|
+
listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
|
|
652
681
|
}
|
|
653
682
|
/**
|
|
654
683
|
* StatementsApi - axios parameter creator
|
|
@@ -710,24 +739,70 @@ export declare const StatementsApiFactory: (configuration?: Configuration, baseP
|
|
|
710
739
|
/**
|
|
711
740
|
* Gets a GFN statement by the given ID.
|
|
712
741
|
* @summary Get a GFN statement
|
|
713
|
-
* @param {
|
|
714
|
-
* @param {string} statementId
|
|
742
|
+
* @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
|
|
715
743
|
* @param {*} [options] Override http request option.
|
|
716
744
|
* @throws {RequiredError}
|
|
717
745
|
*/
|
|
718
|
-
getStatement(
|
|
746
|
+
getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig): AxiosPromise<Statement>;
|
|
719
747
|
/**
|
|
720
748
|
* Lists GFN statements available to the project
|
|
721
749
|
* @summary List GFN statements
|
|
722
|
-
* @param {
|
|
723
|
-
* @param {number} [pageToken] Page reference token
|
|
724
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
725
|
-
* @param {string} [search] Search term used to filter results by
|
|
750
|
+
* @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
|
|
726
751
|
* @param {*} [options] Override http request option.
|
|
727
752
|
* @throws {RequiredError}
|
|
728
753
|
*/
|
|
729
|
-
listStatements(
|
|
754
|
+
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListStatements200Response>;
|
|
730
755
|
};
|
|
756
|
+
/**
|
|
757
|
+
* Request parameters for getStatement operation in StatementsApi.
|
|
758
|
+
* @export
|
|
759
|
+
* @interface StatementsApiGetStatementRequest
|
|
760
|
+
*/
|
|
761
|
+
export interface StatementsApiGetStatementRequest {
|
|
762
|
+
/**
|
|
763
|
+
* What project it is
|
|
764
|
+
* @type {string}
|
|
765
|
+
* @memberof StatementsApiGetStatement
|
|
766
|
+
*/
|
|
767
|
+
readonly project: string;
|
|
768
|
+
/**
|
|
769
|
+
*
|
|
770
|
+
* @type {string}
|
|
771
|
+
* @memberof StatementsApiGetStatement
|
|
772
|
+
*/
|
|
773
|
+
readonly statementId: string;
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
* Request parameters for listStatements operation in StatementsApi.
|
|
777
|
+
* @export
|
|
778
|
+
* @interface StatementsApiListStatementsRequest
|
|
779
|
+
*/
|
|
780
|
+
export interface StatementsApiListStatementsRequest {
|
|
781
|
+
/**
|
|
782
|
+
* What project it is
|
|
783
|
+
* @type {string}
|
|
784
|
+
* @memberof StatementsApiListStatements
|
|
785
|
+
*/
|
|
786
|
+
readonly project: string;
|
|
787
|
+
/**
|
|
788
|
+
* Page reference token
|
|
789
|
+
* @type {number}
|
|
790
|
+
* @memberof StatementsApiListStatements
|
|
791
|
+
*/
|
|
792
|
+
readonly pageToken?: number;
|
|
793
|
+
/**
|
|
794
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
795
|
+
* @type {number}
|
|
796
|
+
* @memberof StatementsApiListStatements
|
|
797
|
+
*/
|
|
798
|
+
readonly pageSize?: number;
|
|
799
|
+
/**
|
|
800
|
+
* Search term used to filter results by
|
|
801
|
+
* @type {string}
|
|
802
|
+
* @memberof StatementsApiListStatements
|
|
803
|
+
*/
|
|
804
|
+
readonly search?: string;
|
|
805
|
+
}
|
|
731
806
|
/**
|
|
732
807
|
* StatementsApi - object-oriented interface
|
|
733
808
|
* @export
|
|
@@ -738,25 +813,21 @@ export declare class StatementsApi extends BaseAPI {
|
|
|
738
813
|
/**
|
|
739
814
|
* Gets a GFN statement by the given ID.
|
|
740
815
|
* @summary Get a GFN statement
|
|
741
|
-
* @param {
|
|
742
|
-
* @param {string} statementId
|
|
816
|
+
* @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
|
|
743
817
|
* @param {*} [options] Override http request option.
|
|
744
818
|
* @throws {RequiredError}
|
|
745
819
|
* @memberof StatementsApi
|
|
746
820
|
*/
|
|
747
|
-
getStatement(
|
|
821
|
+
getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Statement, any>>;
|
|
748
822
|
/**
|
|
749
823
|
* Lists GFN statements available to the project
|
|
750
824
|
* @summary List GFN statements
|
|
751
|
-
* @param {
|
|
752
|
-
* @param {number} [pageToken] Page reference token
|
|
753
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
754
|
-
* @param {string} [search] Search term used to filter results by
|
|
825
|
+
* @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
|
|
755
826
|
* @param {*} [options] Override http request option.
|
|
756
827
|
* @throws {RequiredError}
|
|
757
828
|
* @memberof StatementsApi
|
|
758
829
|
*/
|
|
759
|
-
listStatements(
|
|
830
|
+
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatements200Response, any>>;
|
|
760
831
|
}
|
|
761
832
|
/**
|
|
762
833
|
* TransactionsApi - axios parameter creator
|
|
@@ -818,24 +889,70 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
|
|
|
818
889
|
/**
|
|
819
890
|
* Exports all GFN transactions available to the project
|
|
820
891
|
* @summary Export GFN transactions
|
|
821
|
-
* @param {
|
|
822
|
-
* @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
|
|
892
|
+
* @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
|
|
823
893
|
* @param {*} [options] Override http request option.
|
|
824
894
|
* @throws {RequiredError}
|
|
825
895
|
*/
|
|
826
|
-
exportTransactions(
|
|
896
|
+
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
827
897
|
/**
|
|
828
898
|
* Lists all GFN transactions available to the project
|
|
829
899
|
* @summary List GFN transactions
|
|
830
|
-
* @param {
|
|
831
|
-
* @param {number} [pageToken] Page reference token
|
|
832
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
833
|
-
* @param {string} [statementId]
|
|
900
|
+
* @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
|
|
834
901
|
* @param {*} [options] Override http request option.
|
|
835
902
|
* @throws {RequiredError}
|
|
836
903
|
*/
|
|
837
|
-
listTransactions(
|
|
904
|
+
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactions200Response>;
|
|
838
905
|
};
|
|
906
|
+
/**
|
|
907
|
+
* Request parameters for exportTransactions operation in TransactionsApi.
|
|
908
|
+
* @export
|
|
909
|
+
* @interface TransactionsApiExportTransactionsRequest
|
|
910
|
+
*/
|
|
911
|
+
export interface TransactionsApiExportTransactionsRequest {
|
|
912
|
+
/**
|
|
913
|
+
* What project it is
|
|
914
|
+
* @type {string}
|
|
915
|
+
* @memberof TransactionsApiExportTransactions
|
|
916
|
+
*/
|
|
917
|
+
readonly project: string;
|
|
918
|
+
/**
|
|
919
|
+
* Period selection data for the export
|
|
920
|
+
* @type {ExportTransactionsRequest}
|
|
921
|
+
* @memberof TransactionsApiExportTransactions
|
|
922
|
+
*/
|
|
923
|
+
readonly exportTransactionsRequest: ExportTransactionsRequest;
|
|
924
|
+
}
|
|
925
|
+
/**
|
|
926
|
+
* Request parameters for listTransactions operation in TransactionsApi.
|
|
927
|
+
* @export
|
|
928
|
+
* @interface TransactionsApiListTransactionsRequest
|
|
929
|
+
*/
|
|
930
|
+
export interface TransactionsApiListTransactionsRequest {
|
|
931
|
+
/**
|
|
932
|
+
* What project it is
|
|
933
|
+
* @type {string}
|
|
934
|
+
* @memberof TransactionsApiListTransactions
|
|
935
|
+
*/
|
|
936
|
+
readonly project: string;
|
|
937
|
+
/**
|
|
938
|
+
* Page reference token
|
|
939
|
+
* @type {number}
|
|
940
|
+
* @memberof TransactionsApiListTransactions
|
|
941
|
+
*/
|
|
942
|
+
readonly pageToken?: number;
|
|
943
|
+
/**
|
|
944
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
945
|
+
* @type {number}
|
|
946
|
+
* @memberof TransactionsApiListTransactions
|
|
947
|
+
*/
|
|
948
|
+
readonly pageSize?: number;
|
|
949
|
+
/**
|
|
950
|
+
*
|
|
951
|
+
* @type {string}
|
|
952
|
+
* @memberof TransactionsApiListTransactions
|
|
953
|
+
*/
|
|
954
|
+
readonly statementId?: string;
|
|
955
|
+
}
|
|
839
956
|
/**
|
|
840
957
|
* TransactionsApi - object-oriented interface
|
|
841
958
|
* @export
|
|
@@ -846,25 +963,21 @@ export declare class TransactionsApi extends BaseAPI {
|
|
|
846
963
|
/**
|
|
847
964
|
* Exports all GFN transactions available to the project
|
|
848
965
|
* @summary Export GFN transactions
|
|
849
|
-
* @param {
|
|
850
|
-
* @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
|
|
966
|
+
* @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
|
|
851
967
|
* @param {*} [options] Override http request option.
|
|
852
968
|
* @throws {RequiredError}
|
|
853
969
|
* @memberof TransactionsApi
|
|
854
970
|
*/
|
|
855
|
-
exportTransactions(
|
|
971
|
+
exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
856
972
|
/**
|
|
857
973
|
* Lists all GFN transactions available to the project
|
|
858
974
|
* @summary List GFN transactions
|
|
859
|
-
* @param {
|
|
860
|
-
* @param {number} [pageToken] Page reference token
|
|
861
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
862
|
-
* @param {string} [statementId]
|
|
975
|
+
* @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
|
|
863
976
|
* @param {*} [options] Override http request option.
|
|
864
977
|
* @throws {RequiredError}
|
|
865
978
|
* @memberof TransactionsApi
|
|
866
979
|
*/
|
|
867
|
-
listTransactions(
|
|
980
|
+
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactions200Response, any>>;
|
|
868
981
|
}
|
|
869
982
|
/**
|
|
870
983
|
* VariantsApi - axios parameter creator
|
|
@@ -974,48 +1087,160 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
|
|
|
974
1087
|
/**
|
|
975
1088
|
* Gets the stock level for the GFN variant with the given ID.
|
|
976
1089
|
* @summary Get GFN variant stock
|
|
977
|
-
* @param {
|
|
978
|
-
* @param {string} variantId Variants unique identifier
|
|
979
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1090
|
+
* @param {VariantsApiGetStockRequest} requestParameters Request parameters.
|
|
980
1091
|
* @param {*} [options] Override http request option.
|
|
981
1092
|
* @throws {RequiredError}
|
|
982
1093
|
*/
|
|
983
|
-
getStock(
|
|
1094
|
+
getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantStock>;
|
|
984
1095
|
/**
|
|
985
1096
|
* Gets a GFN variant by the given ID.
|
|
986
1097
|
* @summary Get a GFN variant
|
|
987
|
-
* @param {
|
|
988
|
-
* @param {string} variantId Variants unique identifier
|
|
989
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1098
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
990
1099
|
* @param {*} [options] Override http request option.
|
|
991
1100
|
* @throws {RequiredError}
|
|
992
1101
|
*/
|
|
993
|
-
getVariant(
|
|
1102
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
|
|
994
1103
|
/**
|
|
995
1104
|
* Lists the stock levels for all GFN variants available to the project.
|
|
996
1105
|
* @summary List GFN variant stock
|
|
997
|
-
* @param {
|
|
998
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
999
|
-
* @param {number} [pageToken] Page reference token
|
|
1000
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1001
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1106
|
+
* @param {VariantsApiListStockRequest} requestParameters Request parameters.
|
|
1002
1107
|
* @param {*} [options] Override http request option.
|
|
1003
1108
|
* @throws {RequiredError}
|
|
1004
1109
|
*/
|
|
1005
|
-
listStock(
|
|
1110
|
+
listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<StockResponse>;
|
|
1006
1111
|
/**
|
|
1007
1112
|
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1008
1113
|
* @summary List GFN variants
|
|
1009
|
-
* @param {
|
|
1010
|
-
* @param {number} [pageToken] Page reference token
|
|
1011
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1012
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1013
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1114
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1014
1115
|
* @param {*} [options] Override http request option.
|
|
1015
1116
|
* @throws {RequiredError}
|
|
1016
1117
|
*/
|
|
1017
|
-
listVariants(
|
|
1118
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse>;
|
|
1018
1119
|
};
|
|
1120
|
+
/**
|
|
1121
|
+
* Request parameters for getStock operation in VariantsApi.
|
|
1122
|
+
* @export
|
|
1123
|
+
* @interface VariantsApiGetStockRequest
|
|
1124
|
+
*/
|
|
1125
|
+
export interface VariantsApiGetStockRequest {
|
|
1126
|
+
/**
|
|
1127
|
+
* What project it is
|
|
1128
|
+
* @type {string}
|
|
1129
|
+
* @memberof VariantsApiGetStock
|
|
1130
|
+
*/
|
|
1131
|
+
readonly project: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* Variants unique identifier
|
|
1134
|
+
* @type {string}
|
|
1135
|
+
* @memberof VariantsApiGetStock
|
|
1136
|
+
*/
|
|
1137
|
+
readonly variantId: string;
|
|
1138
|
+
/**
|
|
1139
|
+
* Fetch stock levels from specific fulfiller projects
|
|
1140
|
+
* @type {string}
|
|
1141
|
+
* @memberof VariantsApiGetStock
|
|
1142
|
+
*/
|
|
1143
|
+
readonly fulfillmentProjects?: string;
|
|
1144
|
+
}
|
|
1145
|
+
/**
|
|
1146
|
+
* Request parameters for getVariant operation in VariantsApi.
|
|
1147
|
+
* @export
|
|
1148
|
+
* @interface VariantsApiGetVariantRequest
|
|
1149
|
+
*/
|
|
1150
|
+
export interface VariantsApiGetVariantRequest {
|
|
1151
|
+
/**
|
|
1152
|
+
* What project it is
|
|
1153
|
+
* @type {string}
|
|
1154
|
+
* @memberof VariantsApiGetVariant
|
|
1155
|
+
*/
|
|
1156
|
+
readonly project: string;
|
|
1157
|
+
/**
|
|
1158
|
+
* Variants unique identifier
|
|
1159
|
+
* @type {string}
|
|
1160
|
+
* @memberof VariantsApiGetVariant
|
|
1161
|
+
*/
|
|
1162
|
+
readonly variantId: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* Filter response fields to only include a subset of the resource.
|
|
1165
|
+
* @type {string}
|
|
1166
|
+
* @memberof VariantsApiGetVariant
|
|
1167
|
+
*/
|
|
1168
|
+
readonly fields?: string;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
* Request parameters for listStock operation in VariantsApi.
|
|
1172
|
+
* @export
|
|
1173
|
+
* @interface VariantsApiListStockRequest
|
|
1174
|
+
*/
|
|
1175
|
+
export interface VariantsApiListStockRequest {
|
|
1176
|
+
/**
|
|
1177
|
+
* What project it is
|
|
1178
|
+
* @type {string}
|
|
1179
|
+
* @memberof VariantsApiListStock
|
|
1180
|
+
*/
|
|
1181
|
+
readonly project: string;
|
|
1182
|
+
/**
|
|
1183
|
+
* Fetch stock levels from specific fulfiller projects
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof VariantsApiListStock
|
|
1186
|
+
*/
|
|
1187
|
+
readonly fulfillmentProjects?: string;
|
|
1188
|
+
/**
|
|
1189
|
+
* Page reference token
|
|
1190
|
+
* @type {number}
|
|
1191
|
+
* @memberof VariantsApiListStock
|
|
1192
|
+
*/
|
|
1193
|
+
readonly pageToken?: number;
|
|
1194
|
+
/**
|
|
1195
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1196
|
+
* @type {number}
|
|
1197
|
+
* @memberof VariantsApiListStock
|
|
1198
|
+
*/
|
|
1199
|
+
readonly pageSize?: number;
|
|
1200
|
+
/**
|
|
1201
|
+
* Search terms to filter based on.
|
|
1202
|
+
* @type {string}
|
|
1203
|
+
* @memberof VariantsApiListStock
|
|
1204
|
+
*/
|
|
1205
|
+
readonly search?: string;
|
|
1206
|
+
}
|
|
1207
|
+
/**
|
|
1208
|
+
* Request parameters for listVariants operation in VariantsApi.
|
|
1209
|
+
* @export
|
|
1210
|
+
* @interface VariantsApiListVariantsRequest
|
|
1211
|
+
*/
|
|
1212
|
+
export interface VariantsApiListVariantsRequest {
|
|
1213
|
+
/**
|
|
1214
|
+
* What project it is
|
|
1215
|
+
* @type {string}
|
|
1216
|
+
* @memberof VariantsApiListVariants
|
|
1217
|
+
*/
|
|
1218
|
+
readonly project: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* Page reference token
|
|
1221
|
+
* @type {number}
|
|
1222
|
+
* @memberof VariantsApiListVariants
|
|
1223
|
+
*/
|
|
1224
|
+
readonly pageToken?: number;
|
|
1225
|
+
/**
|
|
1226
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1227
|
+
* @type {number}
|
|
1228
|
+
* @memberof VariantsApiListVariants
|
|
1229
|
+
*/
|
|
1230
|
+
readonly pageSize?: number;
|
|
1231
|
+
/**
|
|
1232
|
+
* Filter response fields to only include a subset of the resource.
|
|
1233
|
+
* @type {string}
|
|
1234
|
+
* @memberof VariantsApiListVariants
|
|
1235
|
+
*/
|
|
1236
|
+
readonly fields?: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* Search terms to filter based on.
|
|
1239
|
+
* @type {string}
|
|
1240
|
+
* @memberof VariantsApiListVariants
|
|
1241
|
+
*/
|
|
1242
|
+
readonly search?: string;
|
|
1243
|
+
}
|
|
1019
1244
|
/**
|
|
1020
1245
|
* VariantsApi - object-oriented interface
|
|
1021
1246
|
* @export
|
|
@@ -1026,49 +1251,37 @@ export declare class VariantsApi extends BaseAPI {
|
|
|
1026
1251
|
/**
|
|
1027
1252
|
* Gets the stock level for the GFN variant with the given ID.
|
|
1028
1253
|
* @summary Get GFN variant stock
|
|
1029
|
-
* @param {
|
|
1030
|
-
* @param {string} variantId Variants unique identifier
|
|
1031
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1254
|
+
* @param {VariantsApiGetStockRequest} requestParameters Request parameters.
|
|
1032
1255
|
* @param {*} [options] Override http request option.
|
|
1033
1256
|
* @throws {RequiredError}
|
|
1034
1257
|
* @memberof VariantsApi
|
|
1035
1258
|
*/
|
|
1036
|
-
getStock(
|
|
1259
|
+
getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantStock, any>>;
|
|
1037
1260
|
/**
|
|
1038
1261
|
* Gets a GFN variant by the given ID.
|
|
1039
1262
|
* @summary Get a GFN variant
|
|
1040
|
-
* @param {
|
|
1041
|
-
* @param {string} variantId Variants unique identifier
|
|
1042
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1263
|
+
* @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
|
|
1043
1264
|
* @param {*} [options] Override http request option.
|
|
1044
1265
|
* @throws {RequiredError}
|
|
1045
1266
|
* @memberof VariantsApi
|
|
1046
1267
|
*/
|
|
1047
|
-
getVariant(
|
|
1268
|
+
getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
1048
1269
|
/**
|
|
1049
1270
|
* Lists the stock levels for all GFN variants available to the project.
|
|
1050
1271
|
* @summary List GFN variant stock
|
|
1051
|
-
* @param {
|
|
1052
|
-
* @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
|
|
1053
|
-
* @param {number} [pageToken] Page reference token
|
|
1054
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1055
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1272
|
+
* @param {VariantsApiListStockRequest} requestParameters Request parameters.
|
|
1056
1273
|
* @param {*} [options] Override http request option.
|
|
1057
1274
|
* @throws {RequiredError}
|
|
1058
1275
|
* @memberof VariantsApi
|
|
1059
1276
|
*/
|
|
1060
|
-
listStock(
|
|
1277
|
+
listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StockResponse, any>>;
|
|
1061
1278
|
/**
|
|
1062
1279
|
* Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
|
|
1063
1280
|
* @summary List GFN variants
|
|
1064
|
-
* @param {
|
|
1065
|
-
* @param {number} [pageToken] Page reference token
|
|
1066
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1067
|
-
* @param {string} [fields] Filter response fields to only include a subset of the resource.
|
|
1068
|
-
* @param {string} [search] Search terms to filter based on.
|
|
1281
|
+
* @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
|
|
1069
1282
|
* @param {*} [options] Override http request option.
|
|
1070
1283
|
* @throws {RequiredError}
|
|
1071
1284
|
* @memberof VariantsApi
|
|
1072
1285
|
*/
|
|
1073
|
-
listVariants(
|
|
1286
|
+
listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
|
|
1074
1287
|
}
|