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