@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.
- package/.openapi-generator/FILES +4 -0
- package/README.md +9 -26
- package/api/default-api.ts +124 -0
- package/api/translation-api.ts +170 -209
- package/api.ts +2 -4
- package/base.ts +140 -97
- package/common.ts +2 -3
- package/configuration.ts +9 -8
- package/dist/api/default-api.d.ts +70 -0
- package/dist/api/default-api.js +200 -0
- package/dist/api/translation-api.d.ts +139 -165
- package/dist/api/translation-api.js +125 -147
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +22 -13
- package/dist/base.js +125 -153
- package/dist/common.d.ts +0 -1
- package/dist/common.js +3 -4
- package/dist/configuration.d.ts +6 -7
- package/dist/configuration.js +8 -0
- package/dist/models/create-product-language-request-dto.d.ts +1 -1
- package/dist/models/get-product-language-response-class.d.ts +25 -0
- package/dist/models/get-product-language-response-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/product-language-class.d.ts +4 -4
- package/models/create-product-language-request-dto.ts +1 -1
- package/models/get-product-language-response-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/product-language-class.ts +4 -4
- package/package.json +2 -5
- package/tsconfig.json +1 -0
package/api/translation-api.ts
CHANGED
|
@@ -25,6 +25,8 @@ import { CreateProductLanguageRequestDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { CreateProductLanguageResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
+
import { GetProductLanguageResponseClass } from '../models';
|
|
29
|
+
// @ts-ignore
|
|
28
30
|
import { ListProductLanguagesResponseClass } from '../models';
|
|
29
31
|
// @ts-ignore
|
|
30
32
|
import { ListTranslationsResponseClass } from '../models';
|
|
@@ -34,10 +36,6 @@ import { UpdateProductLanguageRequestDto } from '../models';
|
|
|
34
36
|
import { UpdateProductLanguageResponseClass } from '../models';
|
|
35
37
|
// @ts-ignore
|
|
36
38
|
import { UploadProductTranslationsResponseClass } from '../models';
|
|
37
|
-
// URLSearchParams not necessarily used
|
|
38
|
-
// @ts-ignore
|
|
39
|
-
import { URL, URLSearchParams } from 'url';
|
|
40
|
-
const FormData = require('form-data');
|
|
41
39
|
/**
|
|
42
40
|
* TranslationApi - axios parameter creator
|
|
43
41
|
* @export
|
|
@@ -45,21 +43,17 @@ const FormData = require('form-data');
|
|
|
45
43
|
export const TranslationApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
44
|
return {
|
|
47
45
|
/**
|
|
48
|
-
* This creates a product language.
|
|
46
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
49
47
|
* @summary Create the product language
|
|
50
|
-
* @param {string} productSlug
|
|
51
48
|
* @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
|
|
52
49
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
53
50
|
* @param {*} [options] Override http request option.
|
|
54
51
|
* @throws {RequiredError}
|
|
55
52
|
*/
|
|
56
|
-
createProductLanguage: async (
|
|
57
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
58
|
-
assertParamExists('createProductLanguage', 'productSlug', productSlug)
|
|
53
|
+
createProductLanguage: async (createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59
54
|
// verify required parameter 'createProductLanguageRequestDto' is not null or undefined
|
|
60
55
|
assertParamExists('createProductLanguage', 'createProductLanguageRequestDto', createProductLanguageRequestDto)
|
|
61
|
-
const localVarPath = `/translationservice/v1/
|
|
62
|
-
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
56
|
+
const localVarPath = `/translationservice/v1/languages`;
|
|
63
57
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
64
58
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
65
59
|
let baseOptions;
|
|
@@ -96,7 +90,7 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
96
90
|
};
|
|
97
91
|
},
|
|
98
92
|
/**
|
|
99
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
93
|
+
* 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\"
|
|
100
94
|
* @summary Delete the product language
|
|
101
95
|
* @param {number} id Id of the product language.
|
|
102
96
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -106,7 +100,7 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
106
100
|
deleteProductLanguage: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
107
101
|
// verify required parameter 'id' is not null or undefined
|
|
108
102
|
assertParamExists('deleteProductLanguage', 'id', id)
|
|
109
|
-
const localVarPath = `/translationservice/v1/
|
|
103
|
+
const localVarPath = `/translationservice/v1/languages/{id}`
|
|
110
104
|
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
111
105
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
112
106
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -141,7 +135,7 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
141
135
|
};
|
|
142
136
|
},
|
|
143
137
|
/**
|
|
144
|
-
* This downloads the list of translatable fields for a given product.
|
|
138
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
145
139
|
* @summary Retrieve the product translations
|
|
146
140
|
* @param {string} productSlug
|
|
147
141
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -193,22 +187,18 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
193
187
|
};
|
|
194
188
|
},
|
|
195
189
|
/**
|
|
196
|
-
* This gets a product language.
|
|
190
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
197
191
|
* @summary Retrieve the product language
|
|
198
192
|
* @param {number} id Id of the product language.
|
|
199
|
-
* @param {string} productSlug Product slug of the product.
|
|
200
193
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
194
|
* @param {*} [options] Override http request option.
|
|
202
195
|
* @throws {RequiredError}
|
|
203
196
|
*/
|
|
204
|
-
getProductLanguage: async (id: number,
|
|
197
|
+
getProductLanguage: async (id: number, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
205
198
|
// verify required parameter 'id' is not null or undefined
|
|
206
199
|
assertParamExists('getProductLanguage', 'id', id)
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
const localVarPath = `/translationservice/v1/product/{productSlug}/language/{id}`
|
|
210
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
211
|
-
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
200
|
+
const localVarPath = `/translationservice/v1/languages/{id}`
|
|
201
|
+
.replace(`{${"id"}}`, encodeURIComponent(String(id)));
|
|
212
202
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
213
203
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
214
204
|
let baseOptions;
|
|
@@ -242,24 +232,21 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
242
232
|
};
|
|
243
233
|
},
|
|
244
234
|
/**
|
|
245
|
-
*
|
|
235
|
+
* 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\"
|
|
246
236
|
* @summary List product languages
|
|
247
|
-
* @param {string} productSlug Product slug of the product.
|
|
248
237
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
249
|
-
* @param {
|
|
250
|
-
* @param {
|
|
251
|
-
* @param {
|
|
252
|
-
* @param {
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
238
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
239
|
+
* @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.
|
|
240
|
+
* @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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
241
|
+
* @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: id, language</i>
|
|
242
|
+
* @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, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
243
|
+
* @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/>
|
|
244
|
+
* @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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
255
245
|
* @param {*} [options] Override http request option.
|
|
256
246
|
* @throws {RequiredError}
|
|
257
247
|
*/
|
|
258
|
-
listProductLanguages: async (
|
|
259
|
-
|
|
260
|
-
assertParamExists('listProductLanguages', 'productSlug', productSlug)
|
|
261
|
-
const localVarPath = `/translationservice/v1/product/{productSlug}/language`
|
|
262
|
-
.replace(`{${"productSlug"}}`, encodeURIComponent(String(productSlug)));
|
|
248
|
+
listProductLanguages: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
249
|
+
const localVarPath = `/translationservice/v1/languages`;
|
|
263
250
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
264
251
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
265
252
|
let baseOptions;
|
|
@@ -301,6 +288,10 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
301
288
|
localVarQueryParameter['expand'] = expand;
|
|
302
289
|
}
|
|
303
290
|
|
|
291
|
+
if (filters !== undefined) {
|
|
292
|
+
localVarQueryParameter['filters'] = filters;
|
|
293
|
+
}
|
|
294
|
+
|
|
304
295
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
305
296
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
306
297
|
}
|
|
@@ -317,19 +308,20 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
317
308
|
};
|
|
318
309
|
},
|
|
319
310
|
/**
|
|
320
|
-
* Returns a list of translations you have previously created.
|
|
311
|
+
* 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\"
|
|
321
312
|
* @summary List translations
|
|
322
313
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
323
|
-
* @param {
|
|
324
|
-
* @param {
|
|
325
|
-
* @param {
|
|
326
|
-
* @param {
|
|
327
|
-
* @param {
|
|
328
|
-
* @param {
|
|
314
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
315
|
+
* @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.
|
|
316
|
+
* @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>
|
|
317
|
+
* @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>
|
|
318
|
+
* @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>
|
|
319
|
+
* @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/>
|
|
320
|
+
* @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>
|
|
329
321
|
* @param {*} [options] Override http request option.
|
|
330
322
|
* @throws {RequiredError}
|
|
331
323
|
*/
|
|
332
|
-
listTranslations: async (authorization?: string, pageSize?:
|
|
324
|
+
listTranslations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
333
325
|
const localVarPath = `/translationservice/v1/translations`;
|
|
334
326
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
335
327
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -372,6 +364,10 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
372
364
|
localVarQueryParameter['expand'] = expand;
|
|
373
365
|
}
|
|
374
366
|
|
|
367
|
+
if (filters !== undefined) {
|
|
368
|
+
localVarQueryParameter['filters'] = filters;
|
|
369
|
+
}
|
|
370
|
+
|
|
375
371
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
376
372
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
377
373
|
}
|
|
@@ -388,25 +384,17 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
388
384
|
};
|
|
389
385
|
},
|
|
390
386
|
/**
|
|
391
|
-
* This updates the product language with the specified id.
|
|
387
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
392
388
|
* @summary Update the product language
|
|
393
|
-
* @param {number} id Id of the product language.
|
|
394
|
-
* @param {string} productSlug Product slug of the product.
|
|
395
389
|
* @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
|
|
396
390
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
397
391
|
* @param {*} [options] Override http request option.
|
|
398
392
|
* @throws {RequiredError}
|
|
399
393
|
*/
|
|
400
|
-
updateProductLanguage: async (
|
|
401
|
-
// verify required parameter 'id' is not null or undefined
|
|
402
|
-
assertParamExists('updateProductLanguage', 'id', id)
|
|
403
|
-
// verify required parameter 'productSlug' is not null or undefined
|
|
404
|
-
assertParamExists('updateProductLanguage', 'productSlug', productSlug)
|
|
394
|
+
updateProductLanguage: async (updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
405
395
|
// verify required parameter 'updateProductLanguageRequestDto' is not null or undefined
|
|
406
396
|
assertParamExists('updateProductLanguage', 'updateProductLanguageRequestDto', updateProductLanguageRequestDto)
|
|
407
|
-
const localVarPath = `/translationservice/v1/
|
|
408
|
-
.replace(`{${"id"}}`, encodeURIComponent(String(id)))
|
|
409
|
-
.replace(`{${"product slug"}}`, encodeURIComponent(String(productSlug)));
|
|
397
|
+
const localVarPath = `/translationservice/v1/languages`;
|
|
410
398
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
411
399
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
412
400
|
let baseOptions;
|
|
@@ -443,7 +431,7 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
443
431
|
};
|
|
444
432
|
},
|
|
445
433
|
/**
|
|
446
|
-
* This uploads the translations for a given product.
|
|
434
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
447
435
|
* @summary Create the product translations
|
|
448
436
|
* @param {string} productSlug
|
|
449
437
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -491,7 +479,7 @@ export const TranslationApiAxiosParamCreator = function (configuration?: Configu
|
|
|
491
479
|
}
|
|
492
480
|
|
|
493
481
|
|
|
494
|
-
|
|
482
|
+
|
|
495
483
|
|
|
496
484
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
497
485
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -514,20 +502,19 @@ export const TranslationApiFp = function(configuration?: Configuration) {
|
|
|
514
502
|
const localVarAxiosParamCreator = TranslationApiAxiosParamCreator(configuration)
|
|
515
503
|
return {
|
|
516
504
|
/**
|
|
517
|
-
* This creates a product language.
|
|
505
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
518
506
|
* @summary Create the product language
|
|
519
|
-
* @param {string} productSlug
|
|
520
507
|
* @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
|
|
521
508
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
522
509
|
* @param {*} [options] Override http request option.
|
|
523
510
|
* @throws {RequiredError}
|
|
524
511
|
*/
|
|
525
|
-
async createProductLanguage(
|
|
526
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createProductLanguage(
|
|
512
|
+
async createProductLanguage(createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>> {
|
|
513
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createProductLanguage(createProductLanguageRequestDto, authorization, options);
|
|
527
514
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
528
515
|
},
|
|
529
516
|
/**
|
|
530
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
517
|
+
* 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\"
|
|
531
518
|
* @summary Delete the product language
|
|
532
519
|
* @param {number} id Id of the product language.
|
|
533
520
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -539,7 +526,7 @@ export const TranslationApiFp = function(configuration?: Configuration) {
|
|
|
539
526
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
540
527
|
},
|
|
541
528
|
/**
|
|
542
|
-
* This downloads the list of translatable fields for a given product.
|
|
529
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
543
530
|
* @summary Retrieve the product translations
|
|
544
531
|
* @param {string} productSlug
|
|
545
532
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -552,69 +539,67 @@ export const TranslationApiFp = function(configuration?: Configuration) {
|
|
|
552
539
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
553
540
|
},
|
|
554
541
|
/**
|
|
555
|
-
* This gets a product language.
|
|
542
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
556
543
|
* @summary Retrieve the product language
|
|
557
544
|
* @param {number} id Id of the product language.
|
|
558
|
-
* @param {string} productSlug Product slug of the product.
|
|
559
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
560
546
|
* @param {*} [options] Override http request option.
|
|
561
547
|
* @throws {RequiredError}
|
|
562
548
|
*/
|
|
563
|
-
async getProductLanguage(id: number,
|
|
564
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductLanguage(id,
|
|
549
|
+
async getProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductLanguageResponseClass>> {
|
|
550
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getProductLanguage(id, authorization, options);
|
|
565
551
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
566
552
|
},
|
|
567
553
|
/**
|
|
568
|
-
*
|
|
554
|
+
* 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\"
|
|
569
555
|
* @summary List product languages
|
|
570
|
-
* @param {string} productSlug Product slug of the product.
|
|
571
556
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
572
|
-
* @param {
|
|
573
|
-
* @param {
|
|
574
|
-
* @param {
|
|
575
|
-
* @param {
|
|
576
|
-
* @param {
|
|
577
|
-
* @param {
|
|
557
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
558
|
+
* @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.
|
|
559
|
+
* @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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
560
|
+
* @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: id, language</i>
|
|
561
|
+
* @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, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
562
|
+
* @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/>
|
|
563
|
+
* @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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
578
564
|
* @param {*} [options] Override http request option.
|
|
579
565
|
* @throws {RequiredError}
|
|
580
566
|
*/
|
|
581
|
-
async listProductLanguages(
|
|
582
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductLanguages(
|
|
567
|
+
async 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>> {
|
|
568
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listProductLanguages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
583
569
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
584
570
|
},
|
|
585
571
|
/**
|
|
586
|
-
* Returns a list of translations you have previously created.
|
|
572
|
+
* 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\"
|
|
587
573
|
* @summary List translations
|
|
588
574
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
589
|
-
* @param {
|
|
590
|
-
* @param {
|
|
591
|
-
* @param {
|
|
592
|
-
* @param {
|
|
593
|
-
* @param {
|
|
594
|
-
* @param {
|
|
575
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
576
|
+
* @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.
|
|
577
|
+
* @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>
|
|
578
|
+
* @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>
|
|
579
|
+
* @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>
|
|
580
|
+
* @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/>
|
|
581
|
+
* @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>
|
|
595
582
|
* @param {*} [options] Override http request option.
|
|
596
583
|
* @throws {RequiredError}
|
|
597
584
|
*/
|
|
598
|
-
async listTranslations(authorization?: string, pageSize?:
|
|
599
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTranslations(authorization, pageSize, pageToken, filter, search, order, expand, options);
|
|
585
|
+
async 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>> {
|
|
586
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTranslations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
600
587
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
601
588
|
},
|
|
602
589
|
/**
|
|
603
|
-
* This updates the product language with the specified id.
|
|
590
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
604
591
|
* @summary Update the product language
|
|
605
|
-
* @param {number} id Id of the product language.
|
|
606
|
-
* @param {string} productSlug Product slug of the product.
|
|
607
592
|
* @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
|
|
608
593
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
609
594
|
* @param {*} [options] Override http request option.
|
|
610
595
|
* @throws {RequiredError}
|
|
611
596
|
*/
|
|
612
|
-
async updateProductLanguage(
|
|
613
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductLanguage(
|
|
597
|
+
async updateProductLanguage(updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductLanguageResponseClass>> {
|
|
598
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductLanguage(updateProductLanguageRequestDto, authorization, options);
|
|
614
599
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
615
600
|
},
|
|
616
601
|
/**
|
|
617
|
-
* This uploads the translations for a given product.
|
|
602
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
618
603
|
* @summary Create the product translations
|
|
619
604
|
* @param {string} productSlug
|
|
620
605
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -638,19 +623,18 @@ export const TranslationApiFactory = function (configuration?: Configuration, ba
|
|
|
638
623
|
const localVarFp = TranslationApiFp(configuration)
|
|
639
624
|
return {
|
|
640
625
|
/**
|
|
641
|
-
* This creates a product language.
|
|
626
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
642
627
|
* @summary Create the product language
|
|
643
|
-
* @param {string} productSlug
|
|
644
628
|
* @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
|
|
645
629
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
646
630
|
* @param {*} [options] Override http request option.
|
|
647
631
|
* @throws {RequiredError}
|
|
648
632
|
*/
|
|
649
|
-
createProductLanguage(
|
|
650
|
-
return localVarFp.createProductLanguage(
|
|
633
|
+
createProductLanguage(createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass> {
|
|
634
|
+
return localVarFp.createProductLanguage(createProductLanguageRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
651
635
|
},
|
|
652
636
|
/**
|
|
653
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
637
|
+
* 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\"
|
|
654
638
|
* @summary Delete the product language
|
|
655
639
|
* @param {number} id Id of the product language.
|
|
656
640
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -661,7 +645,7 @@ export const TranslationApiFactory = function (configuration?: Configuration, ba
|
|
|
661
645
|
return localVarFp.deleteProductLanguage(id, authorization, options).then((request) => request(axios, basePath));
|
|
662
646
|
},
|
|
663
647
|
/**
|
|
664
|
-
* This downloads the list of translatable fields for a given product.
|
|
648
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
665
649
|
* @summary Retrieve the product translations
|
|
666
650
|
* @param {string} productSlug
|
|
667
651
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -673,65 +657,63 @@ export const TranslationApiFactory = function (configuration?: Configuration, ba
|
|
|
673
657
|
return localVarFp.downloadProductTranslations(productSlug, language, authorization, options).then((request) => request(axios, basePath));
|
|
674
658
|
},
|
|
675
659
|
/**
|
|
676
|
-
* This gets a product language.
|
|
660
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
677
661
|
* @summary Retrieve the product language
|
|
678
662
|
* @param {number} id Id of the product language.
|
|
679
|
-
* @param {string} productSlug Product slug of the product.
|
|
680
663
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
681
664
|
* @param {*} [options] Override http request option.
|
|
682
665
|
* @throws {RequiredError}
|
|
683
666
|
*/
|
|
684
|
-
getProductLanguage(id: number,
|
|
685
|
-
return localVarFp.getProductLanguage(id,
|
|
667
|
+
getProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<GetProductLanguageResponseClass> {
|
|
668
|
+
return localVarFp.getProductLanguage(id, authorization, options).then((request) => request(axios, basePath));
|
|
686
669
|
},
|
|
687
670
|
/**
|
|
688
|
-
*
|
|
671
|
+
* 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\"
|
|
689
672
|
* @summary List product languages
|
|
690
|
-
* @param {string} productSlug Product slug of the product.
|
|
691
673
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
692
|
-
* @param {
|
|
693
|
-
* @param {
|
|
694
|
-
* @param {
|
|
695
|
-
* @param {
|
|
696
|
-
* @param {
|
|
697
|
-
* @param {
|
|
674
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
675
|
+
* @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.
|
|
676
|
+
* @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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
677
|
+
* @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: id, language</i>
|
|
678
|
+
* @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, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
679
|
+
* @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/>
|
|
680
|
+
* @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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
698
681
|
* @param {*} [options] Override http request option.
|
|
699
682
|
* @throws {RequiredError}
|
|
700
683
|
*/
|
|
701
|
-
listProductLanguages(
|
|
702
|
-
return localVarFp.listProductLanguages(
|
|
684
|
+
listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductLanguagesResponseClass> {
|
|
685
|
+
return localVarFp.listProductLanguages(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
703
686
|
},
|
|
704
687
|
/**
|
|
705
|
-
* Returns a list of translations you have previously created.
|
|
688
|
+
* 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\"
|
|
706
689
|
* @summary List translations
|
|
707
690
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
708
|
-
* @param {
|
|
709
|
-
* @param {
|
|
710
|
-
* @param {
|
|
711
|
-
* @param {
|
|
712
|
-
* @param {
|
|
713
|
-
* @param {
|
|
691
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
692
|
+
* @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.
|
|
693
|
+
* @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>
|
|
694
|
+
* @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>
|
|
695
|
+
* @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>
|
|
696
|
+
* @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/>
|
|
697
|
+
* @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>
|
|
714
698
|
* @param {*} [options] Override http request option.
|
|
715
699
|
* @throws {RequiredError}
|
|
716
700
|
*/
|
|
717
|
-
listTranslations(authorization?: string, pageSize?:
|
|
718
|
-
return localVarFp.listTranslations(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
701
|
+
listTranslations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTranslationsResponseClass> {
|
|
702
|
+
return localVarFp.listTranslations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
719
703
|
},
|
|
720
704
|
/**
|
|
721
|
-
* This updates the product language with the specified id.
|
|
705
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
722
706
|
* @summary Update the product language
|
|
723
|
-
* @param {number} id Id of the product language.
|
|
724
|
-
* @param {string} productSlug Product slug of the product.
|
|
725
707
|
* @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
|
|
726
708
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
727
709
|
* @param {*} [options] Override http request option.
|
|
728
710
|
* @throws {RequiredError}
|
|
729
711
|
*/
|
|
730
|
-
updateProductLanguage(
|
|
731
|
-
return localVarFp.updateProductLanguage(
|
|
712
|
+
updateProductLanguage(updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductLanguageResponseClass> {
|
|
713
|
+
return localVarFp.updateProductLanguage(updateProductLanguageRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
732
714
|
},
|
|
733
715
|
/**
|
|
734
|
-
* This uploads the translations for a given product.
|
|
716
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
735
717
|
* @summary Create the product translations
|
|
736
718
|
* @param {string} productSlug
|
|
737
719
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -752,13 +734,6 @@ export const TranslationApiFactory = function (configuration?: Configuration, ba
|
|
|
752
734
|
* @interface TranslationApiCreateProductLanguageRequest
|
|
753
735
|
*/
|
|
754
736
|
export interface TranslationApiCreateProductLanguageRequest {
|
|
755
|
-
/**
|
|
756
|
-
*
|
|
757
|
-
* @type {string}
|
|
758
|
-
* @memberof TranslationApiCreateProductLanguage
|
|
759
|
-
*/
|
|
760
|
-
readonly productSlug: string
|
|
761
|
-
|
|
762
737
|
/**
|
|
763
738
|
*
|
|
764
739
|
* @type {CreateProductLanguageRequestDto}
|
|
@@ -836,13 +811,6 @@ export interface TranslationApiGetProductLanguageRequest {
|
|
|
836
811
|
*/
|
|
837
812
|
readonly id: number
|
|
838
813
|
|
|
839
|
-
/**
|
|
840
|
-
* Product slug of the product.
|
|
841
|
-
* @type {string}
|
|
842
|
-
* @memberof TranslationApiGetProductLanguage
|
|
843
|
-
*/
|
|
844
|
-
readonly productSlug: string
|
|
845
|
-
|
|
846
814
|
/**
|
|
847
815
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
848
816
|
* @type {string}
|
|
@@ -858,60 +826,60 @@ export interface TranslationApiGetProductLanguageRequest {
|
|
|
858
826
|
*/
|
|
859
827
|
export interface TranslationApiListProductLanguagesRequest {
|
|
860
828
|
/**
|
|
861
|
-
*
|
|
829
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
862
830
|
* @type {string}
|
|
863
831
|
* @memberof TranslationApiListProductLanguages
|
|
864
832
|
*/
|
|
865
|
-
readonly
|
|
833
|
+
readonly authorization?: string
|
|
866
834
|
|
|
867
835
|
/**
|
|
868
|
-
*
|
|
869
|
-
* @type {
|
|
836
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
837
|
+
* @type {number}
|
|
870
838
|
* @memberof TranslationApiListProductLanguages
|
|
871
839
|
*/
|
|
872
|
-
readonly
|
|
840
|
+
readonly pageSize?: number
|
|
873
841
|
|
|
874
842
|
/**
|
|
875
|
-
* A
|
|
876
|
-
* @type {
|
|
843
|
+
* 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.
|
|
844
|
+
* @type {string}
|
|
877
845
|
* @memberof TranslationApiListProductLanguages
|
|
878
846
|
*/
|
|
879
|
-
readonly
|
|
847
|
+
readonly pageToken?: string
|
|
880
848
|
|
|
881
849
|
/**
|
|
882
|
-
*
|
|
883
|
-
* @type {
|
|
850
|
+
* 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: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
851
|
+
* @type {string}
|
|
884
852
|
* @memberof TranslationApiListProductLanguages
|
|
885
853
|
*/
|
|
886
|
-
readonly
|
|
854
|
+
readonly filter?: string
|
|
887
855
|
|
|
888
856
|
/**
|
|
889
|
-
*
|
|
890
|
-
* @type {
|
|
857
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, language</i>
|
|
858
|
+
* @type {string}
|
|
891
859
|
* @memberof TranslationApiListProductLanguages
|
|
892
860
|
*/
|
|
893
|
-
readonly
|
|
861
|
+
readonly search?: string
|
|
894
862
|
|
|
895
863
|
/**
|
|
896
|
-
*
|
|
897
|
-
* @type {
|
|
864
|
+
* 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, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
865
|
+
* @type {string}
|
|
898
866
|
* @memberof TranslationApiListProductLanguages
|
|
899
867
|
*/
|
|
900
|
-
readonly
|
|
868
|
+
readonly order?: string
|
|
901
869
|
|
|
902
870
|
/**
|
|
903
|
-
*
|
|
904
|
-
* @type {
|
|
871
|
+
* 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/>
|
|
872
|
+
* @type {string}
|
|
905
873
|
* @memberof TranslationApiListProductLanguages
|
|
906
874
|
*/
|
|
907
|
-
readonly
|
|
875
|
+
readonly expand?: string
|
|
908
876
|
|
|
909
877
|
/**
|
|
910
|
-
*
|
|
911
|
-
* @type {
|
|
878
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
879
|
+
* @type {string}
|
|
912
880
|
* @memberof TranslationApiListProductLanguages
|
|
913
881
|
*/
|
|
914
|
-
readonly
|
|
882
|
+
readonly filters?: string
|
|
915
883
|
}
|
|
916
884
|
|
|
917
885
|
/**
|
|
@@ -928,46 +896,53 @@ export interface TranslationApiListTranslationsRequest {
|
|
|
928
896
|
readonly authorization?: string
|
|
929
897
|
|
|
930
898
|
/**
|
|
931
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
932
|
-
* @type {
|
|
899
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
900
|
+
* @type {number}
|
|
933
901
|
* @memberof TranslationApiListTranslations
|
|
934
902
|
*/
|
|
935
|
-
readonly pageSize?:
|
|
903
|
+
readonly pageSize?: number
|
|
936
904
|
|
|
937
905
|
/**
|
|
938
|
-
* 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,
|
|
939
|
-
* @type {
|
|
906
|
+
* 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.
|
|
907
|
+
* @type {string}
|
|
940
908
|
* @memberof TranslationApiListTranslations
|
|
941
909
|
*/
|
|
942
|
-
readonly pageToken?:
|
|
910
|
+
readonly pageToken?: string
|
|
943
911
|
|
|
944
912
|
/**
|
|
945
|
-
* Filter the response by one or multiple fields.
|
|
946
|
-
* @type {
|
|
913
|
+
* 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>
|
|
914
|
+
* @type {string}
|
|
947
915
|
* @memberof TranslationApiListTranslations
|
|
948
916
|
*/
|
|
949
|
-
readonly filter?:
|
|
917
|
+
readonly filter?: string
|
|
950
918
|
|
|
951
919
|
/**
|
|
952
|
-
* Search the
|
|
953
|
-
* @type {
|
|
920
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
921
|
+
* @type {string}
|
|
922
|
+
* @memberof TranslationApiListTranslations
|
|
923
|
+
*/
|
|
924
|
+
readonly search?: string
|
|
925
|
+
|
|
926
|
+
/**
|
|
927
|
+
* 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>
|
|
928
|
+
* @type {string}
|
|
954
929
|
* @memberof TranslationApiListTranslations
|
|
955
930
|
*/
|
|
956
|
-
readonly
|
|
931
|
+
readonly order?: string
|
|
957
932
|
|
|
958
933
|
/**
|
|
959
|
-
*
|
|
960
|
-
* @type {
|
|
934
|
+
* 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/>
|
|
935
|
+
* @type {string}
|
|
961
936
|
* @memberof TranslationApiListTranslations
|
|
962
937
|
*/
|
|
963
|
-
readonly
|
|
938
|
+
readonly expand?: string
|
|
964
939
|
|
|
965
940
|
/**
|
|
966
|
-
*
|
|
967
|
-
* @type {
|
|
941
|
+
* 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>
|
|
942
|
+
* @type {string}
|
|
968
943
|
* @memberof TranslationApiListTranslations
|
|
969
944
|
*/
|
|
970
|
-
readonly
|
|
945
|
+
readonly filters?: string
|
|
971
946
|
}
|
|
972
947
|
|
|
973
948
|
/**
|
|
@@ -976,20 +951,6 @@ export interface TranslationApiListTranslationsRequest {
|
|
|
976
951
|
* @interface TranslationApiUpdateProductLanguageRequest
|
|
977
952
|
*/
|
|
978
953
|
export interface TranslationApiUpdateProductLanguageRequest {
|
|
979
|
-
/**
|
|
980
|
-
* Id of the product language.
|
|
981
|
-
* @type {number}
|
|
982
|
-
* @memberof TranslationApiUpdateProductLanguage
|
|
983
|
-
*/
|
|
984
|
-
readonly id: number
|
|
985
|
-
|
|
986
|
-
/**
|
|
987
|
-
* Product slug of the product.
|
|
988
|
-
* @type {string}
|
|
989
|
-
* @memberof TranslationApiUpdateProductLanguage
|
|
990
|
-
*/
|
|
991
|
-
readonly productSlug: string
|
|
992
|
-
|
|
993
954
|
/**
|
|
994
955
|
*
|
|
995
956
|
* @type {UpdateProductLanguageRequestDto}
|
|
@@ -1048,7 +1009,7 @@ export interface TranslationApiUploadProductTranslationsRequest {
|
|
|
1048
1009
|
*/
|
|
1049
1010
|
export class TranslationApi extends BaseAPI {
|
|
1050
1011
|
/**
|
|
1051
|
-
* This creates a product language.
|
|
1012
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
1052
1013
|
* @summary Create the product language
|
|
1053
1014
|
* @param {TranslationApiCreateProductLanguageRequest} requestParameters Request parameters.
|
|
1054
1015
|
* @param {*} [options] Override http request option.
|
|
@@ -1056,11 +1017,11 @@ export class TranslationApi extends BaseAPI {
|
|
|
1056
1017
|
* @memberof TranslationApi
|
|
1057
1018
|
*/
|
|
1058
1019
|
public createProductLanguage(requestParameters: TranslationApiCreateProductLanguageRequest, options?: AxiosRequestConfig) {
|
|
1059
|
-
return TranslationApiFp(this.configuration).createProductLanguage(requestParameters.
|
|
1020
|
+
return TranslationApiFp(this.configuration).createProductLanguage(requestParameters.createProductLanguageRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1060
1021
|
}
|
|
1061
1022
|
|
|
1062
1023
|
/**
|
|
1063
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
1024
|
+
* 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\"
|
|
1064
1025
|
* @summary Delete the product language
|
|
1065
1026
|
* @param {TranslationApiDeleteProductLanguageRequest} requestParameters Request parameters.
|
|
1066
1027
|
* @param {*} [options] Override http request option.
|
|
@@ -1072,7 +1033,7 @@ export class TranslationApi extends BaseAPI {
|
|
|
1072
1033
|
}
|
|
1073
1034
|
|
|
1074
1035
|
/**
|
|
1075
|
-
* This downloads the list of translatable fields for a given product.
|
|
1036
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
1076
1037
|
* @summary Retrieve the product translations
|
|
1077
1038
|
* @param {TranslationApiDownloadProductTranslationsRequest} requestParameters Request parameters.
|
|
1078
1039
|
* @param {*} [options] Override http request option.
|
|
@@ -1084,7 +1045,7 @@ export class TranslationApi extends BaseAPI {
|
|
|
1084
1045
|
}
|
|
1085
1046
|
|
|
1086
1047
|
/**
|
|
1087
|
-
* This gets a product language.
|
|
1048
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
1088
1049
|
* @summary Retrieve the product language
|
|
1089
1050
|
* @param {TranslationApiGetProductLanguageRequest} requestParameters Request parameters.
|
|
1090
1051
|
* @param {*} [options] Override http request option.
|
|
@@ -1092,23 +1053,23 @@ export class TranslationApi extends BaseAPI {
|
|
|
1092
1053
|
* @memberof TranslationApi
|
|
1093
1054
|
*/
|
|
1094
1055
|
public getProductLanguage(requestParameters: TranslationApiGetProductLanguageRequest, options?: AxiosRequestConfig) {
|
|
1095
|
-
return TranslationApiFp(this.configuration).getProductLanguage(requestParameters.id, requestParameters.
|
|
1056
|
+
return TranslationApiFp(this.configuration).getProductLanguage(requestParameters.id, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1096
1057
|
}
|
|
1097
1058
|
|
|
1098
1059
|
/**
|
|
1099
|
-
*
|
|
1060
|
+
* 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\"
|
|
1100
1061
|
* @summary List product languages
|
|
1101
1062
|
* @param {TranslationApiListProductLanguagesRequest} requestParameters Request parameters.
|
|
1102
1063
|
* @param {*} [options] Override http request option.
|
|
1103
1064
|
* @throws {RequiredError}
|
|
1104
1065
|
* @memberof TranslationApi
|
|
1105
1066
|
*/
|
|
1106
|
-
public listProductLanguages(requestParameters: TranslationApiListProductLanguagesRequest, options?: AxiosRequestConfig) {
|
|
1107
|
-
return TranslationApiFp(this.configuration).listProductLanguages(requestParameters.
|
|
1067
|
+
public listProductLanguages(requestParameters: TranslationApiListProductLanguagesRequest = {}, options?: AxiosRequestConfig) {
|
|
1068
|
+
return TranslationApiFp(this.configuration).listProductLanguages(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1108
1069
|
}
|
|
1109
1070
|
|
|
1110
1071
|
/**
|
|
1111
|
-
* Returns a list of translations you have previously created.
|
|
1072
|
+
* 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\"
|
|
1112
1073
|
* @summary List translations
|
|
1113
1074
|
* @param {TranslationApiListTranslationsRequest} requestParameters Request parameters.
|
|
1114
1075
|
* @param {*} [options] Override http request option.
|
|
@@ -1116,11 +1077,11 @@ export class TranslationApi extends BaseAPI {
|
|
|
1116
1077
|
* @memberof TranslationApi
|
|
1117
1078
|
*/
|
|
1118
1079
|
public listTranslations(requestParameters: TranslationApiListTranslationsRequest = {}, options?: AxiosRequestConfig) {
|
|
1119
|
-
return TranslationApiFp(this.configuration).listTranslations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
1080
|
+
return TranslationApiFp(this.configuration).listTranslations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
1120
1081
|
}
|
|
1121
1082
|
|
|
1122
1083
|
/**
|
|
1123
|
-
* This updates the product language with the specified id.
|
|
1084
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
1124
1085
|
* @summary Update the product language
|
|
1125
1086
|
* @param {TranslationApiUpdateProductLanguageRequest} requestParameters Request parameters.
|
|
1126
1087
|
* @param {*} [options] Override http request option.
|
|
@@ -1128,11 +1089,11 @@ export class TranslationApi extends BaseAPI {
|
|
|
1128
1089
|
* @memberof TranslationApi
|
|
1129
1090
|
*/
|
|
1130
1091
|
public updateProductLanguage(requestParameters: TranslationApiUpdateProductLanguageRequest, options?: AxiosRequestConfig) {
|
|
1131
|
-
return TranslationApiFp(this.configuration).updateProductLanguage(requestParameters.
|
|
1092
|
+
return TranslationApiFp(this.configuration).updateProductLanguage(requestParameters.updateProductLanguageRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
1132
1093
|
}
|
|
1133
1094
|
|
|
1134
1095
|
/**
|
|
1135
|
-
* This uploads the translations for a given product.
|
|
1096
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
1136
1097
|
* @summary Create the product translations
|
|
1137
1098
|
* @param {TranslationApiUploadProductTranslationsRequest} requestParameters Request parameters.
|
|
1138
1099
|
* @param {*} [options] Override http request option.
|