@teemill/gfn-catalog 2.0.0 → 2.0.2

package/dist/api.js

@@ -5,7 +5,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -135,16 +135,12 @@ const ProductsApiFactory = function (configuration, basePath, axios) {
         /**
          * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
          * @summary List GFN products
-         * @param {string} project What project it is
-         * @param {number} [pageToken] Page reference token
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [fields] Filter response fields to only include a subset of the resource.
-         * @param {string} [search] Search terms to filter based on.
+         * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listProducts(project, pageToken, pageSize, fields, search, options) {
-            return localVarFp.listProducts(project, pageToken, pageSize, fields, search, options).then((request) => request(axios, basePath));
+        listProducts(requestParameters, options) {
+            return localVarFp.listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -159,17 +155,13 @@ class ProductsApi extends base_1.BaseAPI {
     /**
      * Lists all GFN products available to the project. Can be filtered by style codes using the search parameter.
      * @summary List GFN products
-     * @param {string} project What project it is
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
-     * @param {string} [search] Search terms to filter based on.
+     * @param {ProductsApiListProductsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof ProductsApi
      */
-    listProducts(project, pageToken, pageSize, fields, search, options) {
-        return (0, exports.ProductsApiFp)(this.configuration).listProducts(project, pageToken, pageSize, fields, search, options).then((request) => request(this.axios, this.basePath));
+    listProducts(requestParameters, options) {
+        return (0, exports.ProductsApiFp)(this.configuration).listProducts(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.ProductsApi = ProductsApi;
@@ -326,26 +318,22 @@ const StatementsApiFactory = function (configuration, basePath, axios) {
         /**
          * Gets a GFN statement by the given ID.
          * @summary Get a GFN statement
-         * @param {string} project What project it is
-         * @param {string} statementId
+         * @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getStatement(project, statementId, options) {
-            return localVarFp.getStatement(project, statementId, options).then((request) => request(axios, basePath));
+        getStatement(requestParameters, options) {
+            return localVarFp.getStatement(requestParameters.project, requestParameters.statementId, options).then((request) => request(axios, basePath));
         },
         /**
          * Lists GFN statements available to the project
          * @summary List GFN statements
-         * @param {string} project What project it is
-         * @param {number} [pageToken] Page reference token
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search term used to filter results by
+         * @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listStatements(project, pageToken, pageSize, search, options) {
-            return localVarFp.listStatements(project, pageToken, pageSize, search, options).then((request) => request(axios, basePath));
+        listStatements(requestParameters, options) {
+            return localVarFp.listStatements(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -360,28 +348,24 @@ class StatementsApi extends base_1.BaseAPI {
     /**
      * Gets a GFN statement by the given ID.
      * @summary Get a GFN statement
-     * @param {string} project What project it is
-     * @param {string} statementId
+     * @param {StatementsApiGetStatementRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StatementsApi
      */
-    getStatement(project, statementId, options) {
-        return (0, exports.StatementsApiFp)(this.configuration).getStatement(project, statementId, options).then((request) => request(this.axios, this.basePath));
+    getStatement(requestParameters, options) {
+        return (0, exports.StatementsApiFp)(this.configuration).getStatement(requestParameters.project, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Lists GFN statements available to the project
      * @summary List GFN statements
-     * @param {string} project What project it is
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [search] Search term used to filter results by
+     * @param {StatementsApiListStatementsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof StatementsApi
      */
-    listStatements(project, pageToken, pageSize, search, options) {
-        return (0, exports.StatementsApiFp)(this.configuration).listStatements(project, pageToken, pageSize, search, options).then((request) => request(this.axios, this.basePath));
+    listStatements(requestParameters, options) {
+        return (0, exports.StatementsApiFp)(this.configuration).listStatements(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.StatementsApi = StatementsApi;
@@ -539,26 +523,22 @@ const TransactionsApiFactory = function (configuration, basePath, axios) {
         /**
          * Exports all GFN transactions available to the project
          * @summary Export GFN transactions
-         * @param {string} project What project it is
-         * @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
+         * @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        exportTransactions(project, exportTransactionsRequest, options) {
-            return localVarFp.exportTransactions(project, exportTransactionsRequest, options).then((request) => request(axios, basePath));
+        exportTransactions(requestParameters, options) {
+            return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
         },
         /**
          * Lists all GFN transactions available to the project
          * @summary List GFN transactions
-         * @param {string} project What project it is
-         * @param {number} [pageToken] Page reference token
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [statementId]
+         * @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listTransactions(project, pageToken, pageSize, statementId, options) {
-            return localVarFp.listTransactions(project, pageToken, pageSize, statementId, options).then((request) => request(axios, basePath));
+        listTransactions(requestParameters, options) {
+            return localVarFp.listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -573,28 +553,24 @@ class TransactionsApi extends base_1.BaseAPI {
     /**
      * Exports all GFN transactions available to the project
      * @summary Export GFN transactions
-     * @param {string} project What project it is
-     * @param {ExportTransactionsRequest} exportTransactionsRequest Period selection data for the export
+     * @param {TransactionsApiExportTransactionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TransactionsApi
      */
-    exportTransactions(project, exportTransactionsRequest, options) {
-        return (0, exports.TransactionsApiFp)(this.configuration).exportTransactions(project, exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
+    exportTransactions(requestParameters, options) {
+        return (0, exports.TransactionsApiFp)(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
-     * @param {string} project What project it is
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [statementId]
+     * @param {TransactionsApiListTransactionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof TransactionsApi
      */
-    listTransactions(project, pageToken, pageSize, statementId, options) {
-        return (0, exports.TransactionsApiFp)(this.configuration).listTransactions(project, pageToken, pageSize, statementId, options).then((request) => request(this.axios, this.basePath));
+    listTransactions(requestParameters, options) {
+        return (0, exports.TransactionsApiFp)(this.configuration).listTransactions(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.TransactionsApi = TransactionsApi;
@@ -895,54 +871,42 @@ const VariantsApiFactory = function (configuration, basePath, axios) {
         /**
          * Gets the stock level for the GFN variant with the given ID.
          * @summary Get GFN variant stock
-         * @param {string} project What project it is
-         * @param {string} variantId Variants unique identifier
-         * @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
+         * @param {VariantsApiGetStockRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getStock(project, variantId, fulfillmentProjects, options) {
-            return localVarFp.getStock(project, variantId, fulfillmentProjects, options).then((request) => request(axios, basePath));
+        getStock(requestParameters, options) {
+            return localVarFp.getStock(requestParameters.project, requestParameters.variantId, requestParameters.fulfillmentProjects, options).then((request) => request(axios, basePath));
         },
         /**
          * Gets a GFN variant by the given ID.
          * @summary Get a GFN variant
-         * @param {string} project What project it is
-         * @param {string} variantId Variants unique identifier
-         * @param {string} [fields] Filter response fields to only include a subset of the resource.
+         * @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getVariant(project, variantId, fields, options) {
-            return localVarFp.getVariant(project, variantId, fields, options).then((request) => request(axios, basePath));
+        getVariant(requestParameters, options) {
+            return localVarFp.getVariant(requestParameters.project, requestParameters.variantId, requestParameters.fields, options).then((request) => request(axios, basePath));
         },
         /**
          * Lists the stock levels for all GFN variants available to the project.
          * @summary List GFN variant stock
-         * @param {string} project What project it is
-         * @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
-         * @param {number} [pageToken] Page reference token
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [search] Search terms to filter based on.
+         * @param {VariantsApiListStockRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listStock(project, fulfillmentProjects, pageToken, pageSize, search, options) {
-            return localVarFp.listStock(project, fulfillmentProjects, pageToken, pageSize, search, options).then((request) => request(axios, basePath));
+        listStock(requestParameters, options) {
+            return localVarFp.listStock(requestParameters.project, requestParameters.fulfillmentProjects, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
         },
         /**
          * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
          * @summary List GFN variants
-         * @param {string} project What project it is
-         * @param {number} [pageToken] Page reference token
-         * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-         * @param {string} [fields] Filter response fields to only include a subset of the resource.
-         * @param {string} [search] Search terms to filter based on.
+         * @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listVariants(project, pageToken, pageSize, fields, search, options) {
-            return localVarFp.listVariants(project, pageToken, pageSize, fields, search, options).then((request) => request(axios, basePath));
+        listVariants(requestParameters, options) {
+            return localVarFp.listVariants(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -957,58 +921,46 @@ class VariantsApi extends base_1.BaseAPI {
     /**
      * Gets the stock level for the GFN variant with the given ID.
      * @summary Get GFN variant stock
-     * @param {string} project What project it is
-     * @param {string} variantId Variants unique identifier
-     * @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
+     * @param {VariantsApiGetStockRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VariantsApi
      */
-    getStock(project, variantId, fulfillmentProjects, options) {
-        return (0, exports.VariantsApiFp)(this.configuration).getStock(project, variantId, fulfillmentProjects, options).then((request) => request(this.axios, this.basePath));
+    getStock(requestParameters, options) {
+        return (0, exports.VariantsApiFp)(this.configuration).getStock(requestParameters.project, requestParameters.variantId, requestParameters.fulfillmentProjects, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Gets a GFN variant by the given ID.
      * @summary Get a GFN variant
-     * @param {string} project What project it is
-     * @param {string} variantId Variants unique identifier
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
+     * @param {VariantsApiGetVariantRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VariantsApi
      */
-    getVariant(project, variantId, fields, options) {
-        return (0, exports.VariantsApiFp)(this.configuration).getVariant(project, variantId, fields, options).then((request) => request(this.axios, this.basePath));
+    getVariant(requestParameters, options) {
+        return (0, exports.VariantsApiFp)(this.configuration).getVariant(requestParameters.project, requestParameters.variantId, requestParameters.fields, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Lists the stock levels for all GFN variants available to the project.
      * @summary List GFN variant stock
-     * @param {string} project What project it is
-     * @param {string} [fulfillmentProjects] Fetch stock levels from specific fulfiller projects
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [search] Search terms to filter based on.
+     * @param {VariantsApiListStockRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VariantsApi
      */
-    listStock(project, fulfillmentProjects, pageToken, pageSize, search, options) {
-        return (0, exports.VariantsApiFp)(this.configuration).listStock(project, fulfillmentProjects, pageToken, pageSize, search, options).then((request) => request(this.axios, this.basePath));
+    listStock(requestParameters, options) {
+        return (0, exports.VariantsApiFp)(this.configuration).listStock(requestParameters.project, requestParameters.fulfillmentProjects, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Lists all GFN variants available to the project. Can be filtered by product ID, SKU, and attribute values using the search parameter.
      * @summary List GFN variants
-     * @param {string} project What project it is
-     * @param {number} [pageToken] Page reference token
-     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {string} [fields] Filter response fields to only include a subset of the resource.
-     * @param {string} [search] Search terms to filter based on.
+     * @param {VariantsApiListVariantsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof VariantsApi
      */
-    listVariants(project, pageToken, pageSize, fields, search, options) {
-        return (0, exports.VariantsApiFp)(this.configuration).listVariants(project, pageToken, pageSize, fields, search, options).then((request) => request(this.axios, this.basePath));
+    listVariants(requestParameters, options) {
+        return (0, exports.VariantsApiFp)(this.configuration).listVariants(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.fields, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
     }
 }
 exports.VariantsApi = VariantsApi;

package/dist/base.d.ts

@@ -2,7 +2,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/base.js

@@ -5,7 +5,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.d.ts

@@ -2,7 +2,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/common.js

@@ -5,7 +5,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.d.ts

@@ -2,7 +2,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/configuration.js

@@ -5,7 +5,7 @@
  * GFN Catalog API
  * 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.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.0.2
  * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).