@teemill/gfn-catalog 3.6.0 → 3.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -2
- package/api.ts +25 -25
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +28 -28
- package/dist/api.js +1 -1
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +28 -28
- package/dist/esm/api.js +1 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ApiError.md +22 -0
- package/docs/ApiValidationError.md +22 -0
- package/docs/Attribute.md +26 -0
- package/docs/AttributeThumbnail.md +23 -0
- package/docs/ExportTransactionsRequest.md +20 -0
- package/docs/Fulfillment.md +26 -0
- package/docs/Image.md +33 -0
- package/docs/InlineObject.md +22 -0
- package/docs/InlineObject1.md +22 -0
- package/docs/InlineObject2.md +22 -0
- package/docs/Location.md +22 -0
- package/docs/Product.md +40 -0
- package/docs/ProductAttribute.md +24 -0
- package/docs/ProductAttributeValuesInner.md +22 -0
- package/docs/ProductBrand.md +22 -0
- package/docs/ProductImagesInner.md +26 -0
- package/docs/ProductVariantsInner.md +22 -0
- package/docs/ProductsApi.md +138 -0
- package/docs/ProductsResponse.md +22 -0
- package/docs/Statement.md +34 -0
- package/docs/StatementsApi.md +132 -0
- package/docs/Stock.md +22 -0
- package/docs/StockResponse.md +22 -0
- package/docs/Transaction.md +38 -0
- package/docs/TransactionsApi.md +205 -0
- package/docs/Variant.md +34 -0
- package/docs/VariantManufacturerOrigin.md +23 -0
- package/docs/VariantProduct.md +22 -0
- package/docs/VariantStock.md +26 -0
- package/docs/VariantsApi.md +268 -0
- package/docs/VariantsResponse.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.6.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -205,57 +205,57 @@ export interface Image {
|
|
|
205
205
|
/**
|
|
206
206
|
*
|
|
207
207
|
* @export
|
|
208
|
-
* @interface
|
|
208
|
+
* @interface InlineObject
|
|
209
209
|
*/
|
|
210
|
-
export interface
|
|
210
|
+
export interface InlineObject {
|
|
211
211
|
/**
|
|
212
212
|
*
|
|
213
|
-
* @type {Array<
|
|
214
|
-
* @memberof
|
|
213
|
+
* @type {Array<Statement>}
|
|
214
|
+
* @memberof InlineObject
|
|
215
215
|
*/
|
|
216
|
-
'
|
|
216
|
+
'statements'?: Array<Statement>;
|
|
217
217
|
/**
|
|
218
218
|
*
|
|
219
219
|
* @type {number}
|
|
220
|
-
* @memberof
|
|
220
|
+
* @memberof InlineObject
|
|
221
221
|
*/
|
|
222
222
|
'nextPageToken'?: number | null;
|
|
223
223
|
}
|
|
224
224
|
/**
|
|
225
225
|
*
|
|
226
226
|
* @export
|
|
227
|
-
* @interface
|
|
227
|
+
* @interface InlineObject1
|
|
228
228
|
*/
|
|
229
|
-
export interface
|
|
229
|
+
export interface InlineObject1 {
|
|
230
230
|
/**
|
|
231
231
|
*
|
|
232
|
-
* @type {Array<
|
|
233
|
-
* @memberof
|
|
232
|
+
* @type {Array<Transaction>}
|
|
233
|
+
* @memberof InlineObject1
|
|
234
234
|
*/
|
|
235
|
-
'
|
|
235
|
+
'transactions'?: Array<Transaction>;
|
|
236
236
|
/**
|
|
237
237
|
*
|
|
238
238
|
* @type {number}
|
|
239
|
-
* @memberof
|
|
239
|
+
* @memberof InlineObject1
|
|
240
240
|
*/
|
|
241
241
|
'nextPageToken'?: number | null;
|
|
242
242
|
}
|
|
243
243
|
/**
|
|
244
244
|
*
|
|
245
245
|
* @export
|
|
246
|
-
* @interface
|
|
246
|
+
* @interface InlineObject2
|
|
247
247
|
*/
|
|
248
|
-
export interface
|
|
248
|
+
export interface InlineObject2 {
|
|
249
249
|
/**
|
|
250
250
|
*
|
|
251
|
-
* @type {Array<
|
|
252
|
-
* @memberof
|
|
251
|
+
* @type {Array<Fulfillment>}
|
|
252
|
+
* @memberof InlineObject2
|
|
253
253
|
*/
|
|
254
|
-
'
|
|
254
|
+
'fulfillments'?: Array<Fulfillment>;
|
|
255
255
|
/**
|
|
256
256
|
*
|
|
257
257
|
* @type {number}
|
|
258
|
-
* @memberof
|
|
258
|
+
* @memberof InlineObject2
|
|
259
259
|
*/
|
|
260
260
|
'nextPageToken'?: number | null;
|
|
261
261
|
}
|
|
@@ -1008,7 +1008,7 @@ export declare const StatementsApiFp: (configuration?: Configuration) => {
|
|
|
1008
1008
|
* @param {*} [options] Override http request option.
|
|
1009
1009
|
* @throws {RequiredError}
|
|
1010
1010
|
*/
|
|
1011
|
-
listStatements(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1011
|
+
listStatements(project: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject>>;
|
|
1012
1012
|
};
|
|
1013
1013
|
/**
|
|
1014
1014
|
* StatementsApi - factory interface
|
|
@@ -1030,7 +1030,7 @@ export declare const StatementsApiFactory: (configuration?: Configuration, baseP
|
|
|
1030
1030
|
* @param {*} [options] Override http request option.
|
|
1031
1031
|
* @throws {RequiredError}
|
|
1032
1032
|
*/
|
|
1033
|
-
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1033
|
+
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject>;
|
|
1034
1034
|
};
|
|
1035
1035
|
/**
|
|
1036
1036
|
* Request parameters for getStatement operation in StatementsApi.
|
|
@@ -1106,7 +1106,7 @@ export declare class StatementsApi extends BaseAPI {
|
|
|
1106
1106
|
* @throws {RequiredError}
|
|
1107
1107
|
* @memberof StatementsApi
|
|
1108
1108
|
*/
|
|
1109
|
-
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
1109
|
+
listStatements(requestParameters: StatementsApiListStatementsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject, any>>;
|
|
1110
1110
|
}
|
|
1111
1111
|
/**
|
|
1112
1112
|
* TransactionsApi - axios parameter creator
|
|
@@ -1171,7 +1171,7 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
1171
1171
|
* @param {*} [options] Override http request option.
|
|
1172
1172
|
* @throws {RequiredError}
|
|
1173
1173
|
*/
|
|
1174
|
-
listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1174
|
+
listFulfillments(project: string, pageToken?: number, pageSize?: number, statementId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject2>>;
|
|
1175
1175
|
/**
|
|
1176
1176
|
* Lists all GFN transactions available to the project
|
|
1177
1177
|
* @summary List GFN transactions
|
|
@@ -1184,7 +1184,7 @@ export declare const TransactionsApiFp: (configuration?: Configuration) => {
|
|
|
1184
1184
|
* @param {*} [options] Override http request option.
|
|
1185
1185
|
* @throws {RequiredError}
|
|
1186
1186
|
*/
|
|
1187
|
-
listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
1187
|
+
listTransactions(project: string, pageToken?: number, pageSize?: number, statementId?: string, fulfillmentId?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>>;
|
|
1188
1188
|
};
|
|
1189
1189
|
/**
|
|
1190
1190
|
* TransactionsApi - factory interface
|
|
@@ -1206,7 +1206,7 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
|
|
|
1206
1206
|
* @param {*} [options] Override http request option.
|
|
1207
1207
|
* @throws {RequiredError}
|
|
1208
1208
|
*/
|
|
1209
|
-
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1209
|
+
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject2>;
|
|
1210
1210
|
/**
|
|
1211
1211
|
* Lists all GFN transactions available to the project
|
|
1212
1212
|
* @summary List GFN transactions
|
|
@@ -1214,7 +1214,7 @@ export declare const TransactionsApiFactory: (configuration?: Configuration, bas
|
|
|
1214
1214
|
* @param {*} [options] Override http request option.
|
|
1215
1215
|
* @throws {RequiredError}
|
|
1216
1216
|
*/
|
|
1217
|
-
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
1217
|
+
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1>;
|
|
1218
1218
|
};
|
|
1219
1219
|
/**
|
|
1220
1220
|
* Request parameters for exportTransactions operation in TransactionsApi.
|
|
@@ -1333,7 +1333,7 @@ export declare class TransactionsApi extends BaseAPI {
|
|
|
1333
1333
|
* @throws {RequiredError}
|
|
1334
1334
|
* @memberof TransactionsApi
|
|
1335
1335
|
*/
|
|
1336
|
-
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
1336
|
+
listFulfillments(requestParameters: TransactionsApiListFulfillmentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject2, any>>;
|
|
1337
1337
|
/**
|
|
1338
1338
|
* Lists all GFN transactions available to the project
|
|
1339
1339
|
* @summary List GFN transactions
|
|
@@ -1342,7 +1342,7 @@ export declare class TransactionsApi extends BaseAPI {
|
|
|
1342
1342
|
* @throws {RequiredError}
|
|
1343
1343
|
* @memberof TransactionsApi
|
|
1344
1344
|
*/
|
|
1345
|
-
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
1345
|
+
listTransactions(requestParameters: TransactionsApiListTransactionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InlineObject1, any>>;
|
|
1346
1346
|
}
|
|
1347
1347
|
/**
|
|
1348
1348
|
* VariantsApi - axios parameter creator
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.6.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.6.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.6.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.6.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.6.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.6.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.6.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.6.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GFN Catalog API
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 3.6.
|
|
7
|
+
* The version of the OpenAPI document: 3.6.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GFN Catalog API
|
|
3
3
|
* 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.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 3.6.
|
|
5
|
+
* The version of the OpenAPI document: 3.6.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* GFN Catalog API
|
|
6
6
|
* 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.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 3.6.
|
|
8
|
+
* The version of the OpenAPI document: 3.6.1
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/ApiError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**code** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiError } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: ApiError = {
|
|
17
|
+
code,
|
|
18
|
+
message,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiValidationError
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
|
+
**errors** | **{ [key: string]: Array<string>; }** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ApiValidationError } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: ApiValidationError = {
|
|
17
|
+
message,
|
|
18
|
+
errors,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Attribute
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Attribute name | [default to undefined]
|
|
9
|
+
**value** | **string** | Attribute value | [default to undefined]
|
|
10
|
+
**thumbnail** | [**AttributeThumbnail**](AttributeThumbnail.md) | | [optional] [default to undefined]
|
|
11
|
+
**tags** | **Array<string>** | Attribute tags | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Attribute } from '@teemill/gfn-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: Attribute = {
|
|
19
|
+
name,
|
|
20
|
+
value,
|
|
21
|
+
thumbnail,
|
|
22
|
+
tags,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# AttributeThumbnail
|
|
2
|
+
|
|
3
|
+
Attribute thumbnail
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**value** | **string** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AttributeThumbnail } from '@teemill/gfn-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: AttributeThumbnail = {
|
|
18
|
+
type,
|
|
19
|
+
value,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ExportTransactionsRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**statement** | **string** | Include only transactions from this statement | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ExportTransactionsRequest } from '@teemill/gfn-catalog';
|
|
14
|
+
|
|
15
|
+
const instance: ExportTransactionsRequest = {
|
|
16
|
+
statement,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Fulfillment
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **number** | | [default to undefined]
|
|
9
|
+
**merchantRef** | **string** | | [default to undefined]
|
|
10
|
+
**total** | **number** | | [default to undefined]
|
|
11
|
+
**createdAt** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Fulfillment } from '@teemill/gfn-catalog';
|
|
17
|
+
|
|
18
|
+
const instance: Fulfillment = {
|
|
19
|
+
id,
|
|
20
|
+
merchantRef,
|
|
21
|
+
total,
|
|
22
|
+
createdAt,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[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
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Image
|
|
2
|
+
|
|
3
|
+
Image description
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
10
|
+
**src** | **string** | | [default to undefined]
|
|
11
|
+
**alt** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**variantIds** | **Array<string>** | List of variant Ids | [optional] [default to undefined]
|
|
13
|
+
**sortOrder** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**updatedAt** | **string** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { Image } from '@teemill/gfn-catalog';
|
|
21
|
+
|
|
22
|
+
const instance: Image = {
|
|
23
|
+
id,
|
|
24
|
+
src,
|
|
25
|
+
alt,
|
|
26
|
+
variantIds,
|
|
27
|
+
sortOrder,
|
|
28
|
+
createdAt,
|
|
29
|
+
updatedAt,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# InlineObject
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**statements** | [**Array<Statement>**](Statement.md) | | [optional] [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { InlineObject } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: InlineObject = {
|
|
17
|
+
statements,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# InlineObject1
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**transactions** | [**Array<Transaction>**](Transaction.md) | | [optional] [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { InlineObject1 } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: InlineObject1 = {
|
|
17
|
+
transactions,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# InlineObject2
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) | | [optional] [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { InlineObject2 } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: InlineObject2 = {
|
|
17
|
+
fulfillments,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Location
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**level** | **number** | The total number of units available at the location | [default to undefined]
|
|
9
|
+
**country** | **string** | ISO alpha-2 country code | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Location } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: Location = {
|
|
17
|
+
level,
|
|
18
|
+
country,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[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
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Product
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
9
|
+
**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
10
|
+
**title** | **string** | | [default to undefined]
|
|
11
|
+
**styleCode** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**material** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**specifications** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | Attributes associated to a product such as Colour and Size. | [default to undefined]
|
|
16
|
+
**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]
|
|
17
|
+
**variants** | [**Array<ProductVariantsInner>**](ProductVariantsInner.md) | Variants | [default to undefined]
|
|
18
|
+
**brand** | [**ProductBrand**](ProductBrand.md) | | [optional] [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { Product } from '@teemill/gfn-catalog';
|
|
24
|
+
|
|
25
|
+
const instance: Product = {
|
|
26
|
+
id,
|
|
27
|
+
ref,
|
|
28
|
+
title,
|
|
29
|
+
styleCode,
|
|
30
|
+
material,
|
|
31
|
+
description,
|
|
32
|
+
specifications,
|
|
33
|
+
attributes,
|
|
34
|
+
images,
|
|
35
|
+
variants,
|
|
36
|
+
brand,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ProductAttribute
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | Attribute name | [default to undefined]
|
|
9
|
+
**sortOrder** | **number** | Position of the attribute when ordered | [default to undefined]
|
|
10
|
+
**values** | [**Array<ProductAttributeValuesInner>**](ProductAttributeValuesInner.md) | Attribute values | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ProductAttribute } from '@teemill/gfn-catalog';
|
|
16
|
+
|
|
17
|
+
const instance: ProductAttribute = {
|
|
18
|
+
name,
|
|
19
|
+
sortOrder,
|
|
20
|
+
values,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ProductAttributeValuesInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**sortOrder** | **number** | Position of the attribute value when ordered | [default to undefined]
|
|
9
|
+
**value** | **string** | Value of the attribute | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ProductAttributeValuesInner } from '@teemill/gfn-catalog';
|
|
15
|
+
|
|
16
|
+
const instance: ProductAttributeValuesInner = {
|
|
17
|
+
sortOrder,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|