@teemill/gfn-catalog 3.5.0 → 3.6.1

package/dist/esm/api.d.ts

@@ -2,7 +2,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -205,57 +205,57 @@ export interface Image {
 /**
  *
  * @export
- * @interface ListFulfillments200Response
+ * @interface InlineObject
  */
-export interface ListFulfillments200Response {
+export interface InlineObject {
     /**
      *
-     * @type {Array<Fulfillment>}
-     * @memberof ListFulfillments200Response
+     * @type {Array<Statement>}
+     * @memberof InlineObject
      */
-    'fulfillments'?: Array<Fulfillment>;
+    'statements'?: Array<Statement>;
     /**
      *
      * @type {number}
-     * @memberof ListFulfillments200Response
+     * @memberof InlineObject
      */
     'nextPageToken'?: number | null;
 }
 /**
  *
  * @export
- * @interface ListStatements200Response
+ * @interface InlineObject1
  */
-export interface ListStatements200Response {
+export interface InlineObject1 {
     /**
      *
-     * @type {Array<Statement>}
-     * @memberof ListStatements200Response
+     * @type {Array<Transaction>}
+     * @memberof InlineObject1
      */
-    'statements'?: Array<Statement>;
+    'transactions'?: Array<Transaction>;
     /**
      *
      * @type {number}
-     * @memberof ListStatements200Response
+     * @memberof InlineObject1
      */
     'nextPageToken'?: number | null;
 }
 /**
  *
  * @export
- * @interface ListTransactions200Response
+ * @interface InlineObject2
  */
-export interface ListTransactions200Response {
+export interface InlineObject2 {
     /**
      *
-     * @type {Array<Transaction>}
-     * @memberof ListTransactions200Response
+     * @type {Array<Fulfillment>}
+     * @memberof InlineObject2
      */
-    'transactions'?: Array<Transaction>;
+    'fulfillments'?: Array<Fulfillment>;
     /**
      *
      * @type {number}
-     * @memberof ListTransactions200Response
+     * @memberof InlineObject2
      */
     'nextPageToken'?: number | null;
 }
@@ -344,6 +344,12 @@ export interface Product {
      * @memberof Product
      */
     'variants': Array<ProductVariantsInner>;
+    /**
+     *
+     * @type {ProductBrand}
+     * @memberof Product
+     */
+    'brand'?: ProductBrand;
 }
 /**
  *
@@ -389,6 +395,25 @@ export interface ProductAttributeValuesInner {
      */
     'value': string;
 }
+/**
+ *
+ * @export
+ * @interface ProductBrand
+ */
+export interface ProductBrand {
+    /**
+     * the name of the brand that manufactures/supplies the product
+     * @type {string}
+     * @memberof ProductBrand
+     */
+    'name': string;
+    /**
+     * a URL to the brand\'s logo
+     * @type {string}
+     * @memberof ProductBrand
+     */
+    'logo'?: string;
+}
 /**
  *
  * @export
@@ -983,7 +1008,7 @@ export declare const StatementsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listStatements(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListStatements200Response>>;
+    listStatements(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
 };
 /**
  * StatementsApi - factory interface
@@ -1005,7 +1030,7 @@ export declare const StatementsApiFactory: (configuration?: Configuration, baseP
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListStatements200Response>;
+    listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
 };
 /**
  * Request parameters for getStatement operation in StatementsApi.
@@ -1081,7 +1106,7 @@ export declare class StatementsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof StatementsApi
      */
-    listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListStatements200Response, any>>;
+    listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
 }
 /**
  * TransactionsApi - axios parameter creator
@@ -1146,7 +1171,7 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
      * @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>>;
+    listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject2>>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
@@ -1159,7 +1184,7 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTransactions200Response>>;
+    listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>>;
 };
 /**
  * TransactionsApi - factory interface
@@ -1181,7 +1206,7 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListFulfillments200Response>;
+    listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject2>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
@@ -1189,7 +1214,7 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListTransactions200Response>;
+    listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1>;
 };
 /**
  * Request parameters for exportTransactions operation in TransactionsApi.
@@ -1308,7 +1333,7 @@ export declare class TransactionsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TransactionsApi
      */
-    listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFulfillments200Response, any>>;
+    listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject2, any>>;
     /**
      * Lists all GFN transactions available to the project
      * @summary List GFN transactions
@@ -1317,7 +1342,7 @@ export declare class TransactionsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof TransactionsApi
      */
-    listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTransactions200Response, any>>;
+    listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject1, any>>;
 }
 /**
  * VariantsApi - axios parameter creator

package/dist/esm/api.js

@@ -4,7 +4,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/base.d.ts

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

package/dist/esm/base.js

@@ -4,7 +4,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/common.d.ts

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

package/dist/esm/common.js

@@ -4,7 +4,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/configuration.d.ts

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

package/dist/esm/configuration.js

@@ -4,7 +4,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -4,7 +4,7 @@
  * GFN Catalog API
  * 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.5.0
+ * The version of the OpenAPI document: 3.6.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

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

package/dist/index.js

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

package/docs/ApiError.md

@@ -0,0 +1,22 @@
+# ApiError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [optional] [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiError } from '@teemill/gfn-catalog';
+
+const instance: ApiError = {
+    code,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ApiValidationError.md

@@ -0,0 +1,22 @@
+# ApiValidationError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+**errors** | **{ [key: string]: Array<string>; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiValidationError } from '@teemill/gfn-catalog';
+
+const instance: ApiValidationError = {
+    message,
+    errors,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Attribute.md

@@ -0,0 +1,26 @@
+# Attribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name | [default to undefined]
+**value** | **string** | Attribute value | [default to undefined]
+**thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) |  | [optional] [default to undefined]
+**tags** | **Array<string>** | Attribute tags | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Attribute } from '@teemill/gfn-catalog';
+
+const instance: Attribute = {
+    name,
+    value,
+    thumbnail,
+    tags,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AttributeThumbnail.md

@@ -0,0 +1,23 @@
+# AttributeThumbnail
+
+Attribute thumbnail
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AttributeThumbnail } from '@teemill/gfn-catalog';
+
+const instance: AttributeThumbnail = {
+    type,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ExportTransactionsRequest.md

@@ -0,0 +1,20 @@
+# ExportTransactionsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statement** | **string** | Include only transactions from this statement | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExportTransactionsRequest } from '@teemill/gfn-catalog';
+
+const instance: ExportTransactionsRequest = {
+    statement,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Fulfillment.md

@@ -0,0 +1,26 @@
+# Fulfillment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**merchantRef** | **string** |  | [default to undefined]
+**total** | **number** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Fulfillment } from '@teemill/gfn-catalog';
+
+const instance: Fulfillment = {
+    id,
+    merchantRef,
+    total,
+    createdAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Image.md

@@ -0,0 +1,33 @@
+# Image
+
+Image description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** |  | [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**variantIds** | **Array<string>** | List of variant Ids | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Image } from '@teemill/gfn-catalog';
+
+const instance: Image = {
+    id,
+    src,
+    alt,
+    variantIds,
+    sortOrder,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InlineObject.md

@@ -0,0 +1,22 @@
+# InlineObject
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**statements** | [**Array<Statement>**](Statement.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InlineObject } from '@teemill/gfn-catalog';
+
+const instance: InlineObject = {
+    statements,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InlineObject1.md

@@ -0,0 +1,22 @@
+# InlineObject1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transactions** | [**Array<Transaction>**](Transaction.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InlineObject1 } from '@teemill/gfn-catalog';
+
+const instance: InlineObject1 = {
+    transactions,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/InlineObject2.md

@@ -0,0 +1,22 @@
+# InlineObject2
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) |  | [optional] [default to undefined]
+**nextPageToken** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InlineObject2 } from '@teemill/gfn-catalog';
+
+const instance: InlineObject2 = {
+    fulfillments,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Location.md

@@ -0,0 +1,22 @@
+# Location
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**level** | **number** | The total number of units available at the location | [default to undefined]
+**country** | **string** | ISO alpha-2 country code | [default to undefined]
+
+## Example
+
+```typescript
+import { Location } from '@teemill/gfn-catalog';
+
+const instance: Location = {
+    level,
+    country,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Product.md

@@ -0,0 +1,40 @@
+# Product
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+**title** | **string** |  | [default to undefined]
+**styleCode** | **string** |  | [optional] [default to undefined]
+**material** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**specifications** | **string** |  | [optional] [default to undefined]
+**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | Attributes associated to a product such as Colour and Size. | [default to undefined]
+**images** | [**Array<ProductImagesInner>**](ProductImagesInner.md) | Images attached to the product. For example, photos of models using/wearing the product. This property currently does not include images linked to specific variants. | [optional] [default to undefined]
+**variants** | [**Array<ProductVariantsInner>**](ProductVariantsInner.md) | Variants | [default to undefined]
+**brand** | [**ProductBrand**](ProductBrand.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Product } from '@teemill/gfn-catalog';
+
+const instance: Product = {
+    id,
+    ref,
+    title,
+    styleCode,
+    material,
+    description,
+    specifications,
+    attributes,
+    images,
+    variants,
+    brand,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ProductAttribute.md

@@ -0,0 +1,24 @@
+# ProductAttribute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Attribute name | [default to undefined]
+**sortOrder** | **number** | Position of the attribute when ordered | [default to undefined]
+**values** | [**Array<ProductAttributeValuesInner>**](ProductAttributeValuesInner.md) | Attribute values | [default to undefined]
+
+## Example
+
+```typescript
+import { ProductAttribute } from '@teemill/gfn-catalog';
+
+const instance: ProductAttribute = {
+    name,
+    sortOrder,
+    values,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)