@teemill/gfn-catalog 2.0.0 → 2.0.2

package/dist/esm/api.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).
@@ -619,16 +619,49 @@ export declare const ProductsApiFactory: (configuration?: Configuration, basePat
     /**
      * 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: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options?: any): AxiosPromise<ProductsResponse>;
+    listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductsResponse>;
 };
+/**
+ * Request parameters for listProducts operation in ProductsApi.
+ * @export
+ * @interface ProductsApiListProductsRequest
+ */
+export interface ProductsApiListProductsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof ProductsApiListProducts
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof ProductsApiListProducts
+     */
+    readonly pageSize?: number;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly fields?: string;
+    /**
+     * Search terms to filter based on.
+     * @type {string}
+     * @memberof ProductsApiListProducts
+     */
+    readonly search?: string;
+}
 /**
  * ProductsApi - object-oriented interface
  * @export
@@ -639,16 +672,12 @@ export declare class ProductsApi extends 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: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
+    listProducts(requestParameters: ProductsApiListProductsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductsResponse, any>>;
 }
 /**
  * StatementsApi - axios parameter creator
@@ -710,24 +739,70 @@ export declare const StatementsApiFactory: (configuration?: Configuration, baseP
     /**
      * 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: string, statementId: string, options?: any): AxiosPromise<Statement>;
+    getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig): AxiosPromise<Statement>;
     /**
      * 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: string, pageToken?: number, pageSize?: number, search?: string, options?: any): AxiosPromise<ListStatements200Response>;
+    listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListStatements200Response>;
 };
+/**
+ * Request parameters for getStatement operation in StatementsApi.
+ * @export
+ * @interface StatementsApiGetStatementRequest
+ */
+export interface StatementsApiGetStatementRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof StatementsApiGetStatement
+     */
+    readonly project: string;
+    /**
+     *
+     * @type {string}
+     * @memberof StatementsApiGetStatement
+     */
+    readonly statementId: string;
+}
+/**
+ * Request parameters for listStatements operation in StatementsApi.
+ * @export
+ * @interface StatementsApiListStatementsRequest
+ */
+export interface StatementsApiListStatementsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof StatementsApiListStatements
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof StatementsApiListStatements
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof StatementsApiListStatements
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term used to filter results by
+     * @type {string}
+     * @memberof StatementsApiListStatements
+     */
+    readonly search?: string;
+}
 /**
  * StatementsApi - object-oriented interface
  * @export
@@ -738,25 +813,21 @@ export declare class StatementsApi extends 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: string, statementId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Statement, any>>;
+    getStatement(requestParameters: StatementsApiGetStatementRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Statement, any>>;
     /**
      * 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: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatements200Response, any>>;
+    listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatements200Response, any>>;
 }
 /**
  * TransactionsApi - axios parameter creator
@@ -818,24 +889,70 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
     /**
      * 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: string, exportTransactionsRequest: ExportTransactionsRequest, options?: any): AxiosPromise<File>;
+    exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
     /**
      * 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: string, pageToken?: number, pageSize?: number, statementId?: string, options?: any): AxiosPromise<ListTransactions200Response>;
+    listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactions200Response>;
 };
+/**
+ * Request parameters for exportTransactions operation in TransactionsApi.
+ * @export
+ * @interface TransactionsApiExportTransactionsRequest
+ */
+export interface TransactionsApiExportTransactionsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof TransactionsApiExportTransactions
+     */
+    readonly project: string;
+    /**
+     * Period selection data for the export
+     * @type {ExportTransactionsRequest}
+     * @memberof TransactionsApiExportTransactions
+     */
+    readonly exportTransactionsRequest: ExportTransactionsRequest;
+}
+/**
+ * Request parameters for listTransactions operation in TransactionsApi.
+ * @export
+ * @interface TransactionsApiListTransactionsRequest
+ */
+export interface TransactionsApiListTransactionsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof TransactionsApiListTransactions
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof TransactionsApiListTransactions
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof TransactionsApiListTransactions
+     */
+    readonly pageSize?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionsApiListTransactions
+     */
+    readonly statementId?: string;
+}
 /**
  * TransactionsApi - object-oriented interface
  * @export
@@ -846,25 +963,21 @@ export declare class TransactionsApi extends 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: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
     /**
      * 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: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactions200Response, any>>;
+    listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactions200Response, any>>;
 }
 /**
  * VariantsApi - axios parameter creator
@@ -974,48 +1087,160 @@ export declare const VariantsApiFactory: (configuration?: Configuration, basePat
     /**
      * 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: string, variantId: string, fulfillmentProjects?: string, options?: any): AxiosPromise<VariantStock>;
+    getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantStock>;
     /**
      * 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: string, variantId: string, fields?: string, options?: any): AxiosPromise<Variant>;
+    getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
     /**
      * 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: string, fulfillmentProjects?: string, pageToken?: number, pageSize?: number, search?: string, options?: any): AxiosPromise<StockResponse>;
+    listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig): AxiosPromise<StockResponse>;
     /**
      * 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: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options?: any): AxiosPromise<VariantsResponse>;
+    listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): AxiosPromise<VariantsResponse>;
 };
+/**
+ * Request parameters for getStock operation in VariantsApi.
+ * @export
+ * @interface VariantsApiGetStockRequest
+ */
+export interface VariantsApiGetStockRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof VariantsApiGetStock
+     */
+    readonly project: string;
+    /**
+     * Variants unique identifier
+     * @type {string}
+     * @memberof VariantsApiGetStock
+     */
+    readonly variantId: string;
+    /**
+     * Fetch stock levels from specific fulfiller projects
+     * @type {string}
+     * @memberof VariantsApiGetStock
+     */
+    readonly fulfillmentProjects?: string;
+}
+/**
+ * Request parameters for getVariant operation in VariantsApi.
+ * @export
+ * @interface VariantsApiGetVariantRequest
+ */
+export interface VariantsApiGetVariantRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof VariantsApiGetVariant
+     */
+    readonly project: string;
+    /**
+     * Variants unique identifier
+     * @type {string}
+     * @memberof VariantsApiGetVariant
+     */
+    readonly variantId: string;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof VariantsApiGetVariant
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for listStock operation in VariantsApi.
+ * @export
+ * @interface VariantsApiListStockRequest
+ */
+export interface VariantsApiListStockRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof VariantsApiListStock
+     */
+    readonly project: string;
+    /**
+     * Fetch stock levels from specific fulfiller projects
+     * @type {string}
+     * @memberof VariantsApiListStock
+     */
+    readonly fulfillmentProjects?: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof VariantsApiListStock
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof VariantsApiListStock
+     */
+    readonly pageSize?: number;
+    /**
+     * Search terms to filter based on.
+     * @type {string}
+     * @memberof VariantsApiListStock
+     */
+    readonly search?: string;
+}
+/**
+ * Request parameters for listVariants operation in VariantsApi.
+ * @export
+ * @interface VariantsApiListVariantsRequest
+ */
+export interface VariantsApiListVariantsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof VariantsApiListVariants
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof VariantsApiListVariants
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof VariantsApiListVariants
+     */
+    readonly pageSize?: number;
+    /**
+     * Filter response fields to only include a subset of the resource.
+     * @type {string}
+     * @memberof VariantsApiListVariants
+     */
+    readonly fields?: string;
+    /**
+     * Search terms to filter based on.
+     * @type {string}
+     * @memberof VariantsApiListVariants
+     */
+    readonly search?: string;
+}
 /**
  * VariantsApi - object-oriented interface
  * @export
@@ -1026,49 +1251,37 @@ export declare class VariantsApi extends 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: string, variantId: string, fulfillmentProjects?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantStock, any>>;
+    getStock(requestParameters: VariantsApiGetStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantStock, any>>;
     /**
      * 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: string, variantId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
+    getVariant(requestParameters: VariantsApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
     /**
      * 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: string, fulfillmentProjects?: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StockResponse, any>>;
+    listStock(requestParameters: VariantsApiListStockRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StockResponse, any>>;
     /**
      * 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: string, pageToken?: number, pageSize?: number, fields?: string, search?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
+    listVariants(requestParameters: VariantsApiListVariantsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VariantsResponse, any>>;
 }