@teemill/product-catalog 1.81.2 → 1.83.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 +7 -2
- package/api.ts +233 -4
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +153 -4
- package/dist/api.js +127 -2
- 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 +153 -4
- package/dist/esm/api.js +122 -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/AnalyticsItem.md +30 -0
- package/docs/BundleProduct.md +1 -1
- package/docs/CreateBundleProduct.md +1 -1
- package/docs/CreateBundleProductSeoMetadata.md +22 -0
- package/docs/CreateProductRequest.md +1 -1
- package/docs/Product.md +2 -0
- package/docs/ProductAnalyticsApi.md +75 -0
- package/docs/ProductAnalyticsResponse.md +20 -0
- package/docs/ProductBundleItemsInner.md +1 -1
- package/docs/SEOMetadata.md +2 -0
- package/docs/SEOMetadata1.md +23 -0
- package/docs/UpdateProductsRequestProductsInnerSeoMetadata.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/product-catalog@1.
|
|
1
|
+
## @teemill/product-catalog@1.83.1
|
|
2
2
|
|
|
3
3
|
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:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/product-catalog@1.
|
|
39
|
+
npm install @teemill/product-catalog@1.83.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -62,6 +62,7 @@ Class | Method | HTTP request | Description
|
|
|
62
62
|
*ApplicationSetsApi* | [**listApplicationSets**](docs/ApplicationSetsApi.md#listapplicationsets) | **GET** /v1/catalog/applications/sets | List application sets
|
|
63
63
|
*ApplicationSetsApi* | [**updateApplicationSet**](docs/ApplicationSetsApi.md#updateapplicationset) | **PATCH** /v1/catalog/applications/sets/{applicationSetId} | Update application set
|
|
64
64
|
*ApplicationTechnologiesApi* | [**listTechnologies**](docs/ApplicationTechnologiesApi.md#listtechnologies) | **GET** /v1/catalog/applications/technologies | List technologies available to this project
|
|
65
|
+
*ProductAnalyticsApi* | [**listProductAnalytics**](docs/ProductAnalyticsApi.md#listproductanalytics) | **GET** /v1/catalog/analytics | List product analytics
|
|
65
66
|
*ProductsApi* | [**createProduct**](docs/ProductsApi.md#createproduct) | **POST** /v1/catalog/products | Create product
|
|
66
67
|
*ProductsApi* | [**deleteProduct**](docs/ProductsApi.md#deleteproduct) | **DELETE** /v1/catalog/products/{productId} | Delete catalog product
|
|
67
68
|
*ProductsApi* | [**deleteProducts**](docs/ProductsApi.md#deleteproducts) | **DELETE** /v1/catalog/products | Delete products
|
|
@@ -80,6 +81,7 @@ Class | Method | HTTP request | Description
|
|
|
80
81
|
### Documentation For Models
|
|
81
82
|
|
|
82
83
|
- [AdditionalFile](docs/AdditionalFile.md)
|
|
84
|
+
- [AnalyticsItem](docs/AnalyticsItem.md)
|
|
83
85
|
- [ApiError](docs/ApiError.md)
|
|
84
86
|
- [Application](docs/Application.md)
|
|
85
87
|
- [ApplicationGroup](docs/ApplicationGroup.md)
|
|
@@ -112,6 +114,7 @@ Class | Method | HTTP request | Description
|
|
|
112
114
|
- [CreateApplicationSetRequestRecordsInnerAttributesInner](docs/CreateApplicationSetRequestRecordsInnerAttributesInner.md)
|
|
113
115
|
- [CreateBundleProduct](docs/CreateBundleProduct.md)
|
|
114
116
|
- [CreateBundleProductBundleItemsInner](docs/CreateBundleProductBundleItemsInner.md)
|
|
117
|
+
- [CreateBundleProductSeoMetadata](docs/CreateBundleProductSeoMetadata.md)
|
|
115
118
|
- [CreateProduct](docs/CreateProduct.md)
|
|
116
119
|
- [CreateProductAdditionalFilesInner](docs/CreateProductAdditionalFilesInner.md)
|
|
117
120
|
- [CreateProductImagesInner](docs/CreateProductImagesInner.md)
|
|
@@ -135,12 +138,14 @@ Class | Method | HTTP request | Description
|
|
|
135
138
|
- [Price](docs/Price.md)
|
|
136
139
|
- [Product](docs/Product.md)
|
|
137
140
|
- [ProductAdditionalFilesInner](docs/ProductAdditionalFilesInner.md)
|
|
141
|
+
- [ProductAnalyticsResponse](docs/ProductAnalyticsResponse.md)
|
|
138
142
|
- [ProductApplicationSetsInner](docs/ProductApplicationSetsInner.md)
|
|
139
143
|
- [ProductBundleItemsInner](docs/ProductBundleItemsInner.md)
|
|
140
144
|
- [ProductWarehouseProduct](docs/ProductWarehouseProduct.md)
|
|
141
145
|
- [ProductsResponse](docs/ProductsResponse.md)
|
|
142
146
|
- [RequiredPrice](docs/RequiredPrice.md)
|
|
143
147
|
- [SEOMetadata](docs/SEOMetadata.md)
|
|
148
|
+
- [SEOMetadata1](docs/SEOMetadata1.md)
|
|
144
149
|
- [SalePrice](docs/SalePrice.md)
|
|
145
150
|
- [SeoOptimiseProducts202Response](docs/SeoOptimiseProducts202Response.md)
|
|
146
151
|
- [SeoOptimiseProductsRequest](docs/SeoOptimiseProductsRequest.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.83.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -29,6 +29,32 @@ export interface AdditionalFile {
|
|
|
29
29
|
*/
|
|
30
30
|
'src'?: string;
|
|
31
31
|
}
|
|
32
|
+
export interface AnalyticsItem {
|
|
33
|
+
/**
|
|
34
|
+
* Unique object identifier
|
|
35
|
+
*/
|
|
36
|
+
'id': string;
|
|
37
|
+
/**
|
|
38
|
+
* The number of sales in the last 30 days.
|
|
39
|
+
*/
|
|
40
|
+
'sales': number;
|
|
41
|
+
/**
|
|
42
|
+
* The traffic of the product.
|
|
43
|
+
*/
|
|
44
|
+
'traffic': number;
|
|
45
|
+
/**
|
|
46
|
+
* The conversion rate of the product.
|
|
47
|
+
*/
|
|
48
|
+
'conversionRate': number;
|
|
49
|
+
/**
|
|
50
|
+
* The add to basket rate of the product.
|
|
51
|
+
*/
|
|
52
|
+
'basketRate': number;
|
|
53
|
+
/**
|
|
54
|
+
* The revenue of the product.
|
|
55
|
+
*/
|
|
56
|
+
'revenue': number;
|
|
57
|
+
}
|
|
32
58
|
export interface ApiError {
|
|
33
59
|
'code'?: string;
|
|
34
60
|
'message': string;
|
|
@@ -400,7 +426,7 @@ export interface BundleProduct {
|
|
|
400
426
|
'slug'?: string;
|
|
401
427
|
'brand'?: string;
|
|
402
428
|
'enabled'?: boolean;
|
|
403
|
-
'seoMetadata'?:
|
|
429
|
+
'seoMetadata'?: SEOMetadata1;
|
|
404
430
|
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
405
431
|
'tags'?: Array<string>;
|
|
406
432
|
'internalTags'?: Array<string>;
|
|
@@ -648,7 +674,7 @@ export interface CreateBundleProduct {
|
|
|
648
674
|
* A custom URL slug for the product. This must be unique for each product on the project.
|
|
649
675
|
*/
|
|
650
676
|
'slug'?: string;
|
|
651
|
-
'seoMetadata'?:
|
|
677
|
+
'seoMetadata'?: CreateBundleProductSeoMetadata;
|
|
652
678
|
/**
|
|
653
679
|
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
654
680
|
*/
|
|
@@ -699,6 +725,16 @@ export interface CreateBundleProductBundleItemsInner {
|
|
|
699
725
|
*/
|
|
700
726
|
'id'?: string;
|
|
701
727
|
}
|
|
728
|
+
export interface CreateBundleProductSeoMetadata {
|
|
729
|
+
/**
|
|
730
|
+
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
731
|
+
*/
|
|
732
|
+
'title'?: string;
|
|
733
|
+
/**
|
|
734
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
735
|
+
*/
|
|
736
|
+
'description'?: string | null;
|
|
737
|
+
}
|
|
702
738
|
export interface CreateProduct {
|
|
703
739
|
/**
|
|
704
740
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
@@ -1087,6 +1123,10 @@ export interface Product {
|
|
|
1087
1123
|
*/
|
|
1088
1124
|
'showSaleBadge'?: boolean;
|
|
1089
1125
|
'license'?: License;
|
|
1126
|
+
/**
|
|
1127
|
+
* The user ID of the user who created the product
|
|
1128
|
+
*/
|
|
1129
|
+
'createdBy'?: string | null;
|
|
1090
1130
|
}
|
|
1091
1131
|
export interface ProductAdditionalFilesInner {
|
|
1092
1132
|
/**
|
|
@@ -1098,6 +1138,9 @@ export interface ProductAdditionalFilesInner {
|
|
|
1098
1138
|
*/
|
|
1099
1139
|
'src'?: string;
|
|
1100
1140
|
}
|
|
1141
|
+
export interface ProductAnalyticsResponse {
|
|
1142
|
+
'analytics'?: Array<AnalyticsItem>;
|
|
1143
|
+
}
|
|
1101
1144
|
export interface ProductApplicationSetsInner {
|
|
1102
1145
|
/**
|
|
1103
1146
|
* Unique object identifier
|
|
@@ -1126,7 +1169,7 @@ export interface ProductBundleItemsInner {
|
|
|
1126
1169
|
'slug'?: string;
|
|
1127
1170
|
'brand'?: string;
|
|
1128
1171
|
'enabled'?: boolean;
|
|
1129
|
-
'seoMetadata'?:
|
|
1172
|
+
'seoMetadata'?: SEOMetadata1;
|
|
1130
1173
|
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
1131
1174
|
'tags'?: Array<string>;
|
|
1132
1175
|
'internalTags'?: Array<string>;
|
|
@@ -1245,6 +1288,23 @@ export interface SEOMetadata {
|
|
|
1245
1288
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1246
1289
|
*/
|
|
1247
1290
|
'description'?: string | null;
|
|
1291
|
+
/**
|
|
1292
|
+
* Whether to prevent the product from being indexed by search engines.
|
|
1293
|
+
*/
|
|
1294
|
+
'noIndex'?: boolean;
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
* SEO metadata for the product
|
|
1298
|
+
*/
|
|
1299
|
+
export interface SEOMetadata1 {
|
|
1300
|
+
/**
|
|
1301
|
+
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
1302
|
+
*/
|
|
1303
|
+
'title'?: string;
|
|
1304
|
+
/**
|
|
1305
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1306
|
+
*/
|
|
1307
|
+
'description'?: string | null;
|
|
1248
1308
|
}
|
|
1249
1309
|
/**
|
|
1250
1310
|
* Discounted price including tax.
|
|
@@ -1662,6 +1722,10 @@ export interface UpdateProductsRequestProductsInnerSeoMetadata {
|
|
|
1662
1722
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1663
1723
|
*/
|
|
1664
1724
|
'description'?: string | null;
|
|
1725
|
+
/**
|
|
1726
|
+
* Whether to prevent the product from being indexed by search engines.
|
|
1727
|
+
*/
|
|
1728
|
+
'noIndex'?: boolean;
|
|
1665
1729
|
}
|
|
1666
1730
|
export interface UpdateProductsRequestProductsInnerVariantsInner {
|
|
1667
1731
|
/**
|
|
@@ -3093,6 +3157,171 @@ export class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
3093
3157
|
|
|
3094
3158
|
|
|
3095
3159
|
|
|
3160
|
+
/**
|
|
3161
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
3162
|
+
*/
|
|
3163
|
+
export const ProductAnalyticsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3164
|
+
return {
|
|
3165
|
+
/**
|
|
3166
|
+
* Lists all product analytics items.
|
|
3167
|
+
* @summary List product analytics
|
|
3168
|
+
* @param {string} project What project it is
|
|
3169
|
+
* @param {number} [pageToken] Page reference token
|
|
3170
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
3171
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3172
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3173
|
+
* @param {*} [options] Override http request option.
|
|
3174
|
+
* @throws {RequiredError}
|
|
3175
|
+
*/
|
|
3176
|
+
listProductAnalytics: async (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3177
|
+
// verify required parameter 'project' is not null or undefined
|
|
3178
|
+
assertParamExists('listProductAnalytics', 'project', project)
|
|
3179
|
+
const localVarPath = `/v1/catalog/analytics`;
|
|
3180
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3181
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3182
|
+
let baseOptions;
|
|
3183
|
+
if (configuration) {
|
|
3184
|
+
baseOptions = configuration.baseOptions;
|
|
3185
|
+
}
|
|
3186
|
+
|
|
3187
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3188
|
+
const localVarHeaderParameter = {} as any;
|
|
3189
|
+
const localVarQueryParameter = {} as any;
|
|
3190
|
+
|
|
3191
|
+
// authentication session-oauth required
|
|
3192
|
+
// oauth required
|
|
3193
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3194
|
+
|
|
3195
|
+
// authentication api-key required
|
|
3196
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3197
|
+
|
|
3198
|
+
if (project !== undefined) {
|
|
3199
|
+
localVarQueryParameter['project'] = project;
|
|
3200
|
+
}
|
|
3201
|
+
|
|
3202
|
+
if (pageToken !== undefined) {
|
|
3203
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
3204
|
+
}
|
|
3205
|
+
|
|
3206
|
+
if (search !== undefined) {
|
|
3207
|
+
localVarQueryParameter['search'] = search;
|
|
3208
|
+
}
|
|
3209
|
+
|
|
3210
|
+
if (sortBy) {
|
|
3211
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
3212
|
+
}
|
|
3213
|
+
|
|
3214
|
+
if (pageSize !== undefined) {
|
|
3215
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
3216
|
+
}
|
|
3217
|
+
|
|
3218
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
3219
|
+
|
|
3220
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3221
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3222
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3223
|
+
|
|
3224
|
+
return {
|
|
3225
|
+
url: toPathString(localVarUrlObj),
|
|
3226
|
+
options: localVarRequestOptions,
|
|
3227
|
+
};
|
|
3228
|
+
},
|
|
3229
|
+
}
|
|
3230
|
+
};
|
|
3231
|
+
|
|
3232
|
+
/**
|
|
3233
|
+
* ProductAnalyticsApi - functional programming interface
|
|
3234
|
+
*/
|
|
3235
|
+
export const ProductAnalyticsApiFp = function(configuration?: Configuration) {
|
|
3236
|
+
const localVarAxiosParamCreator = ProductAnalyticsApiAxiosParamCreator(configuration)
|
|
3237
|
+
return {
|
|
3238
|
+
/**
|
|
3239
|
+
* Lists all product analytics items.
|
|
3240
|
+
* @summary List product analytics
|
|
3241
|
+
* @param {string} project What project it is
|
|
3242
|
+
* @param {number} [pageToken] Page reference token
|
|
3243
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
3244
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3245
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3246
|
+
* @param {*} [options] Override http request option.
|
|
3247
|
+
* @throws {RequiredError}
|
|
3248
|
+
*/
|
|
3249
|
+
async listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>> {
|
|
3250
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductAnalytics(project, pageToken, search, sortBy, pageSize, options);
|
|
3251
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3252
|
+
const localVarOperationServerBasePath = operationServerMap['ProductAnalyticsApi.listProductAnalytics']?.[localVarOperationServerIndex]?.url;
|
|
3253
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3254
|
+
},
|
|
3255
|
+
}
|
|
3256
|
+
};
|
|
3257
|
+
|
|
3258
|
+
/**
|
|
3259
|
+
* ProductAnalyticsApi - factory interface
|
|
3260
|
+
*/
|
|
3261
|
+
export const ProductAnalyticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3262
|
+
const localVarFp = ProductAnalyticsApiFp(configuration)
|
|
3263
|
+
return {
|
|
3264
|
+
/**
|
|
3265
|
+
* Lists all product analytics items.
|
|
3266
|
+
* @summary List product analytics
|
|
3267
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
3268
|
+
* @param {*} [options] Override http request option.
|
|
3269
|
+
* @throws {RequiredError}
|
|
3270
|
+
*/
|
|
3271
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse> {
|
|
3272
|
+
return localVarFp.listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
3273
|
+
},
|
|
3274
|
+
};
|
|
3275
|
+
};
|
|
3276
|
+
|
|
3277
|
+
/**
|
|
3278
|
+
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
3279
|
+
*/
|
|
3280
|
+
export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
3281
|
+
/**
|
|
3282
|
+
* What project it is
|
|
3283
|
+
*/
|
|
3284
|
+
readonly project: string
|
|
3285
|
+
|
|
3286
|
+
/**
|
|
3287
|
+
* Page reference token
|
|
3288
|
+
*/
|
|
3289
|
+
readonly pageToken?: number
|
|
3290
|
+
|
|
3291
|
+
/**
|
|
3292
|
+
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
3293
|
+
*/
|
|
3294
|
+
readonly search?: string
|
|
3295
|
+
|
|
3296
|
+
/**
|
|
3297
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
3298
|
+
*/
|
|
3299
|
+
readonly sortBy?: Array<string>
|
|
3300
|
+
|
|
3301
|
+
/**
|
|
3302
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3303
|
+
*/
|
|
3304
|
+
readonly pageSize?: number
|
|
3305
|
+
}
|
|
3306
|
+
|
|
3307
|
+
/**
|
|
3308
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
3309
|
+
*/
|
|
3310
|
+
export class ProductAnalyticsApi extends BaseAPI {
|
|
3311
|
+
/**
|
|
3312
|
+
* Lists all product analytics items.
|
|
3313
|
+
* @summary List product analytics
|
|
3314
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
3315
|
+
* @param {*} [options] Override http request option.
|
|
3316
|
+
* @throws {RequiredError}
|
|
3317
|
+
*/
|
|
3318
|
+
public listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig) {
|
|
3319
|
+
return ProductAnalyticsApiFp(this.configuration).listProductAnalytics(requestParameters.project, requestParameters.pageToken, requestParameters.search, requestParameters.sortBy, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
3320
|
+
}
|
|
3321
|
+
}
|
|
3322
|
+
|
|
3323
|
+
|
|
3324
|
+
|
|
3096
3325
|
/**
|
|
3097
3326
|
* ProductsApi - axios parameter creator
|
|
3098
3327
|
*/
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.83.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Product Catalog API
|
|
5
5
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.83.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Product Catalog API
|
|
4
4
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 1.
|
|
6
|
+
* The version of the OpenAPI document: 1.83.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Product Catalog API
|
|
3
3
|
* Manage your Product Catalog. A catalog product is an object that represents a product listing that can be purchased from the given project. It contains a combination of design applications and a warehouse product, plus listing information such as title, description and tags.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.
|
|
5
|
+
* The version of the OpenAPI document: 1.83.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -19,6 +19,32 @@ export interface AdditionalFile {
|
|
|
19
19
|
*/
|
|
20
20
|
'src'?: string;
|
|
21
21
|
}
|
|
22
|
+
export interface AnalyticsItem {
|
|
23
|
+
/**
|
|
24
|
+
* Unique object identifier
|
|
25
|
+
*/
|
|
26
|
+
'id': string;
|
|
27
|
+
/**
|
|
28
|
+
* The number of sales in the last 30 days.
|
|
29
|
+
*/
|
|
30
|
+
'sales': number;
|
|
31
|
+
/**
|
|
32
|
+
* The traffic of the product.
|
|
33
|
+
*/
|
|
34
|
+
'traffic': number;
|
|
35
|
+
/**
|
|
36
|
+
* The conversion rate of the product.
|
|
37
|
+
*/
|
|
38
|
+
'conversionRate': number;
|
|
39
|
+
/**
|
|
40
|
+
* The add to basket rate of the product.
|
|
41
|
+
*/
|
|
42
|
+
'basketRate': number;
|
|
43
|
+
/**
|
|
44
|
+
* The revenue of the product.
|
|
45
|
+
*/
|
|
46
|
+
'revenue': number;
|
|
47
|
+
}
|
|
22
48
|
export interface ApiError {
|
|
23
49
|
'code'?: string;
|
|
24
50
|
'message': string;
|
|
@@ -375,7 +401,7 @@ export interface BundleProduct {
|
|
|
375
401
|
'slug'?: string;
|
|
376
402
|
'brand'?: string;
|
|
377
403
|
'enabled'?: boolean;
|
|
378
|
-
'seoMetadata'?:
|
|
404
|
+
'seoMetadata'?: SEOMetadata1;
|
|
379
405
|
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
380
406
|
'tags'?: Array<string>;
|
|
381
407
|
'internalTags'?: Array<string>;
|
|
@@ -615,7 +641,7 @@ export interface CreateBundleProduct {
|
|
|
615
641
|
* A custom URL slug for the product. This must be unique for each product on the project.
|
|
616
642
|
*/
|
|
617
643
|
'slug'?: string;
|
|
618
|
-
'seoMetadata'?:
|
|
644
|
+
'seoMetadata'?: CreateBundleProductSeoMetadata;
|
|
619
645
|
/**
|
|
620
646
|
* The primary target search phrase for the product that you wish to rank for in search engine results. **Note:** This field requires the website integration
|
|
621
647
|
*/
|
|
@@ -666,6 +692,16 @@ export interface CreateBundleProductBundleItemsInner {
|
|
|
666
692
|
*/
|
|
667
693
|
'id'?: string;
|
|
668
694
|
}
|
|
695
|
+
export interface CreateBundleProductSeoMetadata {
|
|
696
|
+
/**
|
|
697
|
+
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
698
|
+
*/
|
|
699
|
+
'title'?: string;
|
|
700
|
+
/**
|
|
701
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
702
|
+
*/
|
|
703
|
+
'description'?: string | null;
|
|
704
|
+
}
|
|
669
705
|
export interface CreateProduct {
|
|
670
706
|
/**
|
|
671
707
|
* Reference to the product in the GFN catalog that will be used as a base for this product. A list of available products for the given project can be obtained from the GFN Catalog API.
|
|
@@ -1050,6 +1086,10 @@ export interface Product {
|
|
|
1050
1086
|
*/
|
|
1051
1087
|
'showSaleBadge'?: boolean;
|
|
1052
1088
|
'license'?: License;
|
|
1089
|
+
/**
|
|
1090
|
+
* The user ID of the user who created the product
|
|
1091
|
+
*/
|
|
1092
|
+
'createdBy'?: string | null;
|
|
1053
1093
|
}
|
|
1054
1094
|
export interface ProductAdditionalFilesInner {
|
|
1055
1095
|
/**
|
|
@@ -1061,6 +1101,9 @@ export interface ProductAdditionalFilesInner {
|
|
|
1061
1101
|
*/
|
|
1062
1102
|
'src'?: string;
|
|
1063
1103
|
}
|
|
1104
|
+
export interface ProductAnalyticsResponse {
|
|
1105
|
+
'analytics'?: Array<AnalyticsItem>;
|
|
1106
|
+
}
|
|
1064
1107
|
export interface ProductApplicationSetsInner {
|
|
1065
1108
|
/**
|
|
1066
1109
|
* Unique object identifier
|
|
@@ -1089,7 +1132,7 @@ export interface ProductBundleItemsInner {
|
|
|
1089
1132
|
'slug'?: string;
|
|
1090
1133
|
'brand'?: string;
|
|
1091
1134
|
'enabled'?: boolean;
|
|
1092
|
-
'seoMetadata'?:
|
|
1135
|
+
'seoMetadata'?: SEOMetadata1;
|
|
1093
1136
|
'targetSearchPhraseData'?: TargetSearchPhraseData;
|
|
1094
1137
|
'tags'?: Array<string>;
|
|
1095
1138
|
'internalTags'?: Array<string>;
|
|
@@ -1205,6 +1248,23 @@ export interface SEOMetadata {
|
|
|
1205
1248
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1206
1249
|
*/
|
|
1207
1250
|
'description'?: string | null;
|
|
1251
|
+
/**
|
|
1252
|
+
* Whether to prevent the product from being indexed by search engines.
|
|
1253
|
+
*/
|
|
1254
|
+
'noIndex'?: boolean;
|
|
1255
|
+
}
|
|
1256
|
+
/**
|
|
1257
|
+
* SEO metadata for the product
|
|
1258
|
+
*/
|
|
1259
|
+
export interface SEOMetadata1 {
|
|
1260
|
+
/**
|
|
1261
|
+
* Meta title for the product. This appears in search engine results and social shares. If not provided, the product title will be used.
|
|
1262
|
+
*/
|
|
1263
|
+
'title'?: string;
|
|
1264
|
+
/**
|
|
1265
|
+
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1266
|
+
*/
|
|
1267
|
+
'description'?: string | null;
|
|
1208
1268
|
}
|
|
1209
1269
|
/**
|
|
1210
1270
|
* Discounted price including tax.
|
|
@@ -1612,6 +1672,10 @@ export interface UpdateProductsRequestProductsInnerSeoMetadata {
|
|
|
1612
1672
|
* Meta description for the product. This appears in search engine results and social shares. If not provided, the product description will be used.
|
|
1613
1673
|
*/
|
|
1614
1674
|
'description'?: string | null;
|
|
1675
|
+
/**
|
|
1676
|
+
* Whether to prevent the product from being indexed by search engines.
|
|
1677
|
+
*/
|
|
1678
|
+
'noIndex'?: boolean;
|
|
1615
1679
|
}
|
|
1616
1680
|
export interface UpdateProductsRequestProductsInnerVariantsInner {
|
|
1617
1681
|
/**
|
|
@@ -2411,6 +2475,91 @@ export declare class ApplicationTechnologiesApi extends BaseAPI {
|
|
|
2411
2475
|
*/
|
|
2412
2476
|
listTechnologies(requestParameters: ApplicationTechnologiesApiListTechnologiesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ApplicationTechnologiesResponse, any, {}>>;
|
|
2413
2477
|
}
|
|
2478
|
+
/**
|
|
2479
|
+
* ProductAnalyticsApi - axios parameter creator
|
|
2480
|
+
*/
|
|
2481
|
+
export declare const ProductAnalyticsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2482
|
+
/**
|
|
2483
|
+
* Lists all product analytics items.
|
|
2484
|
+
* @summary List product analytics
|
|
2485
|
+
* @param {string} project What project it is
|
|
2486
|
+
* @param {number} [pageToken] Page reference token
|
|
2487
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2488
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2489
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2490
|
+
* @param {*} [options] Override http request option.
|
|
2491
|
+
* @throws {RequiredError}
|
|
2492
|
+
*/
|
|
2493
|
+
listProductAnalytics: (project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2494
|
+
};
|
|
2495
|
+
/**
|
|
2496
|
+
* ProductAnalyticsApi - functional programming interface
|
|
2497
|
+
*/
|
|
2498
|
+
export declare const ProductAnalyticsApiFp: (configuration?: Configuration) => {
|
|
2499
|
+
/**
|
|
2500
|
+
* Lists all product analytics items.
|
|
2501
|
+
* @summary List product analytics
|
|
2502
|
+
* @param {string} project What project it is
|
|
2503
|
+
* @param {number} [pageToken] Page reference token
|
|
2504
|
+
* @param {string} [search] Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2505
|
+
* @param {Array<string>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2506
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2507
|
+
* @param {*} [options] Override http request option.
|
|
2508
|
+
* @throws {RequiredError}
|
|
2509
|
+
*/
|
|
2510
|
+
listProductAnalytics(project: string, pageToken?: number, search?: string, sortBy?: Array<string>, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductAnalyticsResponse>>;
|
|
2511
|
+
};
|
|
2512
|
+
/**
|
|
2513
|
+
* ProductAnalyticsApi - factory interface
|
|
2514
|
+
*/
|
|
2515
|
+
export declare const ProductAnalyticsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2516
|
+
/**
|
|
2517
|
+
* Lists all product analytics items.
|
|
2518
|
+
* @summary List product analytics
|
|
2519
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
2520
|
+
* @param {*} [options] Override http request option.
|
|
2521
|
+
* @throws {RequiredError}
|
|
2522
|
+
*/
|
|
2523
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProductAnalyticsResponse>;
|
|
2524
|
+
};
|
|
2525
|
+
/**
|
|
2526
|
+
* Request parameters for listProductAnalytics operation in ProductAnalyticsApi.
|
|
2527
|
+
*/
|
|
2528
|
+
export interface ProductAnalyticsApiListProductAnalyticsRequest {
|
|
2529
|
+
/**
|
|
2530
|
+
* What project it is
|
|
2531
|
+
*/
|
|
2532
|
+
readonly project: string;
|
|
2533
|
+
/**
|
|
2534
|
+
* Page reference token
|
|
2535
|
+
*/
|
|
2536
|
+
readonly pageToken?: number;
|
|
2537
|
+
/**
|
|
2538
|
+
* Search query string to filter results. Supports field-specific filters like \'enabled:true\', \'uuid:<id>\', \'name:\"product name\"\', \'tag:\"tag name\"\', and \'type:product,template,bundle\'. Multiple filters can be combined with spaces and commas.
|
|
2539
|
+
*/
|
|
2540
|
+
readonly search?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2543
|
+
*/
|
|
2544
|
+
readonly sortBy?: Array<string>;
|
|
2545
|
+
/**
|
|
2546
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2547
|
+
*/
|
|
2548
|
+
readonly pageSize?: number;
|
|
2549
|
+
}
|
|
2550
|
+
/**
|
|
2551
|
+
* ProductAnalyticsApi - object-oriented interface
|
|
2552
|
+
*/
|
|
2553
|
+
export declare class ProductAnalyticsApi extends BaseAPI {
|
|
2554
|
+
/**
|
|
2555
|
+
* Lists all product analytics items.
|
|
2556
|
+
* @summary List product analytics
|
|
2557
|
+
* @param {ProductAnalyticsApiListProductAnalyticsRequest} requestParameters Request parameters.
|
|
2558
|
+
* @param {*} [options] Override http request option.
|
|
2559
|
+
* @throws {RequiredError}
|
|
2560
|
+
*/
|
|
2561
|
+
listProductAnalytics(requestParameters: ProductAnalyticsApiListProductAnalyticsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductAnalyticsResponse, any, {}>>;
|
|
2562
|
+
}
|
|
2414
2563
|
/**
|
|
2415
2564
|
* ProductsApi - axios parameter creator
|
|
2416
2565
|
*/
|