@teemill/gfn-catalog 2.2.0 → 3.1.0

package/README.md

@@ -1,4 +1,4 @@
-## @teemill/gfn-catalog@2.2.0
+## @teemill/gfn-catalog@3.1.0
 
 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:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @teemill/gfn-catalog@2.2.0 --save
+npm install @teemill/gfn-catalog@3.1.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -2,10 +2,10 @@
 /* eslint-disable */
 /**
  * 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.
+ * 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.
  *
- * The version of the OpenAPI document: 2.2.0
- * Contact: hello@teemill.com
+ * The version of the OpenAPI document: 3.1.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -127,23 +127,42 @@ export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof
  */
 export interface ExportTransactionsRequest {
     /**
-     * The start date for the export
+     * Include only transactions from this statement
      * @type {string}
      * @memberof ExportTransactionsRequest
      */
-    'start'?: string;
+    'statement'?: string;
+}
+/**
+ * 
+ * @export
+ * @interface Fulfillment
+ */
+export interface Fulfillment {
     /**
-     * The end date for the export
+     * 
+     * @type {number}
+     * @memberof Fulfillment
+     */
+    'id': number;
+    /**
+     * 
      * @type {string}
-     * @memberof ExportTransactionsRequest
+     * @memberof Fulfillment
      */
-    'end'?: string;
+    'merchantRef': string;
     /**
-     * Include only transactions from this statement
+     * 
+     * @type {number}
+     * @memberof Fulfillment
+     */
+    'total': number;
+    /**
+     * 
      * @type {string}
-     * @memberof ExportTransactionsRequest
+     * @memberof Fulfillment
      */
-    'statement'?: string;
+    'createdAt': string;
 }
 /**
  * Image description
@@ -194,6 +213,25 @@ export interface Image {
      */
     'updatedAt'?: string;
 }
+/**
+ * 
+ * @export
+ * @interface ListFulfillments200Response
+ */
+export interface ListFulfillments200Response {
+    /**
+     * 
+     * @type {Array<Fulfillment>}
+     * @memberof ListFulfillments200Response
+     */
+    'fulfillments'?: Array<Fulfillment>;
+    /**
+     * 
+     * @type {number}
+     * @memberof ListFulfillments200Response
+     */
+    'nextPageToken'?: number | null;
+}
 /**
  * 
  * @export
@@ -348,6 +386,12 @@ export interface Statement {
      * @memberof Statement
      */
     'fulfillmentCount': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof Statement
