@emilgroup/translation-sdk 1.0.0 → 1.0.1-beta.4

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.
Files changed (38) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +9 -26
  3. package/api/default-api.ts +124 -0
  4. package/api/translation-api.ts +170 -209
  5. package/api.ts +2 -4
  6. package/base.ts +140 -97
  7. package/common.ts +2 -3
  8. package/configuration.ts +9 -8
  9. package/dist/api/default-api.d.ts +70 -0
  10. package/dist/api/default-api.js +200 -0
  11. package/dist/api/translation-api.d.ts +139 -165
  12. package/dist/api/translation-api.js +125 -147
  13. package/dist/api.d.ts +1 -0
  14. package/dist/api.js +1 -0
  15. package/dist/base.d.ts +22 -13
  16. package/dist/base.js +125 -153
  17. package/dist/common.d.ts +0 -1
  18. package/dist/common.js +3 -4
  19. package/dist/configuration.d.ts +6 -7
  20. package/dist/configuration.js +8 -0
  21. package/dist/models/create-product-language-request-dto.d.ts +1 -1
  22. package/dist/models/get-product-language-response-class.d.ts +25 -0
  23. package/dist/models/get-product-language-response-class.js +15 -0
  24. package/dist/models/index.d.ts +3 -0
  25. package/dist/models/index.js +3 -0
  26. package/dist/models/inline-response200.d.ts +54 -0
  27. package/dist/models/inline-response200.js +15 -0
  28. package/dist/models/inline-response503.d.ts +54 -0
  29. package/dist/models/inline-response503.js +15 -0
  30. package/dist/models/product-language-class.d.ts +4 -4
  31. package/models/create-product-language-request-dto.ts +1 -1
  32. package/models/get-product-language-response-class.ts +31 -0
  33. package/models/index.ts +3 -0
  34. package/models/inline-response200.ts +48 -0
  35. package/models/inline-response503.ts +48 -0
  36. package/models/product-language-class.ts +4 -4
  37. package/package.json +2 -5
  38. package/tsconfig.json +1 -0
@@ -14,6 +14,7 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateProductLanguageRequestDto } from '../models';
16
16
  import { CreateProductLanguageResponseClass } from '../models';
17
+ import { GetProductLanguageResponseClass } from '../models';
17
18
  import { ListProductLanguagesResponseClass } from '../models';
18
19
  import { ListTranslationsResponseClass } from '../models';
19
20
  import { UpdateProductLanguageRequestDto } from '../models';
@@ -25,17 +26,16 @@ import { UploadProductTranslationsResponseClass } from '../models';
25
26
  */
26
27
  export declare const TranslationApiAxiosParamCreator: (configuration?: Configuration) => {
27
28
  /**
28
- * This creates a product language.
29
+ * This creates a product language. **Required Permissions** \"translation-management.translations.create\"
29
30
  * @summary Create the product language
30
- * @param {string} productSlug
31
31
  * @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
32
32
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
33
  * @param {*} [options] Override http request option.
34
34
  * @throws {RequiredError}
35
35
  */
36
- createProductLanguage: (productSlug: string, createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ createProductLanguage: (createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
37
  /**
38
- * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
38
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
39
39
  * @summary Delete the product language
40
40
  * @param {number} id Id of the product language.
41
41
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -44,7 +44,7 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
44
44
  */
45
45
  deleteProductLanguage: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
46
  /**
47
- * This downloads the list of translatable fields for a given product.
47
+ * This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
48
48
  * @summary Retrieve the product translations
49
49
  * @param {string} productSlug
50
50
  * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
@@ -54,57 +54,55 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
54
54
  */
55
55
  downloadProductTranslations: (productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
56
  /**
57
- * This gets a product language.
57
+ * This gets a product language. **Required Permissions** \"translation-management.translations.view\"
58
58
  * @summary Retrieve the product language
59
59
  * @param {number} id Id of the product language.
60
- * @param {string} productSlug Product slug of the product.
61
60
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
62
61
  * @param {*} [options] Override http request option.
63
62
  * @throws {RequiredError}
64
63
  */
65
- getProductLanguage: (id: number, productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
64
+ getProductLanguage: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
65
  /**
67
- * This lists the product languages.
66
+ * Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
68
67
  * @summary List product languages
69
- * @param {string} productSlug Product slug of the product.
70
68
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
71
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
72
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
73
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
74
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
75
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
76
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
69
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
70
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
71
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
72
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, language&lt;/i&gt;
73
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt&lt;/i&gt;
74
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
75
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
77
76
  * @param {*} [options] Override http request option.
78
77
  * @throws {RequiredError}
79
78
  */
80
- listProductLanguages: (productSlug: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
79
+ listProductLanguages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
81
80
  /**
82
- * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
81
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
83
82
  * @summary List translations
84
83
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
86
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
87
- * @param {'key'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
88
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
89
- * @param {'0' | '1' | '2'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
90
- * @param {number} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
84
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
85
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
86
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
87
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: key&lt;/i&gt;
88
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, key&lt;/i&gt;
89
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
90
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
91
91
  * @param {*} [options] Override http request option.
92
92
  * @throws {RequiredError}
93
93
  */
94
- listTranslations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'key', search?: any, order?: '0' | '1' | '2', expand?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
94
+ listTranslations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
95
95
  /**
96
- * This updates the product language with the specified id.
96
+ * This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
97
97
  * @summary Update the product language
98
- * @param {number} id Id of the product language.
99
- * @param {string} productSlug Product slug of the product.
100
98
  * @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
101
99
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
102
100
  * @param {*} [options] Override http request option.
103
101
  * @throws {RequiredError}
104
102
  */
105
- updateProductLanguage: (id: number, productSlug: string, updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
103
+ updateProductLanguage: (updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
106
104
  /**
107
- * This uploads the translations for a given product.
105
+ * This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
108
106
  * @summary Create the product translations
109
107
  * @param {string} productSlug
110
108
  * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
@@ -121,17 +119,16 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
121
119
  */
122
120
  export declare const TranslationApiFp: (configuration?: Configuration) => {
123
121
  /**
124
- * This creates a product language.
122
+ * This creates a product language. **Required Permissions** \"translation-management.translations.create\"
125
123
  * @summary Create the product language
126
- * @param {string} productSlug
127
124
  * @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
128
125
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
129
126
  * @param {*} [options] Override http request option.
130
127
  * @throws {RequiredError}
131
128
  */
132
- createProductLanguage(productSlug: string, createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>>;
129
+ createProductLanguage(createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>>;
133
130
  /**
134
- * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
131
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
135
132
  * @summary Delete the product language
136
133
  * @param {number} id Id of the product language.
137
134
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -140,7 +137,7 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
140
137
  */
141
138
  deleteProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
142
139
  /**
143
- * This downloads the list of translatable fields for a given product.
140
+ * This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
144
141
  * @summary Retrieve the product translations
145
142
  * @param {string} productSlug
146
143
  * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
@@ -150,57 +147,55 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
150
147
  */
151
148
  downloadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
152
149
  /**
153
- * This gets a product language.
150
+ * This gets a product language. **Required Permissions** \"translation-management.translations.view\"
154
151
  * @summary Retrieve the product language
155
152
  * @param {number} id Id of the product language.
156
- * @param {string} productSlug Product slug of the product.
157
153
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
158
154
  * @param {*} [options] Override http request option.
159
155
  * @throws {RequiredError}
160
156
  */
161
- getProductLanguage(id: number, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>>;
157
+ getProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductLanguageResponseClass>>;
162
158
  /**
163
- * This lists the product languages.
159
+ * Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
164
160
  * @summary List product languages
165
- * @param {string} productSlug Product slug of the product.
166
161
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
167
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
168
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
169
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
170
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
171
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
172
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
162
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
163
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
164
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
165
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, language&lt;/i&gt;
166
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt&lt;/i&gt;
167
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
168
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
173
169
  * @param {*} [options] Override http request option.
174
170
  * @throws {RequiredError}
175
171
  */
176
- listProductLanguages(productSlug: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductLanguagesResponseClass>>;
172
+ listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductLanguagesResponseClass>>;
177
173
  /**
178
- * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
174
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
179
175
  * @summary List translations
180
176
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
181
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
182
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
183
- * @param {'key'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
184
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
185
- * @param {'0' | '1' | '2'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
186
- * @param {number} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
177
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
178
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
179
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
180
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: key&lt;/i&gt;
181
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, key&lt;/i&gt;
182
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
183
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
187
184
  * @param {*} [options] Override http request option.
188
185
  * @throws {RequiredError}
189
186
  */
190
- listTranslations(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'key', search?: any, order?: '0' | '1' | '2', expand?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTranslationsResponseClass>>;
187
+ listTranslations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTranslationsResponseClass>>;
191
188
  /**
192
- * This updates the product language with the specified id.
189
+ * This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
193
190
  * @summary Update the product language
194
- * @param {number} id Id of the product language.
195
- * @param {string} productSlug Product slug of the product.
196
191
  * @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
197
192
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
198
193
  * @param {*} [options] Override http request option.
199
194
  * @throws {RequiredError}
200
195
  */
201
- updateProductLanguage(id: number, productSlug: string, updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductLanguageResponseClass>>;
196
+ updateProductLanguage(updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductLanguageResponseClass>>;
202
197
  /**
203
- * This uploads the translations for a given product.
198
+ * This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
204
199
  * @summary Create the product translations
205
200
  * @param {string} productSlug
206
201
  * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
@@ -217,17 +212,16 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
217
212
  */
218
213
  export declare const TranslationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
219
214
  /**
220
- * This creates a product language.
215
+ * This creates a product language. **Required Permissions** \"translation-management.translations.create\"
221
216
  * @summary Create the product language
222
- * @param {string} productSlug
223
217
  * @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
224
218
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
225
219
  * @param {*} [options] Override http request option.
226
220
  * @throws {RequiredError}
227
221
  */
228
- createProductLanguage(productSlug: string, createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass>;
222
+ createProductLanguage(createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass>;
229
223
  /**
230
- * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
224
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
231
225
  * @summary Delete the product language
232
226
  * @param {number} id Id of the product language.
233
227
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -236,7 +230,7 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
236
230
  */
237
231
  deleteProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<void>;
238
232
  /**
239
- * This downloads the list of translatable fields for a given product.
233
+ * This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
240
234
  * @summary Retrieve the product translations
241
235
  * @param {string} productSlug
242
236
  * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
@@ -246,57 +240,55 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
246
240
  */
247
241
  downloadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: any): AxiosPromise<any>;
248
242
  /**
249
- * This gets a product language.
243
+ * This gets a product language. **Required Permissions** \"translation-management.translations.view\"
250
244
  * @summary Retrieve the product language
251
245
  * @param {number} id Id of the product language.
252
- * @param {string} productSlug Product slug of the product.
253
246
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
254
247
  * @param {*} [options] Override http request option.
255
248
  * @throws {RequiredError}
256
249
  */
257
- getProductLanguage(id: number, productSlug: string, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass>;
250
+ getProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<GetProductLanguageResponseClass>;
258
251
  /**
259
- * This lists the product languages.
252
+ * Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
260
253
  * @summary List product languages
261
- * @param {string} productSlug Product slug of the product.
262
254
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
263
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
264
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
265
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
266
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
267
- * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
268
- * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
255
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
256
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
257
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
258
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, language&lt;/i&gt;
259
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt&lt;/i&gt;
260
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
261
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
269
262
  * @param {*} [options] Override http request option.
270
263
  * @throws {RequiredError}
271
264
  */
272
- listProductLanguages(productSlug: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductLanguagesResponseClass>;
265
+ listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductLanguagesResponseClass>;
273
266
  /**
274
- * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
267
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
275
268
  * @summary List translations
276
269
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
277
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
278
- * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
279
- * @param {'key'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
280
- * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
281
- * @param {'0' | '1' | '2'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
282
- * @param {number} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
270
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
271
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
272
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
273
+ * @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: key&lt;/i&gt;
274
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, key&lt;/i&gt;
275
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
276
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
283
277
  * @param {*} [options] Override http request option.
284
278
  * @throws {RequiredError}
285
279
  */
286
- listTranslations(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'key', search?: any, order?: '0' | '1' | '2', expand?: number, options?: any): AxiosPromise<ListTranslationsResponseClass>;
280
+ listTranslations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTranslationsResponseClass>;
287
281
  /**
288
- * This updates the product language with the specified id.
282
+ * This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
289
283
  * @summary Update the product language
290
- * @param {number} id Id of the product language.
291
- * @param {string} productSlug Product slug of the product.
292
284
  * @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
293
285
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
294
286
  * @param {*} [options] Override http request option.
295
287
  * @throws {RequiredError}
296
288
  */
297
- updateProductLanguage(id: number, productSlug: string, updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductLanguageResponseClass>;
289
+ updateProductLanguage(updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductLanguageResponseClass>;
298
290
  /**
299
- * This uploads the translations for a given product.
291
+ * This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
300
292
  * @summary Create the product translations
301
293
  * @param {string} productSlug
302
294
  * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
@@ -313,12 +305,6 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
313
305
  * @interface TranslationApiCreateProductLanguageRequest
314
306
  */
315
307
  export interface TranslationApiCreateProductLanguageRequest {
316
- /**
317
- *
318
- * @type {string}
319
- * @memberof TranslationApiCreateProductLanguage
320
- */
321
- readonly productSlug: string;
322
308
  /**
323
309
  *
324
310
  * @type {CreateProductLanguageRequestDto}
@@ -388,12 +374,6 @@ export interface TranslationApiGetProductLanguageRequest {
388
374
  * @memberof TranslationApiGetProductLanguage
389
375
  */
390
376
  readonly id: number;
391
- /**
392
- * Product slug of the product.
393
- * @type {string}
394
- * @memberof TranslationApiGetProductLanguage
395
- */
396
- readonly productSlug: string;
397
377
  /**
398
378
  * Bearer Token: provided by the login endpoint under the name accessToken.
399
379
  * @type {string}
@@ -408,53 +388,53 @@ export interface TranslationApiGetProductLanguageRequest {
408
388
  */
409
389
  export interface TranslationApiListProductLanguagesRequest {
410
390
  /**
411
- * Product slug of the product.
391
+ * Bearer Token: provided by the login endpoint under the name accessToken.
412
392
  * @type {string}
413
393
  * @memberof TranslationApiListProductLanguages
414
394
  */
415
- readonly productSlug: string;
395
+ readonly authorization?: string;
416
396
  /**
417
- * Bearer Token: provided by the login endpoint under the name accessToken.
418
- * @type {string}
397
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
398
+ * @type {number}
419
399
  * @memberof TranslationApiListProductLanguages
420
400
  */
421
- readonly authorization?: string;
401
+ readonly pageSize?: number;
422
402
  /**
423
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
424
- * @type {any}
403
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
404
+ * @type {string}
425
405
  * @memberof TranslationApiListProductLanguages
426
406
  */
427
- readonly pageSize?: any;
407
+ readonly pageToken?: string;
428
408
  /**
429
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
430
- * @type {any}
409
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
410
+ * @type {string}
431
411
  * @memberof TranslationApiListProductLanguages
432
412
  */
433
- readonly pageToken?: any;
413
+ readonly filter?: string;
434
414
  /**
435
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
436
- * @type {any}
415
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: id, language&lt;/i&gt;
416
+ * @type {string}
437
417
  * @memberof TranslationApiListProductLanguages
438
418
  */
439
- readonly filter?: any;
419
+ readonly search?: string;
440
420
  /**
441
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
442
- * @type {any}
421
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt&lt;/i&gt;
422
+ * @type {string}
443
423
  * @memberof TranslationApiListProductLanguages
444
424
  */
445
- readonly search?: any;
425
+ readonly order?: string;
446
426
  /**
447
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
448
- * @type {any}
427
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
428
+ * @type {string}
449
429
  * @memberof TranslationApiListProductLanguages
450
430
  */
451
- readonly order?: any;
431
+ readonly expand?: string;
452
432
  /**
453
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
454
- * @type {any}
433
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt&lt;/i&gt;
434
+ * @type {string}
455
435
  * @memberof TranslationApiListProductLanguages
456
436
  */
457
- readonly expand?: any;
437
+ readonly filters?: string;
458
438
  }
459
439
  /**
460
440
  * Request parameters for listTranslations operation in TranslationApi.
@@ -469,41 +449,47 @@ export interface TranslationApiListTranslationsRequest {
469
449
  */
470
450
  readonly authorization?: string;
471
451
  /**
472
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
473
- * @type {any}
452
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
453
+ * @type {number}
474
454
  * @memberof TranslationApiListTranslations
475
455
  */
476
- readonly pageSize?: any;
456
+ readonly pageSize?: number;
477
457
  /**
478
- * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
479
- * @type {any}
458
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
459
+ * @type {string}
480
460
  * @memberof TranslationApiListTranslations
481
461
  */
482
- readonly pageToken?: any;
462
+ readonly pageToken?: string;
483
463
  /**
484
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
485
- * @type {'key'}
464
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
465
+ * @type {string}
486
466
  * @memberof TranslationApiListTranslations
487
467
  */
488
- readonly filter?: 'key';
468
+ readonly filter?: string;
489
469
  /**
490
- * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
491
- * @type {any}
470
+ * Search the response for matches in any searchable field. Use filter instead where possible for improved performance.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Searchable fields: key&lt;/i&gt;
471
+ * @type {string}
492
472
  * @memberof TranslationApiListTranslations
493
473
  */
494
- readonly search?: any;
474
+ readonly search?: string;
495
475
  /**
496
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
497
- * @type {'0' | '1' | '2'}
476
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, key&lt;/i&gt;
477
+ * @type {string}
498
478
  * @memberof TranslationApiListTranslations
499
479
  */
500
- readonly order?: '0' | '1' | '2';
480
+ readonly order?: string;
501
481
  /**
502
- * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
503
- * @type {number}
482
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
483
+ * @type {string}
504
484
  * @memberof TranslationApiListTranslations
505
485
  */
506
- readonly expand?: number;
486
+ readonly expand?: string;
487
+ /**
488
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: key&lt;/i&gt;
489
+ * @type {string}
490
+ * @memberof TranslationApiListTranslations
491
+ */
492
+ readonly filters?: string;
507
493
  }
508
494
  /**
509
495
  * Request parameters for updateProductLanguage operation in TranslationApi.
@@ -511,18 +497,6 @@ export interface TranslationApiListTranslationsRequest {
511
497
  * @interface TranslationApiUpdateProductLanguageRequest
512
498
  */
513
499
  export interface TranslationApiUpdateProductLanguageRequest {
514
- /**
515
- * Id of the product language.
516
- * @type {number}
517
- * @memberof TranslationApiUpdateProductLanguage
518
- */
519
- readonly id: number;
520
- /**
521
- * Product slug of the product.
522
- * @type {string}
523
- * @memberof TranslationApiUpdateProductLanguage
524
- */
525
- readonly productSlug: string;
526
500
  /**
527
501
  *
528
502
  * @type {UpdateProductLanguageRequestDto}
@@ -575,7 +549,7 @@ export interface TranslationApiUploadProductTranslationsRequest {
575
549
  */
576
550
  export declare class TranslationApi extends BaseAPI {
577
551
  /**
578
- * This creates a product language.
552
+ * This creates a product language. **Required Permissions** \"translation-management.translations.create\"
579
553
  * @summary Create the product language
580
554
  * @param {TranslationApiCreateProductLanguageRequest} requestParameters Request parameters.
581
555
  * @param {*} [options] Override http request option.
@@ -584,7 +558,7 @@ export declare class TranslationApi extends BaseAPI {
584
558
  */
585
559
  createProductLanguage(requestParameters: TranslationApiCreateProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductLanguageResponseClass, any>>;
586
560
  /**
587
- * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
561
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
588
562
  * @summary Delete the product language
589
563
  * @param {TranslationApiDeleteProductLanguageRequest} requestParameters Request parameters.
590
564
  * @param {*} [options] Override http request option.
@@ -593,7 +567,7 @@ export declare class TranslationApi extends BaseAPI {
593
567
  */
594
568
  deleteProductLanguage(requestParameters: TranslationApiDeleteProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
595
569
  /**
596
- * This downloads the list of translatable fields for a given product.
570
+ * This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
597
571
  * @summary Retrieve the product translations
598
572
  * @param {TranslationApiDownloadProductTranslationsRequest} requestParameters Request parameters.
599
573
  * @param {*} [options] Override http request option.
@@ -602,25 +576,25 @@ export declare class TranslationApi extends BaseAPI {
602
576
  */
603
577
  downloadProductTranslations(requestParameters: TranslationApiDownloadProductTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
604
578
  /**
605
- * This gets a product language.
579
+ * This gets a product language. **Required Permissions** \"translation-management.translations.view\"
606
580
  * @summary Retrieve the product language
607
581
  * @param {TranslationApiGetProductLanguageRequest} requestParameters Request parameters.
608
582
  * @param {*} [options] Override http request option.
609
583
  * @throws {RequiredError}
610
584
  * @memberof TranslationApi
611
585
  */
612
- getProductLanguage(requestParameters: TranslationApiGetProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductLanguageResponseClass, any>>;
586
+ getProductLanguage(requestParameters: TranslationApiGetProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductLanguageResponseClass, any>>;
613
587
  /**
614
- * This lists the product languages.
588
+ * Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
615
589
  * @summary List product languages
616
590
  * @param {TranslationApiListProductLanguagesRequest} requestParameters Request parameters.
617
591
  * @param {*} [options] Override http request option.
618
592
  * @throws {RequiredError}
619
593
  * @memberof TranslationApi
620
594
  */
621
- listProductLanguages(requestParameters: TranslationApiListProductLanguagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductLanguagesResponseClass, any>>;
595
+ listProductLanguages(requestParameters?: TranslationApiListProductLanguagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductLanguagesResponseClass, any>>;
622
596
  /**
623
- * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
597
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
624
598
  * @summary List translations
625
599
  * @param {TranslationApiListTranslationsRequest} requestParameters Request parameters.
626
600
  * @param {*} [options] Override http request option.
@@ -629,7 +603,7 @@ export declare class TranslationApi extends BaseAPI {
629
603
  */
630
604
  listTranslations(requestParameters?: TranslationApiListTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTranslationsResponseClass, any>>;
631
605
  /**
632
- * This updates the product language with the specified id.
606
+ * This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
633
607
  * @summary Update the product language
634
608
  * @param {TranslationApiUpdateProductLanguageRequest} requestParameters Request parameters.
635
609
  * @param {*} [options] Override http request option.
@@ -638,7 +612,7 @@ export declare class TranslationApi extends BaseAPI {
638
612
  */
639
613
  updateProductLanguage(requestParameters: TranslationApiUpdateProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateProductLanguageResponseClass, any>>;
640
614
  /**
641
- * This uploads the translations for a given product.
615
+ * This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
642
616
  * @summary Create the product translations
643
617
  * @param {TranslationApiUploadProductTranslationsRequest} requestParameters Request parameters.
644
618
  * @param {*} [options] Override http request option.