@emilgroup/translation-sdk-node 1.1.0 → 1.1.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 +3 -0
- package/README.md +20 -4
- package/api/default-api.ts +128 -0
- package/api/translation-api.ts +141 -112
- 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 +124 -106
- package/dist/api/translation-api.js +92 -80
- 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/index.d.ts +2 -0
- package/dist/models/index.js +2 -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/index.ts +2 -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
|
@@ -26,7 +26,7 @@ import { UploadProductTranslationsResponseClass } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const TranslationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
* This creates a product language.
|
|
29
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
30
30
|
* @summary Create the product language
|
|
31
31
|
* @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
|
|
32
32
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -35,7 +35,7 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
35
35
|
*/
|
|
36
36
|
createProductLanguage: (createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
38
|
+
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
|
|
39
39
|
* @summary Delete the product language
|
|
40
40
|
* @param {number} id Id of the product language.
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -44,7 +44,7 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
44
44
|
*/
|
|
45
45
|
deleteProductLanguage: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
46
|
/**
|
|
47
|
-
* This downloads the list of translatable fields for a given product.
|
|
47
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
48
48
|
* @summary Retrieve the product translations
|
|
49
49
|
* @param {string} productSlug
|
|
50
50
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -54,7 +54,7 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
54
54
|
*/
|
|
55
55
|
downloadProductTranslations: (productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
56
|
/**
|
|
57
|
-
* This gets a product language.
|
|
57
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
58
58
|
* @summary Retrieve the product language
|
|
59
59
|
* @param {number} id Id of the product language.
|
|
60
60
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -63,35 +63,37 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
63
63
|
*/
|
|
64
64
|
getProductLanguage: (id: number, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
67
67
|
* @summary List product languages
|
|
68
68
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
69
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
70
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1,
|
|
71
|
-
* @param {
|
|
72
|
-
* @param {
|
|
73
|
-
* @param {
|
|
74
|
-
* @param {
|
|
69
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
70
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
71
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
72
|
+
* @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>
|
|
73
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
74
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
75
|
+
* @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>
|
|
75
76
|
* @param {*} [options] Override http request option.
|
|
76
77
|
* @throws {RequiredError}
|
|
77
78
|
*/
|
|
78
|
-
listProductLanguages: (authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
79
|
+
listProductLanguages: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
80
|
/**
|
|
80
|
-
* Returns a list of translations you have previously created.
|
|
81
|
+
* Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
81
82
|
* @summary List translations
|
|
82
83
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
83
|
-
* @param {
|
|
84
|
-
* @param {
|
|
85
|
-
* @param {
|
|
86
|
-
* @param {
|
|
87
|
-
* @param {
|
|
88
|
-
* @param {
|
|
84
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
85
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
86
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key</i>
|
|
87
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
88
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, key</i>
|
|
89
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
90
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
89
91
|
* @param {*} [options] Override http request option.
|
|
90
92
|
* @throws {RequiredError}
|
|
91
93
|
*/
|
|
92
|
-
listTranslations: (authorization?: string, pageSize?:
|
|
94
|
+
listTranslations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
95
|
/**
|
|
94
|
-
* This updates the product language with the specified id.
|
|
96
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
95
97
|
* @summary Update the product language
|
|
96
98
|
* @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
|
|
97
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -100,7 +102,7 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
100
102
|
*/
|
|
101
103
|
updateProductLanguage: (updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
104
|
/**
|
|
103
|
-
* This uploads the translations for a given product.
|
|
105
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
104
106
|
* @summary Create the product translations
|
|
105
107
|
* @param {string} productSlug
|
|
106
108
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -117,7 +119,7 @@ export declare const TranslationApiAxiosParamCreator: (configuration?: Configura
|
|
|
117
119
|
*/
|
|
118
120
|
export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
119
121
|
/**
|
|
120
|
-
* This creates a product language.
|
|
122
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
121
123
|
* @summary Create the product language
|
|
122
124
|
* @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
|
|
123
125
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -126,7 +128,7 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
126
128
|
*/
|
|
127
129
|
createProductLanguage(createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateProductLanguageResponseClass>>;
|
|
128
130
|
/**
|
|
129
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
131
|
+
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
|
|
130
132
|
* @summary Delete the product language
|
|
131
133
|
* @param {number} id Id of the product language.
|
|
132
134
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -135,7 +137,7 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
135
137
|
*/
|
|
136
138
|
deleteProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
137
139
|
/**
|
|
138
|
-
* This downloads the list of translatable fields for a given product.
|
|
140
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
139
141
|
* @summary Retrieve the product translations
|
|
140
142
|
* @param {string} productSlug
|
|
141
143
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -145,7 +147,7 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
145
147
|
*/
|
|
146
148
|
downloadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
|
|
147
149
|
/**
|
|
148
|
-
* This gets a product language.
|
|
150
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
149
151
|
* @summary Retrieve the product language
|
|
150
152
|
* @param {number} id Id of the product language.
|
|
151
153
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -154,35 +156,37 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
154
156
|
*/
|
|
155
157
|
getProductLanguage(id: number, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetProductLanguageResponseClass>>;
|
|
156
158
|
/**
|
|
157
|
-
*
|
|
159
|
+
* Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
158
160
|
* @summary List product languages
|
|
159
161
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
160
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
161
|
-
* @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,
|
|
162
|
-
* @param {
|
|
163
|
-
* @param {
|
|
164
|
-
* @param {
|
|
165
|
-
* @param {
|
|
162
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
163
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
164
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
165
|
+
* @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>
|
|
166
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
167
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
168
|
+
* @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>
|
|
166
169
|
* @param {*} [options] Override http request option.
|
|
167
170
|
* @throws {RequiredError}
|
|
168
171
|
*/
|
|
169
|
-
listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
172
|
+
listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductLanguagesResponseClass>>;
|
|
170
173
|
/**
|
|
171
|
-
* Returns a list of translations you have previously created.
|
|
174
|
+
* Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
172
175
|
* @summary List translations
|
|
173
176
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
174
|
-
* @param {
|
|
175
|
-
* @param {
|
|
176
|
-
* @param {
|
|
177
|
-
* @param {
|
|
178
|
-
* @param {
|
|
179
|
-
* @param {
|
|
177
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
178
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
179
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key</i>
|
|
180
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
181
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, key</i>
|
|
182
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
183
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
180
184
|
* @param {*} [options] Override http request option.
|
|
181
185
|
* @throws {RequiredError}
|
|
182
186
|
*/
|
|
183
|
-
listTranslations(authorization?: string, pageSize?:
|
|
187
|
+
listTranslations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTranslationsResponseClass>>;
|
|
184
188
|
/**
|
|
185
|
-
* This updates the product language with the specified id.
|
|
189
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
186
190
|
* @summary Update the product language
|
|
187
191
|
* @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
|
|
188
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -191,7 +195,7 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
191
195
|
*/
|
|
192
196
|
updateProductLanguage(updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateProductLanguageResponseClass>>;
|
|
193
197
|
/**
|
|
194
|
-
* This uploads the translations for a given product.
|
|
198
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
195
199
|
* @summary Create the product translations
|
|
196
200
|
* @param {string} productSlug
|
|
197
201
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -208,7 +212,7 @@ export declare const TranslationApiFp: (configuration?: Configuration) => {
|
|
|
208
212
|
*/
|
|
209
213
|
export declare const TranslationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
210
214
|
/**
|
|
211
|
-
* This creates a product language.
|
|
215
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
212
216
|
* @summary Create the product language
|
|
213
217
|
* @param {CreateProductLanguageRequestDto} createProductLanguageRequestDto
|
|
214
218
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -217,7 +221,7 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
217
221
|
*/
|
|
218
222
|
createProductLanguage(createProductLanguageRequestDto: CreateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<CreateProductLanguageResponseClass>;
|
|
219
223
|
/**
|
|
220
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
224
|
+
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
|
|
221
225
|
* @summary Delete the product language
|
|
222
226
|
* @param {number} id Id of the product language.
|
|
223
227
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -226,7 +230,7 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
226
230
|
*/
|
|
227
231
|
deleteProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<void>;
|
|
228
232
|
/**
|
|
229
|
-
* This downloads the list of translatable fields for a given product.
|
|
233
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
230
234
|
* @summary Retrieve the product translations
|
|
231
235
|
* @param {string} productSlug
|
|
232
236
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -236,7 +240,7 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
236
240
|
*/
|
|
237
241
|
downloadProductTranslations(productSlug: string, language: 'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian', authorization?: string, options?: any): AxiosPromise<any>;
|
|
238
242
|
/**
|
|
239
|
-
* This gets a product language.
|
|
243
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
240
244
|
* @summary Retrieve the product language
|
|
241
245
|
* @param {number} id Id of the product language.
|
|
242
246
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -245,35 +249,37 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
245
249
|
*/
|
|
246
250
|
getProductLanguage(id: number, authorization?: string, options?: any): AxiosPromise<GetProductLanguageResponseClass>;
|
|
247
251
|
/**
|
|
248
|
-
*
|
|
252
|
+
* Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
249
253
|
* @summary List product languages
|
|
250
254
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
251
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
252
|
-
* @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,
|
|
253
|
-
* @param {
|
|
254
|
-
* @param {
|
|
255
|
-
* @param {
|
|
256
|
-
* @param {
|
|
255
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
256
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
257
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, productSlug, language, isActive, translationStatus, createdAt, updateAt</i>
|
|
258
|
+
* @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>
|
|
259
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, language, isActive, translationStatus, createdAt, updatedAt</i>
|
|
260
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
261
|
+
* @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>
|
|
257
262
|
* @param {*} [options] Override http request option.
|
|
258
263
|
* @throws {RequiredError}
|
|
259
264
|
*/
|
|
260
|
-
listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?:
|
|
265
|
+
listProductLanguages(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListProductLanguagesResponseClass>;
|
|
261
266
|
/**
|
|
262
|
-
* Returns a list of translations you have previously created.
|
|
267
|
+
* Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
263
268
|
* @summary List translations
|
|
264
269
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
265
|
-
* @param {
|
|
266
|
-
* @param {
|
|
267
|
-
* @param {
|
|
268
|
-
* @param {
|
|
269
|
-
* @param {
|
|
270
|
-
* @param {
|
|
270
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
272
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key</i>
|
|
273
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
274
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, key</i>
|
|
275
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
276
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
271
277
|
* @param {*} [options] Override http request option.
|
|
272
278
|
* @throws {RequiredError}
|
|
273
279
|
*/
|
|
274
|
-
listTranslations(authorization?: string, pageSize?:
|
|
280
|
+
listTranslations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTranslationsResponseClass>;
|
|
275
281
|
/**
|
|
276
|
-
* This updates the product language with the specified id.
|
|
282
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
277
283
|
* @summary Update the product language
|
|
278
284
|
* @param {UpdateProductLanguageRequestDto} updateProductLanguageRequestDto
|
|
279
285
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -282,7 +288,7 @@ export declare const TranslationApiFactory: (configuration?: Configuration, base
|
|
|
282
288
|
*/
|
|
283
289
|
updateProductLanguage(updateProductLanguageRequestDto: UpdateProductLanguageRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateProductLanguageResponseClass>;
|
|
284
290
|
/**
|
|
285
|
-
* This uploads the translations for a given product.
|
|
291
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
286
292
|
* @summary Create the product translations
|
|
287
293
|
* @param {string} productSlug
|
|
288
294
|
* @param {'German' | 'English' | 'Polish' | 'French' | 'Italian' | 'Spanish' | 'Portuguese' | 'Russian' | 'Japanese' | 'Chinese' | 'Korean' | 'Turkish' | 'Arabic' | 'Hindi' | 'Indonesian' | 'Thai' | 'Vietnamese' | 'Persian' | 'Romanian'} language
|
|
@@ -388,41 +394,47 @@ export interface TranslationApiListProductLanguagesRequest {
|
|
|
388
394
|
*/
|
|
389
395
|
readonly authorization?: string;
|
|
390
396
|
/**
|
|
391
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
397
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
392
398
|
* @type {number}
|
|
393
399
|
* @memberof TranslationApiListProductLanguages
|
|
394
400
|
*/
|
|
395
401
|
readonly pageSize?: number;
|
|
396
402
|
/**
|
|
397
|
-
* 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,
|
|
403
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
398
404
|
* @type {string}
|
|
399
405
|
* @memberof TranslationApiListProductLanguages
|
|
400
406
|
*/
|
|
401
407
|
readonly pageToken?: string;
|
|
402
408
|
/**
|
|
403
|
-
* Filter the response by one or multiple fields.
|
|
404
|
-
* @type {
|
|
409
|
+
* 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>
|
|
410
|
+
* @type {string}
|
|
405
411
|
* @memberof TranslationApiListProductLanguages
|
|
406
412
|
*/
|
|
407
|
-
readonly filter?:
|
|
413
|
+
readonly filter?: string;
|
|
408
414
|
/**
|
|
409
|
-
* Search the
|
|
410
|
-
* @type {
|
|
415
|
+
* 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>
|
|
416
|
+
* @type {string}
|
|
411
417
|
* @memberof TranslationApiListProductLanguages
|
|
412
418
|
*/
|
|
413
|
-
readonly search?:
|
|
419
|
+
readonly search?: string;
|
|
414
420
|
/**
|
|
415
|
-
*
|
|
416
|
-
* @type {
|
|
421
|
+
* 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>
|
|
422
|
+
* @type {string}
|
|
417
423
|
* @memberof TranslationApiListProductLanguages
|
|
418
424
|
*/
|
|
419
|
-
readonly order?:
|
|
425
|
+
readonly order?: string;
|
|
420
426
|
/**
|
|
421
|
-
*
|
|
422
|
-
* @type {
|
|
427
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
428
|
+
* @type {string}
|
|
423
429
|
* @memberof TranslationApiListProductLanguages
|
|
424
430
|
*/
|
|
425
|
-
readonly expand?:
|
|
431
|
+
readonly expand?: string;
|
|
432
|
+
/**
|
|
433
|
+
* 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>
|
|
434
|
+
* @type {string}
|
|
435
|
+
* @memberof TranslationApiListProductLanguages
|
|
436
|
+
*/
|
|
437
|
+
readonly filters?: string;
|
|
426
438
|
}
|
|
427
439
|
/**
|
|
428
440
|
* Request parameters for listTranslations operation in TranslationApi.
|
|
@@ -437,41 +449,47 @@ export interface TranslationApiListTranslationsRequest {
|
|
|
437
449
|
*/
|
|
438
450
|
readonly authorization?: string;
|
|
439
451
|
/**
|
|
440
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and
|
|
441
|
-
* @type {
|
|
452
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
453
|
+
* @type {number}
|
|
454
|
+
* @memberof TranslationApiListTranslations
|
|
455
|
+
*/
|
|
456
|
+
readonly pageSize?: number;
|
|
457
|
+
/**
|
|
458
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
459
|
+
* @type {string}
|
|
442
460
|
* @memberof TranslationApiListTranslations
|
|
443
461
|
*/
|
|
444
|
-
readonly
|
|
462
|
+
readonly pageToken?: string;
|
|
445
463
|
/**
|
|
446
|
-
*
|
|
447
|
-
* @type {
|
|
464
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: key</i>
|
|
465
|
+
* @type {string}
|
|
448
466
|
* @memberof TranslationApiListTranslations
|
|
449
467
|
*/
|
|
450
|
-
readonly
|
|
468
|
+
readonly filter?: string;
|
|
451
469
|
/**
|
|
452
|
-
*
|
|
453
|
-
* @type {
|
|
470
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: key</i>
|
|
471
|
+
* @type {string}
|
|
454
472
|
* @memberof TranslationApiListTranslations
|
|
455
473
|
*/
|
|
456
|
-
readonly
|
|
474
|
+
readonly search?: string;
|
|
457
475
|
/**
|
|
458
|
-
*
|
|
459
|
-
* @type {
|
|
476
|
+
* 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>
|
|
477
|
+
* @type {string}
|
|
460
478
|
* @memberof TranslationApiListTranslations
|
|
461
479
|
*/
|
|
462
|
-
readonly
|
|
480
|
+
readonly order?: string;
|
|
463
481
|
/**
|
|
464
|
-
*
|
|
465
|
-
* @type {
|
|
482
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
483
|
+
* @type {string}
|
|
466
484
|
* @memberof TranslationApiListTranslations
|
|
467
485
|
*/
|
|
468
|
-
readonly
|
|
486
|
+
readonly expand?: string;
|
|
469
487
|
/**
|
|
470
|
-
*
|
|
471
|
-
* @type {
|
|
488
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: key</i>
|
|
489
|
+
* @type {string}
|
|
472
490
|
* @memberof TranslationApiListTranslations
|
|
473
491
|
*/
|
|
474
|
-
readonly
|
|
492
|
+
readonly filters?: string;
|
|
475
493
|
}
|
|
476
494
|
/**
|
|
477
495
|
* Request parameters for updateProductLanguage operation in TranslationApi.
|
|
@@ -531,7 +549,7 @@ export interface TranslationApiUploadProductTranslationsRequest {
|
|
|
531
549
|
*/
|
|
532
550
|
export declare class TranslationApi extends BaseAPI {
|
|
533
551
|
/**
|
|
534
|
-
* This creates a product language.
|
|
552
|
+
* This creates a product language. **Required Permissions** \"translation-management.translations.create\"
|
|
535
553
|
* @summary Create the product language
|
|
536
554
|
* @param {TranslationApiCreateProductLanguageRequest} requestParameters Request parameters.
|
|
537
555
|
* @param {*} [options] Override http request option.
|
|
@@ -540,7 +558,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
540
558
|
*/
|
|
541
559
|
createProductLanguage(requestParameters: TranslationApiCreateProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateProductLanguageResponseClass, any>>;
|
|
542
560
|
/**
|
|
543
|
-
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it.
|
|
561
|
+
* Permanently deletes the product language. Supply the unique id that was returned when you created the product language and this will delete it. **Required Permissions** \"translation-management.translations.delete\"
|
|
544
562
|
* @summary Delete the product language
|
|
545
563
|
* @param {TranslationApiDeleteProductLanguageRequest} requestParameters Request parameters.
|
|
546
564
|
* @param {*} [options] Override http request option.
|
|
@@ -549,7 +567,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
549
567
|
*/
|
|
550
568
|
deleteProductLanguage(requestParameters: TranslationApiDeleteProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
551
569
|
/**
|
|
552
|
-
* This downloads the list of translatable fields for a given product.
|
|
570
|
+
* This downloads the list of translatable fields for a given product. **Required Permissions** \"translation-management.translations.view\"
|
|
553
571
|
* @summary Retrieve the product translations
|
|
554
572
|
* @param {TranslationApiDownloadProductTranslationsRequest} requestParameters Request parameters.
|
|
555
573
|
* @param {*} [options] Override http request option.
|
|
@@ -558,7 +576,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
558
576
|
*/
|
|
559
577
|
downloadProductTranslations(requestParameters: TranslationApiDownloadProductTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
560
578
|
/**
|
|
561
|
-
* This gets a product language.
|
|
579
|
+
* This gets a product language. **Required Permissions** \"translation-management.translations.view\"
|
|
562
580
|
* @summary Retrieve the product language
|
|
563
581
|
* @param {TranslationApiGetProductLanguageRequest} requestParameters Request parameters.
|
|
564
582
|
* @param {*} [options] Override http request option.
|
|
@@ -567,7 +585,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
567
585
|
*/
|
|
568
586
|
getProductLanguage(requestParameters: TranslationApiGetProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetProductLanguageResponseClass, any>>;
|
|
569
587
|
/**
|
|
570
|
-
*
|
|
588
|
+
* Returns a list of product languages you have previously created. The product languages are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
571
589
|
* @summary List product languages
|
|
572
590
|
* @param {TranslationApiListProductLanguagesRequest} requestParameters Request parameters.
|
|
573
591
|
* @param {*} [options] Override http request option.
|
|
@@ -576,7 +594,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
576
594
|
*/
|
|
577
595
|
listProductLanguages(requestParameters?: TranslationApiListProductLanguagesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListProductLanguagesResponseClass, any>>;
|
|
578
596
|
/**
|
|
579
|
-
* Returns a list of translations you have previously created.
|
|
597
|
+
* Returns a list of translations you have previously created. The translations are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"translation-management.translations.view\"
|
|
580
598
|
* @summary List translations
|
|
581
599
|
* @param {TranslationApiListTranslationsRequest} requestParameters Request parameters.
|
|
582
600
|
* @param {*} [options] Override http request option.
|
|
@@ -585,7 +603,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
585
603
|
*/
|
|
586
604
|
listTranslations(requestParameters?: TranslationApiListTranslationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTranslationsResponseClass, any>>;
|
|
587
605
|
/**
|
|
588
|
-
* This updates the product language with the specified id.
|
|
606
|
+
* This updates the product language with the specified id. **Required Permissions** \"translation-management.translations.update\"
|
|
589
607
|
* @summary Update the product language
|
|
590
608
|
* @param {TranslationApiUpdateProductLanguageRequest} requestParameters Request parameters.
|
|
591
609
|
* @param {*} [options] Override http request option.
|
|
@@ -594,7 +612,7 @@ export declare class TranslationApi extends BaseAPI {
|
|
|
594
612
|
*/
|
|
595
613
|
updateProductLanguage(requestParameters: TranslationApiUpdateProductLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateProductLanguageResponseClass, any>>;
|
|
596
614
|
/**
|
|
597
|
-
* This uploads the translations for a given product.
|
|
615
|
+
* This uploads the translations for a given product. **Required Permissions** \"translation-management.translations.create\"
|
|
598
616
|
* @summary Create the product translations
|
|
599
617
|
* @param {TranslationApiUploadProductTranslationsRequest} requestParameters Request parameters.
|
|
600
618
|
* @param {*} [options] Override http request option.
|