@emilgroup/translation-sdk 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. package/.openapi-generator/FILES +23 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +68 -0
  5. package/api/translation-api.ts +1145 -0
  6. package/api.ts +31 -0
  7. package/base.ts +284 -0
  8. package/common.ts +199 -0
  9. package/configuration.ts +109 -0
  10. package/dist/api/translation-api.d.ts +649 -0
  11. package/dist/api/translation-api.js +989 -0
  12. package/dist/api.d.ts +12 -0
  13. package/dist/api.js +30 -0
  14. package/dist/base.d.ts +77 -0
  15. package/dist/base.js +393 -0
  16. package/dist/common.d.ts +92 -0
  17. package/dist/common.js +277 -0
  18. package/dist/configuration.d.ts +90 -0
  19. package/dist/configuration.js +44 -0
  20. package/dist/index.d.ts +15 -0
  21. package/dist/index.js +36 -0
  22. package/dist/models/create-product-language-request-dto.d.ts +58 -0
  23. package/dist/models/create-product-language-request-dto.js +37 -0
  24. package/dist/models/create-product-language-response-class.d.ts +25 -0
  25. package/dist/models/create-product-language-response-class.js +15 -0
  26. package/dist/models/index.d.ts +9 -0
  27. package/dist/models/index.js +25 -0
  28. package/dist/models/list-product-languages-response-class.d.ts +31 -0
  29. package/dist/models/list-product-languages-response-class.js +15 -0
  30. package/dist/models/list-translations-response-class.d.ts +31 -0
  31. package/dist/models/list-translations-response-class.js +15 -0
  32. package/dist/models/product-language-class.d.ts +82 -0
  33. package/dist/models/product-language-class.js +37 -0
  34. package/dist/models/translation-class.d.ts +54 -0
  35. package/dist/models/translation-class.js +15 -0
  36. package/dist/models/update-product-language-request-dto.d.ts +58 -0
  37. package/dist/models/update-product-language-request-dto.js +37 -0
  38. package/dist/models/update-product-language-response-class.d.ts +25 -0
  39. package/dist/models/update-product-language-response-class.js +15 -0
  40. package/dist/models/upload-product-translations-response-class.d.ts +25 -0
  41. package/dist/models/upload-product-translations-response-class.js +15 -0
  42. package/git_push.sh +57 -0
  43. package/index.ts +19 -0
  44. package/models/create-product-language-request-dto.ts +67 -0
  45. package/models/create-product-language-response-class.ts +31 -0
  46. package/models/index.ts +9 -0
  47. package/models/list-product-languages-response-class.ts +37 -0
  48. package/models/list-translations-response-class.ts +37 -0
  49. package/models/product-language-class.ts +91 -0
  50. package/models/translation-class.ts +60 -0
  51. package/models/update-product-language-request-dto.ts +67 -0
  52. package/models/update-product-language-response-class.ts +31 -0
  53. package/models/upload-product-translations-response-class.ts +31 -0
  54. package/package.json +29 -0
  55. package/tsconfig.json +22 -0