+     */
+    'issuedAt'?: string;
 }
 /**
  * 
@@ -1111,6 +1155,65 @@ export const TransactionsApiAxiosParamCreator = function (configuration?: Config
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Lists all the fulfillments in the project with GFN transactions
+         * @summary Lists the GFN fulfillments of the project
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listFulfillments: async (project: string, pageToken?: number, pageSize?: number, statementId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'project' is not null or undefined
+            assertParamExists('listFulfillments', 'project', project)
+            const localVarPath = `/v1/gfn/transactions/fulfillments`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication session-oauth required
+            // oauth required
+            await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
+
+            // authentication api-key required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (project !== undefined) {
+                localVarQueryParameter['project'] = project;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (statementId !== undefined) {
+                localVarQueryParameter['statementId'] = statementId;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Lists all GFN transactions available to the project
          * @summary List GFN transactions
@@ -1204,6 +1307,22 @@ export const TransactionsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['TransactionsApi.exportTransactions']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Lists all the fulfillments in the project with GFN transactions
+         * @summary Lists the GFN fulfillments of the project
+         * @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 {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFulfillments200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listFulfillments(project, pageToken, pageSize, statementId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['TransactionsApi.listFulfillments']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Lists all GFN transactions available to the project
          * @summary List GFN transactions
@@ -1242,6 +1361,16 @@ export const TransactionsApiFactory = function (configuration?: Configuration, b
         exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
             return localVarFp.exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Lists all the fulfillments in the project with GFN transactions
+         * @summary Lists the GFN fulfillments of the project
+         * @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFulfillments200Response> {
+            return localVarFp.listFulfillments(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(axios, basePath));
+        },
         /**
          * Lists all GFN transactions available to the project
          * @summary List GFN transactions
@@ -1276,6 +1405,41 @@ export interface TransactionsApiExportTransactionsRequest {
     readonly exportTransactionsRequest: ExportTransactionsRequest
 }
 
+/**
+ * Request parameters for listFulfillments operation in TransactionsApi.
+ * @export
+ * @interface TransactionsApiListFulfillmentsRequest
+ */
+export interface TransactionsApiListFulfillmentsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly project: string
+
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly pageToken?: number
+
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly pageSize?: number
+
+    /**
+     * 
+     * @type {string}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly statementId?: string
+}
+
 /**
  * Request parameters for listTransactions operation in TransactionsApi.
  * @export
@@ -1344,6 +1508,18 @@ export class TransactionsApi extends BaseAPI {
         return TransactionsApiFp(this.configuration).exportTransactions(requestParameters.project, requestParameters.exportTransactionsRequest, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Lists all the fulfillments in the project with GFN transactions
+     * @summary Lists the GFN fulfillments of the project
+     * @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransactionsApi
+     */
+    public listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig) {
+        return TransactionsApiFp(this.configuration).listFulfillments(requestParameters.project, requestParameters.pageToken, requestParameters.pageSize, requestParameters.statementId, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions

package/base.ts

@@ -2,10 +2,10 @@
 /* eslint-disable */
 /**
  * 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.
+ * 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.
  *
- * The version of the OpenAPI document: 2.2.0
- * Contact: hello@teemill.com
+ * The version of the OpenAPI document: 3.1.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -19,7 +19,7 @@ import type { Configuration } from './configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import globalAxios from 'axios';
 
-export const BASE_PATH = "https://api.teemill.com".replace(/\/+$/, "");
+export const BASE_PATH = "https://api.podos.io".replace(/\/+$/, "");
 
 /**
  *

package/common.ts

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

package/configuration.ts

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

package/dist/api.d.ts

@@ -1,9 +1,9 @@
 /**
  * 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.
+ * 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.
+ *
+ * The version of the OpenAPI document: 3.1.0
  *
- * The version of the OpenAPI document: 2.2.0
- * Contact: hello@teemill.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -116,23 +116,42 @@ export type AttributeThumbnailTypeEnum = typeof AttributeThumbnailTypeEnum[keyof
  */
 export interface ExportTransactionsRequest {
     /**
-     * The start date for the export
+     * Include only transactions from this statement
      * @type {string}
      * @memberof ExportTransactionsRequest
      */
-    'start'?: string;
+    'statement'?: string;
+}
+/**
+ *
+ * @export
+ * @interface Fulfillment
+ */
+export interface Fulfillment {
+    /**
+     *
+     * @type {number}
+     * @memberof Fulfillment
+     */
+    'id': number;
     /**
-     * The end date for the export
+     *
      * @type {string}
-     * @memberof ExportTransactionsRequest
+     * @memberof Fulfillment
      */
-    'end'?: string;
+    'merchantRef': string;
     /**
-     * Include only transactions from this statement
+     *
+     * @type {number}
+     * @memberof Fulfillment
+     */
+    'total': number;
+    /**
+     *
      * @type {string}
-     * @memberof ExportTransactionsRequest
+     * @memberof Fulfillment
      */
-    'statement'?: string;
+    'createdAt': string;
 }
 /**
  * Image description
@@ -183,6 +202,25 @@ export interface Image {
      */
     'updatedAt'?: string;
 }
+/**
+ *
+ * @export
+ * @interface ListFulfillments200Response
+ */
+export interface ListFulfillments200Response {
+    /**
+     *
+     * @type {Array<Fulfillment>}
+     * @memberof ListFulfillments200Response
+     */
+    'fulfillments'?: Array<Fulfillment>;
+    /**
+     *
+     * @type {number}
+     * @memberof ListFulfillments200Response
+     */
+    'nextPageToken'?: number | null;
+}
 /**
  *
  * @export
@@ -337,6 +375,12 @@ export interface Statement {
      * @memberof Statement
      */
     'fulfillmentCount': number;
+    /**
+     *
+     * @type {string}
+     * @memberof Statement
+     */
+    'issuedAt'?: string;
 }
 /**
  *
@@ -848,6 +892,17 @@ export declare const TransactionsApiAxiosParamCreator: (configuration?: Configur
      * @throws {RequiredError}
      */
     exportTransactions: (project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all the fulfillments in the project with GFN transactions
+     * @summary Lists the GFN fulfillments of the project
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFulfillments: (project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
@@ -876,6 +931,17 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     exportTransactions(project: string, exportTransactionsRequest: ExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Lists all the fulfillments in the project with GFN transactions
+     * @summary Lists the GFN fulfillments of the project
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFulfillments200Response>>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
@@ -903,6 +969,14 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
      * @throws {RequiredError}
      */
     exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Lists all the fulfillments in the project with GFN transactions
+     * @summary Lists the GFN fulfillments of the project
+     * @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFulfillments200Response>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
@@ -931,6 +1005,37 @@ export interface TransactionsApiExportTransactionsRequest {
      */
     readonly exportTransactionsRequest: ExportTransactionsRequest;
 }
+/**
+ * Request parameters for listFulfillments operation in TransactionsApi.
+ * @export
+ * @interface TransactionsApiListFulfillmentsRequest
+ */
+export interface TransactionsApiListFulfillmentsRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly project: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly pageSize?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof TransactionsApiListFulfillments
+     */
+    readonly statementId?: string;
+}
 /**
  * Request parameters for listTransactions operation in TransactionsApi.
  * @export
@@ -990,6 +1095,15 @@ export declare class TransactionsApi extends BaseAPI {
      * @memberof TransactionsApi
      */
     exportTransactions(requestParameters: TransactionsApiExportTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Lists all the fulfillments in the project with GFN transactions
+     * @summary Lists the GFN fulfillments of the project
+     * @param {TransactionsApiListFulfillmentsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransactionsApi
+     */
+    listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFulfillments200Response, any>>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions