@emilgroup/translation-sdk-node 1.8.1-beta.1 → 1.8.1-beta.11
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/.openapi-generator/FILES +6 -0
- package/README.md +2 -2
- package/api/translation-api.ts +348 -8
- package/dist/api/translation-api.d.ts +194 -8
- package/dist/api/translation-api.js +297 -6
- package/dist/models/get-product-translations-response-class.d.ts +25 -0
- package/dist/models/get-product-translations-response-class.js +15 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/new-translation-class.d.ts +36 -0
- package/dist/models/new-translation-class.js +15 -0
- package/dist/models/refresh-product-languages-response-class.d.ts +31 -0
- package/dist/models/refresh-product-languages-response-class.js +15 -0
- package/dist/models/save-product-translations-request-dto.d.ts +53 -0
- package/dist/models/save-product-translations-request-dto.js +37 -0
- package/dist/models/skipped-translation-class.d.ts +36 -0
- package/dist/models/skipped-translation-class.js +15 -0
- package/dist/models/translatable-field-class.d.ts +54 -0
- package/dist/models/translatable-field-class.js +15 -0
- package/dist/models/upload-product-translations-response-class.d.ts +13 -0
- package/models/get-product-translations-response-class.ts +31 -0
- package/models/index.ts +6 -0
- package/models/new-translation-class.ts +42 -0
- package/models/refresh-product-languages-response-class.ts +37 -0
- package/models/save-product-translations-request-dto.ts +62 -0
- package/models/skipped-translation-class.ts +42 -0
- package/models/translatable-field-class.ts +60 -0
- package/models/upload-product-translations-response-class.ts +13 -0
- package/package.json +1 -1
|
@@ -15,8 +15,11 @@ import { RequestArgs, BaseAPI } from '../base';
|
|
|
15
15
|
import { CreateProductLanguageRequestDto } from '../models';
|
|
16
16
|
import { CreateProductLanguageResponseClass } from '../models';
|
|
17
17
|
import { GetProductLanguageResponseClass } from '../models';
|
|
18
|
+
import { GetProductTranslationsResponseClass } from '../models';
|
|
18
19
|
import { ListProductLanguagesResponseClass } from '../models';
|
|
19
20
|
import { ListTranslationsResponseClass } from '../models';
|
|
21
|
+
import { RefreshProductLanguagesResponseClass } from '../models';
|
|
22
|
+
import { SaveProductTranslationsRequestDto } from '../models';
|
|
20
23
|
import { UpdateProductLanguageRequestDto } from '../models';
|
|
21
24
|
import { UpdateProductLanguageResponseClass } from '../models';
|
|
22
25
|
import { UploadProductTranslationsResponseClass } from '../models';
|
|
@@ -62,6 +65,16 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
62
65
|
* @throws {RequiredError}
|
|
63
66
|
*/
|
|
64
67
|
getProductLanguage: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
|
+
/**
|
|
69
|
+
* This returns a product\'s translatable fields together with their current translations as JSON. Same data as the XLSX download, for editing in the UI. **Required Permissions** \"translation-management.translations.view\"
|
|
70
|
+
* @summary Retrieve the product translations
|
|
71
|
+
* @param {string} productSlug
|
|
72
|
+
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
73
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
getProductTranslations: (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>;
|
|
65
78
|
/**
|
|
66
79
|
* 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\"
|
|
67
80
|
* @summary List product languages
|
|
@@ -83,15 +96,34 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
83
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
84
97
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
85
98
|
* @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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: key</i>
|
|
99
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key, language</i>
|
|
87
100
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
88
101
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, key</i>
|
|
89
102
|
* @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.<br/> <br/>
|
|
90
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
103
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key, language</i>
|
|
91
104
|
* @param {*} [options] Override http request option.
|
|
92
105
|
* @throws {RequiredError}
|
|
93
106
|
*/
|
|
94
107
|
listTranslations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
108
|
+
/**
|
|
109
|
+
* This returns a product\'s languages with every translation count recomputed first. The plain list answers from the stored counts, which are only rewritten when somebody saves or downloads translations. **Required Permissions** \"translation-management.translations.view\"
|
|
110
|
+
* @summary Retrieve the refreshed product languages
|
|
111
|
+
* @param {string} productSlug Slug of the product.
|
|
112
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
*/
|
|
116
|
+
refreshProductLanguages: (productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
117
|
+
/**
|
|
118
|
+
* This creates or updates translations for a product from JSON. Same store as the XLSX upload. An empty value removes an existing translation. **Required Permissions** \"translation-management.translations.create\"
|
|
119
|
+
* @summary Create the product translations
|
|
120
|
+
* @param {string} productSlug
|
|
121
|
+
* @param {SaveProductTranslationsRequestDto} saveProductTranslationsRequestDto
|
|
122
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
saveProductTranslations: (productSlug: string, saveProductTranslationsRequestDto: SaveProductTranslationsRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
95
127
|
/**
|
|
96
128
|
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
97
129
|
* @summary Update the product language
|
|
@@ -155,6 +187,16 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
155
187
|
* @throws {RequiredError}
|
|
156
188
|
*/
|
|
157
189
|
getProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductLanguageResponseClass>>;
|
|
190
|
+
/**
|
|
191
|
+
* This returns a product\'s translatable fields together with their current translations as JSON. Same data as the XLSX download, for editing in the UI. **Required Permissions** \"translation-management.translations.view\"
|
|
192
|
+
* @summary Retrieve the product translations
|
|
193
|
+
* @param {string} productSlug
|
|
194
|
+
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
195
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
196
|
+
* @param {*} [options] Override http request option.
|
|
197
|
+
* @throws {RequiredError}
|
|
198
|
+
*/
|
|
199
|
+
getProductTranslations(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<GetProductTranslationsResponseClass>>;
|
|
158
200
|
/**
|
|
159
201
|
* 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\"
|
|
160
202
|
* @summary List product languages
|
|
@@ -176,15 +218,34 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
176
218
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
177
219
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
220
|
* @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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: key</i>
|
|
221
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key, language</i>
|
|
180
222
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
181
223
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, key</i>
|
|
182
224
|
* @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.<br/> <br/>
|
|
183
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
225
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key, language</i>
|
|
184
226
|
* @param {*} [options] Override http request option.
|
|
185
227
|
* @throws {RequiredError}
|
|
186
228
|
*/
|
|
187
229
|
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>>;
|
|
230
|
+
/**
|
|
231
|
+
* This returns a product\'s languages with every translation count recomputed first. The plain list answers from the stored counts, which are only rewritten when somebody saves or downloads translations. **Required Permissions** \"translation-management.translations.view\"
|
|
232
|
+
* @summary Retrieve the refreshed product languages
|
|
233
|
+
* @param {string} productSlug Slug of the product.
|
|
234
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
235
|
+
* @param {*} [options] Override http request option.
|
|
236
|
+
* @throws {RequiredError}
|
|
237
|
+
*/
|
|
238
|
+
refreshProductLanguages(productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RefreshProductLanguagesResponseClass>>;
|
|
239
|
+
/**
|
|
240
|
+
* This creates or updates translations for a product from JSON. Same store as the XLSX upload. An empty value removes an existing translation. **Required Permissions** \"translation-management.translations.create\"
|
|
241
|
+
* @summary Create the product translations
|
|
242
|
+
* @param {string} productSlug
|
|
243
|
+
* @param {SaveProductTranslationsRequestDto} saveProductTranslationsRequestDto
|
|
244
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
saveProductTranslations(productSlug: string, saveProductTranslationsRequestDto: SaveProductTranslationsRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadProductTranslationsResponseClass>>;
|
|
188
249
|
/**
|
|
189
250
|
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
190
251
|
* @summary Update the product language
|
|
@@ -248,6 +309,16 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
248
309
|
* @throws {RequiredError}
|
|
249
310
|
*/
|
|
250
311
|
getProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<GetProductLanguageResponseClass>;
|
|
312
|
+
/**
|
|
313
|
+
* This returns a product\'s translatable fields together with their current translations as JSON. Same data as the XLSX download, for editing in the UI. **Required Permissions** \"translation-management.translations.view\"
|
|
314
|
+
* @summary Retrieve the product translations
|
|
315
|
+
* @param {string} productSlug
|
|
316
|
+
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
317
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
318
|
+
* @param {*} [options] Override http request option.
|
|
319
|
+
* @throws {RequiredError}
|
|
320
|
+
*/
|
|
321
|
+
getProductTranslations(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<GetProductTranslationsResponseClass>;
|
|
251
322
|
/**
|
|
252
323
|
* 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\"
|
|
253
324
|
* @summary List product languages
|
|
@@ -269,15 +340,34 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
269
340
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
270
341
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
342
|
* @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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: key</i>
|
|
343
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key, language</i>
|
|
273
344
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
274
345
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, key</i>
|
|
275
346
|
* @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.<br/> <br/>
|
|
276
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
347
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key, language</i>
|
|
277
348
|
* @param {*} [options] Override http request option.
|
|
278
349
|
* @throws {RequiredError}
|
|
279
350
|
*/
|
|
280
351
|
listTranslations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTranslationsResponseClass>;
|
|
352
|
+
/**
|
|
353
|
+
* This returns a product\'s languages with every translation count recomputed first. The plain list answers from the stored counts, which are only rewritten when somebody saves or downloads translations. **Required Permissions** \"translation-management.translations.view\"
|
|
354
|
+
* @summary Retrieve the refreshed product languages
|
|
355
|
+
* @param {string} productSlug Slug of the product.
|
|
356
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
|
+
* @param {*} [options] Override http request option.
|
|
358
|
+
* @throws {RequiredError}
|
|
359
|
+
*/
|
|
360
|
+
refreshProductLanguages(productSlug: string, authorization?: string, options?: any): AxiosPromise<RefreshProductLanguagesResponseClass>;
|
|
361
|
+
/**
|
|
362
|
+
* This creates or updates translations for a product from JSON. Same store as the XLSX upload. An empty value removes an existing translation. **Required Permissions** \"translation-management.translations.create\"
|
|
363
|
+
* @summary Create the product translations
|
|
364
|
+
* @param {string} productSlug
|
|
365
|
+
* @param {SaveProductTranslationsRequestDto} saveProductTranslationsRequestDto
|
|
366
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
|
+
* @param {*} [options] Override http request option.
|
|
368
|
+
* @throws {RequiredError}
|
|
369
|
+
*/
|
|
370
|
+
saveProductTranslations(productSlug: string, saveProductTranslationsRequestDto: SaveProductTranslationsRequestDto, authorization?: string, options?: any): AxiosPromise<UploadProductTranslationsResponseClass>;
|
|
281
371
|
/**
|
|
282
372
|
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
283
373
|
* @summary Update the product language
|
|
@@ -381,6 +471,31 @@ export interface TranslationApiGetProductLanguageRequest {
|
|
|
381
471
|
*/
|
|
382
472
|
readonly authorization?: string;
|
|
383
473
|
}
|
|
474
|
+
/**
|
|
475
|
+
* Request parameters for getProductTranslations operation in TranslationApi.
|
|
476
|
+
* @export
|
|
477
|
+
* @interface TranslationApiGetProductTranslationsRequest
|
|
478
|
+
*/
|
|
479
|
+
export interface TranslationApiGetProductTranslationsRequest {
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @type {string}
|
|
483
|
+
* @memberof TranslationApiGetProductTranslations
|
|
484
|
+
*/
|
|
485
|
+
readonly productSlug: string;
|
|
486
|
+
/**
|
|
487
|
+
*
|
|
488
|
+
* @type {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'}
|
|
489
|
+
* @memberof TranslationApiGetProductTranslations
|
|
490
|
+
*/
|
|
491
|
+
readonly language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian';
|
|
492
|
+
/**
|
|
493
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
494
|
+
* @type {string}
|
|
495
|
+
* @memberof TranslationApiGetProductTranslations
|
|
496
|
+
*/
|
|
497
|
+
readonly authorization?: string;
|
|
498
|
+
}
|
|
384
499
|
/**
|
|
385
500
|
* Request parameters for listProductLanguages operation in TranslationApi.
|
|
386
501
|
* @export
|
|
@@ -461,7 +576,7 @@ export interface TranslationApiListTranslationsRequest {
|
|
|
461
576
|
*/
|
|
462
577
|
readonly pageToken?: string;
|
|
463
578
|
/**
|
|
464
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key</i>
|
|
579
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key, language</i>
|
|
465
580
|
* @type {string}
|
|
466
581
|
* @memberof TranslationApiListTranslations
|
|
467
582
|
*/
|
|
@@ -485,12 +600,56 @@ export interface TranslationApiListTranslationsRequest {
|
|
|
485
600
|
*/
|
|
486
601
|
readonly expand?: string;
|
|
487
602
|
/**
|
|
488
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
603
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key, language</i>
|
|
489
604
|
* @type {string}
|
|
490
605
|
* @memberof TranslationApiListTranslations
|
|
491
606
|
*/
|
|
492
607
|
readonly filters?: string;
|
|
493
608
|
}
|
|
609
|
+
/**
|
|
610
|
+
* Request parameters for refreshProductLanguages operation in TranslationApi.
|
|
611
|
+
* @export
|
|
612
|
+
* @interface TranslationApiRefreshProductLanguagesRequest
|
|
613
|
+
*/
|
|
614
|
+
export interface TranslationApiRefreshProductLanguagesRequest {
|
|
615
|
+
/**
|
|
616
|
+
* Slug of the product.
|
|
617
|
+
* @type {string}
|
|
618
|
+
* @memberof TranslationApiRefreshProductLanguages
|
|
619
|
+
*/
|
|
620
|
+
readonly productSlug: string;
|
|
621
|
+
/**
|
|
622
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
623
|
+
* @type {string}
|
|
624
|
+
* @memberof TranslationApiRefreshProductLanguages
|
|
625
|
+
*/
|
|
626
|
+
readonly authorization?: string;
|
|
627
|
+
}
|
|
628
|
+
/**
|
|
629
|
+
* Request parameters for saveProductTranslations operation in TranslationApi.
|
|
630
|
+
* @export
|
|
631
|
+
* @interface TranslationApiSaveProductTranslationsRequest
|
|
632
|
+
*/
|
|
633
|
+
export interface TranslationApiSaveProductTranslationsRequest {
|
|
634
|
+
/**
|
|
635
|
+
*
|
|
636
|
+
* @type {string}
|
|
637
|
+
* @memberof TranslationApiSaveProductTranslations
|
|
638
|
+
*/
|
|
639
|
+
readonly productSlug: string;
|
|
640
|
+
/**
|
|
641
|
+
*
|
|
642
|
+
* @type {SaveProductTranslationsRequestDto}
|
|
643
|
+
* @memberof TranslationApiSaveProductTranslations
|
|
644
|
+
*/
|
|
645
|
+
readonly saveProductTranslationsRequestDto: SaveProductTranslationsRequestDto;
|
|
646
|
+
/**
|
|
647
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
648
|
+
* @type {string}
|
|
649
|
+
* @memberof TranslationApiSaveProductTranslations
|
|
650
|
+
*/
|
|
651
|
+
readonly authorization?: string;
|
|
652
|
+
}
|
|
494
653
|
/**
|
|
495
654
|
* Request parameters for updateProductLanguage operation in TranslationApi.
|
|
496
655
|
* @export
|
|
@@ -584,6 +743,15 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
584
743
|
* @memberof TranslationApi
|
|
585
744
|
*/
|
|
586
745
|
getProductLanguage(requestParameters: TranslationApiGetProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductLanguageResponseClass, any, {}>>;
|
|
746
|
+
/**
|
|
747
|
+
* This returns a product\'s translatable fields together with their current translations as JSON. Same data as the XLSX download, for editing in the UI. **Required Permissions** \"translation-management.translations.view\"
|
|
748
|
+
* @summary Retrieve the product translations
|
|
749
|
+
* @param {TranslationApiGetProductTranslationsRequest} requestParameters Request parameters.
|
|
750
|
+
* @param {*} [options] Override http request option.
|
|
751
|
+
* @throws {RequiredError}
|
|
752
|
+
* @memberof TranslationApi
|
|
753
|
+
*/
|
|
754
|
+
getProductTranslations(requestParameters: TranslationApiGetProductTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductTranslationsResponseClass, any, {}>>;
|
|
587
755
|
/**
|
|
588
756
|
* 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\"
|
|
589
757
|
* @summary List product languages
|
|
@@ -602,6 +770,24 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
602
770
|
* @memberof TranslationApi
|
|
603
771
|
*/
|
|
604
772
|
listTranslations(requestParameters?: TranslationApiListTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTranslationsResponseClass, any, {}>>;
|
|
773
|
+
/**
|
|
774
|
+
* This returns a product\'s languages with every translation count recomputed first. The plain list answers from the stored counts, which are only rewritten when somebody saves or downloads translations. **Required Permissions** \"translation-management.translations.view\"
|
|
775
|
+
* @summary Retrieve the refreshed product languages
|
|
776
|
+
* @param {TranslationApiRefreshProductLanguagesRequest} requestParameters Request parameters.
|
|
777
|
+
* @param {*} [options] Override http request option.
|
|
778
|
+
* @throws {RequiredError}
|
|
779
|
+
* @memberof TranslationApi
|
|
780
|
+
*/
|
|
781
|
+
refreshProductLanguages(requestParameters: TranslationApiRefreshProductLanguagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RefreshProductLanguagesResponseClass, any, {}>>;
|
|
782
|
+
/**
|
|
783
|
+
* This creates or updates translations for a product from JSON. Same store as the XLSX upload. An empty value removes an existing translation. **Required Permissions** \"translation-management.translations.create\"
|
|
784
|
+
* @summary Create the product translations
|
|
785
|
+
* @param {TranslationApiSaveProductTranslationsRequest} requestParameters Request parameters.
|
|
786
|
+
* @param {*} [options] Override http request option.
|
|
787
|
+
* @throws {RequiredError}
|
|
788
|
+
* @memberof TranslationApi
|
|
789
|
+
*/
|
|
790
|
+
saveProductTranslations(requestParameters: TranslationApiSaveProductTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadProductTranslationsResponseClass, any, {}>>;
|
|
605
791
|
/**
|
|
606
792
|
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
607
793
|
* @summary Update the product language
|