@@ -0,0 +1,649 @@
1
+ /**
2
+ * EMIL TranslationService
3
+ * The EMIL TranslationService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateProductLanguageRequestDto } from '../models';
16
+ import { CreateProductLanguageResponseClass } from '../models';
17
+ import { ListProductLanguagesResponseClass } from '../models';
18
+ import { ListTranslationsResponseClass } from '../models';
19
+ import { UpdateProductLanguageRequestDto } from '../models';
20
+ import { UpdateProductLanguageResponseClass } from '../models';
21
+ import { UploadProductTranslationsResponseClass } from '../models';
22
+ /**
23
+ * TranslationApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const TranslationApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * This creates a product language.
29
+ * @summary Create the product language
30
+ * @param {string} productSlug
31
+ * @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ createProductLanguage: (productSlug: string, createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
39
+ * @summary Delete the product language
40
+ * @param {number} id Id of the product language.
41
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ deleteProductLanguage: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * This downloads the list of translatable fields for a given product.
48
+ * @summary Retrieve the product translations
49
+ * @param {string} productSlug
50
+ * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
51
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ downloadProductTranslations: (productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
+ /**
57
+ * This gets a product language.
58
+ * @summary Retrieve the product language
59
+ * @param {number} id Id of the product language.
60
+ * @param {string} productSlug Product slug of the product.
61
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ getProductLanguage: (id: number, productSlug: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
+ /**
67
+ * This lists the product languages.
68
+ * @summary List product languages
69
+ * @param {string} productSlug Product slug of the product.
70
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
71
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
72
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
73
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
74
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
75
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
76
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ listProductLanguages: (productSlug: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
81
+ /**
82
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
83
+ * @summary List translations
84
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
86
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
87
+ * @param {'key'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
88
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
89
+ * @param {'0' | '1' | '2'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
90
+ * @param {number} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ listTranslations: (authorization?: string, pageSize?: any, pageToken?: any, filter?: 'key', search?: any, order?: '0' | '1' | '2', expand?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
95
+ /**
96
+ * This updates the product language with the specified id.
97
+ * @summary Update the product language
98
+ * @param {number} id Id of the product language.
99
+ * @param {string} productSlug Product slug of the product.
100
+ * @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
101
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ updateProductLanguage: (id: number, productSlug: string, updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
106
+ /**
107
+ * This uploads the translations for a given product.
108
+ * @summary Create the product translations
109
+ * @param {string} productSlug
110
+ * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
111
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
112
+ * @param {any} [file]
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ uploadProductTranslations: (productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, file?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
117
+ };
118
+ /**
119
+ * TranslationApi - functional programming interface
120
+ * @export
121
+ */
122
+ export declare const TranslationApiFp: (configuration?: Configuration) => {
123
+ /**
124
+ * This creates a product language.
125
+ * @summary Create the product language
126
+ * @param {string} productSlug
127
+ * @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
128
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
129
+ * @param {*} [options] Override http request option.
130
+ * @throws {RequiredError}
131
+ */
132
+ createProductLanguage(productSlug: string, createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>>;
133
+ /**
134
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
135
+ * @summary Delete the product language
136
+ * @param {number} id Id of the product language.
137
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ deleteProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
142
+ /**
143
+ * This downloads the list of translatable fields for a given product.
144
+ * @summary Retrieve the product translations
145
+ * @param {string} productSlug
146
+ * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
147
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
148
+ * @param {*} [options] Override http request option.
149
+ * @throws {RequiredError}
150
+ */
151
+ downloadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
152
+ /**
153
+ * This gets a product language.
154
+ * @summary Retrieve the product language
155
+ * @param {number} id Id of the product language.
156
+ * @param {string} productSlug Product slug of the product.
157
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
158
+ * @param {*} [options] Override http request option.
159
+ * @throws {RequiredError}
160
+ */
161
+ getProductLanguage(id: number, productSlug: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>>;
162
+ /**
163
+ * This lists the product languages.
164
+ * @summary List product languages
165
+ * @param {string} productSlug Product slug of the product.
166
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
167
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
168
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
169
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
170
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
171
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
172
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
173
+ * @param {*} [options] Override http request option.
174
+ * @throws {RequiredError}
175
+ */
176
+ listProductLanguages(productSlug: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductLanguagesResponseClass>>;
177
+ /**
178
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
179
+ * @summary List translations
180
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
181
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
182
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
183
+ * @param {'key'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
184
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
185
+ * @param {'0' | '1' | '2'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
186
+ * @param {number} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
187
+ * @param {*} [options] Override http request option.
188
+ * @throws {RequiredError}
189
+ */
190
+ listTranslations(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'key', search?: any, order?: '0' | '1' | '2', expand?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTranslationsResponseClass>>;
191
+ /**
192
+ * This updates the product language with the specified id.
193
+ * @summary Update the product language
194
+ * @param {number} id Id of the product language.
195
+ * @param {string} productSlug Product slug of the product.
196
+ * @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
197
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
198
+ * @param {*} [options] Override http request option.
199
+ * @throws {RequiredError}
200
+ */
201
+ updateProductLanguage(id: number, productSlug: string, updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductLanguageResponseClass>>;
202
+ /**
203
+ * This uploads the translations for a given product.
204
+ * @summary Create the product translations
205
+ * @param {string} productSlug
206
+ * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
207
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
208
+ * @param {any} [file]
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ uploadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, file?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadProductTranslationsResponseClass>>;
213
+ };
214
+ /**
215
+ * TranslationApi - factory interface
216
+ * @export
217
+ */
218
+ export declare const TranslationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
219
+ /**
220
+ * This creates a product language.
221
+ * @summary Create the product language
222
+ * @param {string} productSlug
223
+ * @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
224
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ */
228
+ createProductLanguage(productSlug: string, createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass>;
229
+ /**
230
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
231
+ * @summary Delete the product language
232
+ * @param {number} id Id of the product language.
233
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
234
+ * @param {*} [options] Override http request option.
235
+ * @throws {RequiredError}
236
+ */
237
+ deleteProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<void>;
238
+ /**
239
+ * This downloads the list of translatable fields for a given product.
240
+ * @summary Retrieve the product translations
241
+ * @param {string} productSlug
242
+ * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
243
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
+ * @param {*} [options] Override http request option.
245
+ * @throws {RequiredError}
246
+ */
247
+ downloadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: any): AxiosPromise<any>;
248
+ /**
249
+ * This gets a product language.
250
+ * @summary Retrieve the product language
251
+ * @param {number} id Id of the product language.
252
+ * @param {string} productSlug Product slug of the product.
253
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ getProductLanguage(id: number, productSlug: string, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass>;
258
+ /**
259
+ * This lists the product languages.
260
+ * @summary List product languages
261
+ * @param {string} productSlug Product slug of the product.
262
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
263
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
264
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
265
+ * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
266
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
267
+ * @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
268
+ * @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
269
+ * @param {*} [options] Override http request option.
270
+ * @throws {RequiredError}
271
+ */
272
+ listProductLanguages(productSlug: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductLanguagesResponseClass>;
273
+ /**
274
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
275
+ * @summary List translations
276
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
277
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
278
+ * @param {any} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
279
+ * @param {'key'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
280
+ * @param {any} [search] Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
281
+ * @param {'0' | '1' | '2'} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
282
+ * @param {number} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ */
286
+ listTranslations(authorization?: string, pageSize?: any, pageToken?: any, filter?: 'key', search?: any, order?: '0' | '1' | '2', expand?: number, options?: any): AxiosPromise<ListTranslationsResponseClass>;
287
+ /**
288
+ * This updates the product language with the specified id.
289
+ * @summary Update the product language
290
+ * @param {number} id Id of the product language.
291
+ * @param {string} productSlug Product slug of the product.
292
+ * @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
293
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
294
+ * @param {*} [options] Override http request option.
295
+ * @throws {RequiredError}
296
+ */
297
+ updateProductLanguage(id: number, productSlug: string, updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductLanguageResponseClass>;
298
+ /**
299
+ * This uploads the translations for a given product.
300
+ * @summary Create the product translations
301
+ * @param {string} productSlug
302
+ * @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
303
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
304
+ * @param {any} [file]
305
+ * @param {*} [options] Override http request option.
306
+ * @throws {RequiredError}
307
+ */
308
+ uploadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, file?: any, options?: any): AxiosPromise<UploadProductTranslationsResponseClass>;
309
+ };
310
+ /**
311
+ * Request parameters for createProductLanguage operation in TranslationApi.
312
+ * @export
313
+ * @interface TranslationApiCreateProductLanguageRequest
314
+ */
315
+ export interface TranslationApiCreateProductLanguageRequest {
316
+ /**
317
+ *
318
+ * @type {string}
319
+ * @memberof TranslationApiCreateProductLanguage
320
+ */
321
+ readonly productSlug: string;
322
+ /**
323
+ *
324
+ * @type {CreateProductLanguageRequestDto}
325
+ * @memberof TranslationApiCreateProductLanguage
326
+ */
327
+ readonly createProductLanguageRequestDto: CreateProductLanguageRequestDto;
328
+ /**
329
+ * Bearer Token: provided by the login endpoint under the name accessToken.
330
+ * @type {string}
331
+ * @memberof TranslationApiCreateProductLanguage
332
+ */
333
+ readonly authorization?: string;
334
+ }
335
+ /**
336
+ * Request parameters for deleteProductLanguage operation in TranslationApi.
337
+ * @export
338
+ * @interface TranslationApiDeleteProductLanguageRequest
339
+ */
340
+ export interface TranslationApiDeleteProductLanguageRequest {
341
+ /**
342
+ * Id of the product language.
343
+ * @type {number}
344
+ * @memberof TranslationApiDeleteProductLanguage
345
+ */
346
+ readonly id: number;
347
+ /**
348
+ * Bearer Token: provided by the login endpoint under the name accessToken.
349
+ * @type {string}
350
+ * @memberof TranslationApiDeleteProductLanguage
351
+ */
352
+ readonly authorization?: string;
353
+ }
354
+ /**
355
+ * Request parameters for downloadProductTranslations operation in TranslationApi.
356
+ * @export
357
+ * @interface TranslationApiDownloadProductTranslationsRequest
358
+ */
359
+ export interface TranslationApiDownloadProductTranslationsRequest {
360
+ /**
361
+ *
362
+ * @type {string}
363
+ * @memberof TranslationApiDownloadProductTranslations
364
+ */
365
+ readonly productSlug: string;
366
+ /**
367
+ *
368
+ * @type {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'}
369
+ * @memberof TranslationApiDownloadProductTranslations
370
+ */
371
+ readonly language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian';
372
+ /**
373
+ * Bearer Token: provided by the login endpoint under the name accessToken.
374
+ * @type {string}
375
+ * @memberof TranslationApiDownloadProductTranslations
376
+ */
377
+ readonly authorization?: string;
378
+ }
379
+ /**
380
+ * Request parameters for getProductLanguage operation in TranslationApi.
381
+ * @export
382
+ * @interface TranslationApiGetProductLanguageRequest
383
+ */
384
+ export interface TranslationApiGetProductLanguageRequest {
385
+ /**
386
+ * Id of the product language.
387
+ * @type {number}
388
+ * @memberof TranslationApiGetProductLanguage
389
+ */
390
+ readonly id: number;
391
+ /**
392
+ * Product slug of the product.
393
+ * @type {string}
394
+ * @memberof TranslationApiGetProductLanguage
395
+ */
396
+ readonly productSlug: string;
397
+ /**
398
+ * Bearer Token: provided by the login endpoint under the name accessToken.
399
+ * @type {string}
400
+ * @memberof TranslationApiGetProductLanguage
401
+ */
402
+ readonly authorization?: string;
403
+ }
404
+ /**
405
+ * Request parameters for listProductLanguages operation in TranslationApi.
406
+ * @export
407
+ * @interface TranslationApiListProductLanguagesRequest
408
+ */
409
+ export interface TranslationApiListProductLanguagesRequest {
410
+ /**
411
+ * Product slug of the product.
412
+ * @type {string}
413
+ * @memberof TranslationApiListProductLanguages
414
+ */
415
+ readonly productSlug: string;
416
+ /**
417
+ * Bearer Token: provided by the login endpoint under the name accessToken.
418
+ * @type {string}
419
+ * @memberof TranslationApiListProductLanguages
420
+ */
421
+ readonly authorization?: string;
422
+ /**
423
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
424
+ * @type {any}
425
+ * @memberof TranslationApiListProductLanguages
426
+ */
427
+ readonly pageSize?: any;
428
+ /**
429
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
430
+ * @type {any}
431
+ * @memberof TranslationApiListProductLanguages
432
+ */
433
+ readonly pageToken?: any;
434
+ /**
435
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
436
+ * @type {any}
437
+ * @memberof TranslationApiListProductLanguages
438
+ */
439
+ readonly filter?: any;
440
+ /**
441
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
442
+ * @type {any}
443
+ * @memberof TranslationApiListProductLanguages
444
+ */
445
+ readonly search?: any;
446
+ /**
447
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
448
+ * @type {any}
449
+ * @memberof TranslationApiListProductLanguages
450
+ */
451
+ readonly order?: any;
452
+ /**
453
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
454
+ * @type {any}
455
+ * @memberof TranslationApiListProductLanguages
456
+ */
457
+ readonly expand?: any;
458
+ }
459
+ /**
460
+ * Request parameters for listTranslations operation in TranslationApi.
461
+ * @export
462
+ * @interface TranslationApiListTranslationsRequest
463
+ */
464
+ export interface TranslationApiListTranslationsRequest {
465
+ /**
466
+ * Bearer Token: provided by the login endpoint under the name accessToken.
467
+ * @type {string}
468
+ * @memberof TranslationApiListTranslations
469
+ */
470
+ readonly authorization?: string;
471
+ /**
472
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
473
+ * @type {any}
474
+ * @memberof TranslationApiListTranslations
475
+ */
476
+ readonly pageSize?: any;
477
+ /**
478
+ * A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
479
+ * @type {any}
480
+ * @memberof TranslationApiListTranslations
481
+ */
482
+ readonly pageToken?: any;
483
+ /**
484
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
485
+ * @type {'key'}
486
+ * @memberof TranslationApiListTranslations
487
+ */
488
+ readonly filter?: 'key';
489
+ /**
490
+ * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
491
+ * @type {any}
492
+ * @memberof TranslationApiListTranslations
493
+ */
494
+ readonly search?: any;
495
+ /**
496
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
497
+ * @type {'0' | '1' | '2'}
498
+ * @memberof TranslationApiListTranslations
499
+ */
500
+ readonly order?: '0' | '1' | '2';
501
+ /**
502
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
503
+ * @type {number}
504
+ * @memberof TranslationApiListTranslations
505
+ */
506
+ readonly expand?: number;
507
+ }
508
+ /**
509
+ * Request parameters for updateProductLanguage operation in TranslationApi.
510
+ * @export
511
+ * @interface TranslationApiUpdateProductLanguageRequest
512
+ */
513
+ export interface TranslationApiUpdateProductLanguageRequest {
514
+ /**
515
+ * Id of the product language.
516
+ * @type {number}
517
+ * @memberof TranslationApiUpdateProductLanguage
518
+ */
519
+ readonly id: number;
520
+ /**
521
+ * Product slug of the product.
522
+ * @type {string}
523
+ * @memberof TranslationApiUpdateProductLanguage
524
+ */
525
+ readonly productSlug: string;
526
+ /**
527
+ *
528
+ * @type {UpdateProductLanguageRequestDto}
529
+ * @memberof TranslationApiUpdateProductLanguage
530
+ */
531
+ readonly updateProductLanguageRequestDto: UpdateProductLanguageRequestDto;
532
+ /**
533
+ * Bearer Token: provided by the login endpoint under the name accessToken.
534
+ * @type {string}
535
+ * @memberof TranslationApiUpdateProductLanguage
536
+ */
537
+ readonly authorization?: string;
538
+ }
539
+ /**
540
+ * Request parameters for uploadProductTranslations operation in TranslationApi.
541
+ * @export
542
+ * @interface TranslationApiUploadProductTranslationsRequest
543
+ */
544
+ export interface TranslationApiUploadProductTranslationsRequest {
545
+ /**
546
+ *
547
+ * @type {string}
548
+ * @memberof TranslationApiUploadProductTranslations
549
+ */
550
+ readonly productSlug: string;
551
+ /**
552
+ *
553
+ * @type {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'}
554
+ * @memberof TranslationApiUploadProductTranslations
555
+ */
556
+ readonly language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian';
557
+ /**
558
+ * Bearer Token: provided by the login endpoint under the name accessToken.
559
+ * @type {string}
560
+ * @memberof TranslationApiUploadProductTranslations
561
+ */
562
+ readonly authorization?: string;
563
+ /**
564
+ *
565
+ * @type {any}
566
+ * @memberof TranslationApiUploadProductTranslations
567
+ */
568
+ readonly file?: any;
569
+ }
570
+ /**
571
+ * TranslationApi - object-oriented interface
572
+ * @export
573
+ * @class TranslationApi
574
+ * @extends {BaseAPI}
575
+ */
576
+ export declare class TranslationApi extends BaseAPI {
577
+ /**
578
+ * This creates a product language.
579
+ * @summary Create the product language
580
+ * @param {TranslationApiCreateProductLanguageRequest} requestParameters Request parameters.
581
+ * @param {*} [options] Override http request option.
582
+ * @throws {RequiredError}
583
+ * @memberof TranslationApi
584
+ */
585
+ createProductLanguage(requestParameters: TranslationApiCreateProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductLanguageResponseClass, any>>;
586
+ /**
587
+ * Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
588
+ * @summary Delete the product language
589
+ * @param {TranslationApiDeleteProductLanguageRequest} requestParameters Request parameters.
590
+ * @param {*} [options] Override http request option.
591
+ * @throws {RequiredError}
592
+ * @memberof TranslationApi
593
+ */
594
+ deleteProductLanguage(requestParameters: TranslationApiDeleteProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
595
+ /**
596
+ * This downloads the list of translatable fields for a given product.
597
+ * @summary Retrieve the product translations
598
+ * @param {TranslationApiDownloadProductTranslationsRequest} requestParameters Request parameters.
599
+ * @param {*} [options] Override http request option.
600
+ * @throws {RequiredError}
601
+ * @memberof TranslationApi
602
+ */
603
+ downloadProductTranslations(requestParameters: TranslationApiDownloadProductTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
604
+ /**
605
+ * This gets a product language.
606
+ * @summary Retrieve the product language
607
+ * @param {TranslationApiGetProductLanguageRequest} requestParameters Request parameters.
608
+ * @param {*} [options] Override http request option.
609
+ * @throws {RequiredError}
610
+ * @memberof TranslationApi
611
+ */
612
+ getProductLanguage(requestParameters: TranslationApiGetProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductLanguageResponseClass, any>>;
613
+ /**
614
+ * This lists the product languages.
615
+ * @summary List product languages
616
+ * @param {TranslationApiListProductLanguagesRequest} requestParameters Request parameters.
617
+ * @param {*} [options] Override http request option.
618
+ * @throws {RequiredError}
619
+ * @memberof TranslationApi
620
+ */
621
+ listProductLanguages(requestParameters: TranslationApiListProductLanguagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductLanguagesResponseClass, any>>;
622
+ /**
623
+ * Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
624
+ * @summary List translations
625
+ * @param {TranslationApiListTranslationsRequest} requestParameters Request parameters.
626
+ * @param {*} [options] Override http request option.
627
+ * @throws {RequiredError}
628
+ * @memberof TranslationApi
629
+ */
630
+ listTranslations(requestParameters?: TranslationApiListTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTranslationsResponseClass, any>>;
631
+ /**
632
+ * This updates the product language with the specified id.
633
+ * @summary Update the product language
634
+ * @param {TranslationApiUpdateProductLanguageRequest} requestParameters Request parameters.
635
+ * @param {*} [options] Override http request option.
636
+ * @throws {RequiredError}
637
+ * @memberof TranslationApi
638
+ */
639
+ updateProductLanguage(requestParameters: TranslationApiUpdateProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateProductLanguageResponseClass, any>>;
640
+ /**
641
+ * This uploads the translations for a given product.
642
+ * @summary Create the product translations
643
+ * @param {TranslationApiUploadProductTranslationsRequest} requestParameters Request parameters.
644
+ * @param {*} [options] Override http request option.
645
+ * @throws {RequiredError}
646
+ * @memberof TranslationApi
647
+ */
648
+ uploadProductTranslations(requestParameters: TranslationApiUploadProductTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadProductTranslationsResponseClass, any>>;
649
+ }