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