oneentry 1.0.28 → 1.0.29
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/README.md +46 -5
- package/dist/admins/adminsApi.d.ts +5 -1
- package/dist/admins/adminsApi.js +6 -3
- package/dist/admins/adminsInterfaces.d.ts +1 -1
- package/dist/admins/adminsInterfaces.js +0 -1
- package/dist/base/oneEntry.js +0 -1
- package/dist/base/utils.js +0 -1
- package/dist/blocks/blocksApi.d.ts +27 -0
- package/dist/blocks/blocksApi.js +38 -0
- package/dist/blocks/blocksInterfaces.d.ts +38 -0
- package/dist/blocks/blocksInterfaces.js +2 -0
- package/dist/file-uploding/fileUploadingApi.d.ts +13 -1
- package/dist/file-uploding/fileUploadingApi.js +15 -1
- package/dist/file-uploding/fileUploadingInterfaces.d.ts +12 -1
- package/dist/file-uploding/fileUploadingInterfaces.js +0 -1
- package/dist/forms/formsApi.d.ts +9 -2
- package/dist/forms/formsApi.js +11 -5
- package/dist/forms/formsInterfaces.d.ts +3 -3
- package/dist/forms/formsInterfaces.js +0 -1
- package/dist/formsData/formsDataApi.d.ts +9 -2
- package/dist/formsData/formsDataApi.js +11 -5
- package/dist/formsData/formsDataInterfaces.d.ts +3 -2
- package/dist/formsData/formsDataInterfaces.js +0 -1
- package/dist/general-types/GeneralTypesApi.js +0 -1
- package/dist/general-types/generalTypesInterfaces.js +0 -1
- package/dist/index.js +0 -1
- package/dist/locales/localesApi.js +0 -1
- package/dist/locales/localesInterfaces.js +0 -1
- package/dist/menus/menusApi.js +0 -1
- package/dist/menus/menusInterfaces.js +0 -1
- package/dist/pages/pagesApi.js +0 -1
- package/dist/pages/pagesInterfaces.js +0 -1
- package/dist/product-statuses/productStatusesApi.js +0 -1
- package/dist/product-statuses/productStatusesInterfaces.js +0 -1
- package/dist/products/productsApi.js +0 -1
- package/dist/products/productsInterfaces.js +0 -1
- package/dist/system/systemApi.js +0 -1
- package/dist/system/systemInterfaces.js +0 -1
- package/dist/templates/templatesApi.js +0 -1
- package/dist/templates/templatesInterfaces.js +0 -1
- package/dist/templates-preview/templatesPreviewApi.js +0 -1
- package/dist/templates-preview/templatesPreviewInterfaces.js +0 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,7 +62,11 @@ const { Admins } = defineOneEntry('your-url')
|
|
|
62
62
|
### Admins.getAdminsInfo()
|
|
63
63
|
|
|
64
64
|
```
|
|
65
|
-
const
|
|
65
|
+
const langCode = 'en_US'
|
|
66
|
+
const offset = 0
|
|
67
|
+
const limit = 30
|
|
68
|
+
|
|
69
|
+
const value = await Admins.getAdminsInfo(langCode, offset, limit)
|
|
66
70
|
```
|
|
67
71
|
|
|
68
72
|
|
|
@@ -135,6 +139,27 @@ const value = await FileUploading.delete("file.png", query)
|
|
|
135
139
|
|
|
136
140
|
> This void method delete a file from the cloud file storage.
|
|
137
141
|
|
|
142
|
+
### FileUploading.getFile()
|
|
143
|
+
```
|
|
144
|
+
const id = 123
|
|
145
|
+
const type = 'page'
|
|
146
|
+
const entity = 'editor'
|
|
147
|
+
const filename = 'file.png'
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
const value = await FileUploading.getFile(id, type, entity, filename)
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
> This method return file object by parameters.
|
|
154
|
+
|
|
155
|
+
Example return:
|
|
156
|
+
|
|
157
|
+
```
|
|
158
|
+
{
|
|
159
|
+
"file": File,
|
|
160
|
+
}
|
|
161
|
+
```
|
|
162
|
+
|
|
138
163
|
## Forms
|
|
139
164
|
|
|
140
165
|
const { Forms } = defineOneEntry('your-url');
|
|
@@ -142,7 +167,11 @@ const { Forms } = defineOneEntry('your-url');
|
|
|
142
167
|
### Forms.getAllForms()
|
|
143
168
|
|
|
144
169
|
```
|
|
145
|
-
const
|
|
170
|
+
const langCode = 'en_US'
|
|
171
|
+
const offset = 0
|
|
172
|
+
const limit = 30
|
|
173
|
+
|
|
174
|
+
const value = await Forms.getAllForms(langCode, offset, limit)
|
|
146
175
|
```
|
|
147
176
|
|
|
148
177
|
> This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.
|
|
@@ -185,7 +214,10 @@ Example return:
|
|
|
185
214
|
### Forms.getFormByMarker()
|
|
186
215
|
|
|
187
216
|
```
|
|
188
|
-
const
|
|
217
|
+
const marker = 'My form'
|
|
218
|
+
const langCode = 'en_US'
|
|
219
|
+
|
|
220
|
+
const value = await Forms.getFormByMarker(marker, langCode)
|
|
189
221
|
```
|
|
190
222
|
|
|
191
223
|
> This method retrieves a single form object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a FormEntity object.
|
|
@@ -256,7 +288,11 @@ Example return:
|
|
|
256
288
|
### FormData.getFormsData()
|
|
257
289
|
|
|
258
290
|
```
|
|
259
|
-
const
|
|
291
|
+
const langCode = 'en_US'
|
|
292
|
+
const offset = 0
|
|
293
|
+
const limit = 30
|
|
294
|
+
|
|
295
|
+
const value = await FormData.getFormsData(langCode, offset, limit)
|
|
260
296
|
```
|
|
261
297
|
|
|
262
298
|
> This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
|
|
@@ -284,7 +320,12 @@ Example return:
|
|
|
284
320
|
### FormData.getFormsDataByMarker()
|
|
285
321
|
|
|
286
322
|
```
|
|
287
|
-
const
|
|
323
|
+
const marker = 'my-marker'
|
|
324
|
+
const langCode = 'en_US'
|
|
325
|
+
const offset = 0
|
|
326
|
+
const limit = 30
|
|
327
|
+
|
|
328
|
+
const value = await FormData.getFormsDataByMarker(marker, langCode, offset, limit)
|
|
288
329
|
```
|
|
289
330
|
|
|
290
331
|
> This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
|
|
@@ -8,7 +8,11 @@ export default class AdminsApi extends OneEntry implements IAdmins {
|
|
|
8
8
|
/**
|
|
9
9
|
* Get all user objects - admins.
|
|
10
10
|
*
|
|
11
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
12
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
13
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
14
|
+
*
|
|
11
15
|
* @returns Returns all AdminEntity user objects
|
|
12
16
|
*/
|
|
13
|
-
getAdminsInfo(): Promise<Array<IAdminEntity>>;
|
|
17
|
+
getAdminsInfo(langCode?: string, offset?: number, limit?: number): Promise<Array<IAdminEntity>>;
|
|
14
18
|
}
|
package/dist/admins/adminsApi.js
CHANGED
|
@@ -12,12 +12,15 @@ class AdminsApi extends oneEntry_1.default {
|
|
|
12
12
|
/**
|
|
13
13
|
* Get all user objects - admins.
|
|
14
14
|
*
|
|
15
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
16
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
17
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
18
|
+
*
|
|
15
19
|
* @returns Returns all AdminEntity user objects
|
|
16
20
|
*/
|
|
17
|
-
async getAdminsInfo() {
|
|
18
|
-
const result = await this._fetchGet(
|
|
21
|
+
async getAdminsInfo(langCode = 'en_US', offset = 0, limit = 30) {
|
|
22
|
+
const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
|
|
19
23
|
return result;
|
|
20
24
|
}
|
|
21
25
|
}
|
|
22
26
|
exports.default = AdminsApi;
|
|
23
|
-
//# sourceMappingURL=adminsApi.js.map
|
|
@@ -5,7 +5,7 @@ import { IAttributeValues } from "../base/utils";
|
|
|
5
5
|
* @property {function} getAdminsInfo - Get all user objects - admins.
|
|
6
6
|
*/
|
|
7
7
|
interface IAdmins {
|
|
8
|
-
getAdminsInfo(): Promise<Array<IAdminEntity>>;
|
|
8
|
+
getAdminsInfo(langCode: string, offset?: number, limit?: number): Promise<Array<IAdminEntity>>;
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* Represents a position object.
|
package/dist/base/oneEntry.js
CHANGED
package/dist/base/utils.js
CHANGED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import OneEntry from "../base/oneEntry";
|
|
2
|
+
import { IBlocks, IBlocksEntity } from "./blocksInterfaces";
|
|
3
|
+
/**
|
|
4
|
+
* Controllers for working with blocks
|
|
5
|
+
*/
|
|
6
|
+
export default class BlocksApi extends OneEntry implements IBlocks {
|
|
7
|
+
constructor(url: string, token: string);
|
|
8
|
+
/**
|
|
9
|
+
* Get blocks by parameters.
|
|
10
|
+
*
|
|
11
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
12
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
13
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
14
|
+
*
|
|
15
|
+
* @returns Return array of BlocksEntity object.
|
|
16
|
+
*/
|
|
17
|
+
getBlocks(langCode?: string, offset?: number, limit?: number): Promise<Array<IBlocksEntity>>;
|
|
18
|
+
/**
|
|
19
|
+
* Get block by marker.
|
|
20
|
+
*
|
|
21
|
+
* @param {string} [marker] - Marker of Block.
|
|
22
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
23
|
+
*
|
|
24
|
+
* @returns Return BlocksEntity object.
|
|
25
|
+
*/
|
|
26
|
+
getBlockByMarker(marker: string, langCode?: string): Promise<IBlocksEntity>;
|
|
27
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const oneEntry_1 = require("../base/oneEntry");
|
|
4
|
+
/**
|
|
5
|
+
* Controllers for working with blocks
|
|
6
|
+
*/
|
|
7
|
+
class BlocksApi extends oneEntry_1.default {
|
|
8
|
+
constructor(url, token) {
|
|
9
|
+
super(url, token);
|
|
10
|
+
this._url += '/api/content/blocks';
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Get blocks by parameters.
|
|
14
|
+
*
|
|
15
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
16
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
17
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
18
|
+
*
|
|
19
|
+
* @returns Return array of BlocksEntity object.
|
|
20
|
+
*/
|
|
21
|
+
async getBlocks(langCode = 'en_US', offset = 0, limit = 30) {
|
|
22
|
+
const result = await this._fetchGet(`&langCode=${langCode}&offset=${offset}&limit=${limit}`);
|
|
23
|
+
return result;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Get block by marker.
|
|
27
|
+
*
|
|
28
|
+
* @param {string} [marker] - Marker of Block.
|
|
29
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
30
|
+
*
|
|
31
|
+
* @returns Return BlocksEntity object.
|
|
32
|
+
*/
|
|
33
|
+
async getBlockByMarker(marker, langCode = 'en_US') {
|
|
34
|
+
const result = await this._fetchGet(`/marker/${marker}&langCode=${langCode}`);
|
|
35
|
+
return result;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
exports.default = BlocksApi;
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { IAttributeValues, ILocalizeInfos } from "../base/utils";
|
|
2
|
+
/**
|
|
3
|
+
* Represents a interface object of Blocks Api.
|
|
4
|
+
*
|
|
5
|
+
* @property {function} getBlocks - Get all Blocks objects.
|
|
6
|
+
* @property {function} getBlockByMarker - Get Block object by marker.
|
|
7
|
+
*/
|
|
8
|
+
interface IBlocks {
|
|
9
|
+
getBlocks(langCode: string, offset?: number, limit?: number): Promise<Array<IBlocksEntity>>;
|
|
10
|
+
getBlockByMarker(marker: string, langCode: string): Promise<IBlocksEntity>;
|
|
11
|
+
}
|
|
12
|
+
interface IBlocksEntity {
|
|
13
|
+
id: number;
|
|
14
|
+
attributeSetId: number;
|
|
15
|
+
localizeInfos: ILocalizeInfos;
|
|
16
|
+
customSettings: ICustomSetting;
|
|
17
|
+
version: number;
|
|
18
|
+
identifier: string;
|
|
19
|
+
position: number;
|
|
20
|
+
attributeValues: IAttributeValues;
|
|
21
|
+
type: string;
|
|
22
|
+
templateIdentifier: string | null;
|
|
23
|
+
}
|
|
24
|
+
interface ICustomSetting {
|
|
25
|
+
sliderDelay: number;
|
|
26
|
+
sliderDelayType: string;
|
|
27
|
+
productQuantity: number;
|
|
28
|
+
productSortType: string;
|
|
29
|
+
productSortOrder: string;
|
|
30
|
+
productCountElementsPerRow: number;
|
|
31
|
+
similarProductRules: Array<{
|
|
32
|
+
property: string;
|
|
33
|
+
includes: string;
|
|
34
|
+
keywords: string;
|
|
35
|
+
strict: string;
|
|
36
|
+
}>;
|
|
37
|
+
}
|
|
38
|
+
export { IBlocks, IBlocksEntity };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import OneEntry from '../base/oneEntry';
|
|
2
|
-
import { IUploadingQuery, IUploadingReturns, IFileUploading } from "./fileUploadingInterfaces";
|
|
2
|
+
import { IUploadingQuery, IUploadingReturns, IFileUploading, IFileEntity } from "./fileUploadingInterfaces";
|
|
3
3
|
/**
|
|
4
4
|
* Controllers for working with file uploading
|
|
5
5
|
*/
|
|
@@ -35,4 +35,16 @@ export default class FileUploadingApi extends OneEntry implements IFileUploading
|
|
|
35
35
|
* @returns Deletes a file from the cloud file storage
|
|
36
36
|
*/
|
|
37
37
|
delete(filename: string, userQuery?: IUploadingQuery): Promise<any>;
|
|
38
|
+
/**
|
|
39
|
+
* Get file by parameters.
|
|
40
|
+
*
|
|
41
|
+
* @param {number} [id] Object identifier, from which the file is uploaded, determines the folder name in the storage
|
|
42
|
+
*
|
|
43
|
+
* @param {string} [type] - Type, determines the folder name in the storage
|
|
44
|
+
* @param {string} [entity] - entity name, from which the file is uploaded, determines the folder name in the storage
|
|
45
|
+
* @param {string} [filename] - Filename. Example "file.png"
|
|
46
|
+
*
|
|
47
|
+
* @returns Return file as File object
|
|
48
|
+
*/
|
|
49
|
+
getFile(id: number, type: string, entity: string, filename?: string): Promise<IFileEntity>;
|
|
38
50
|
}
|
|
@@ -54,6 +54,20 @@ class FileUploadingApi extends oneEntry_1.default {
|
|
|
54
54
|
const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
|
|
55
55
|
return result;
|
|
56
56
|
}
|
|
57
|
+
/**
|
|
58
|
+
* Get file by parameters.
|
|
59
|
+
*
|
|
60
|
+
* @param {number} [id] Object identifier, from which the file is uploaded, determines the folder name in the storage
|
|
61
|
+
*
|
|
62
|
+
* @param {string} [type] - Type, determines the folder name in the storage
|
|
63
|
+
* @param {string} [entity] - entity name, from which the file is uploaded, determines the folder name in the storage
|
|
64
|
+
* @param {string} [filename] - Filename. Example "file.png"
|
|
65
|
+
*
|
|
66
|
+
* @returns Return file as File object
|
|
67
|
+
*/
|
|
68
|
+
async getFile(id, type, entity, filename) {
|
|
69
|
+
const result = await this._fetchGet(`?id=${id}&type=${type}&entity=${entity}${filename ? `&filename=${filename}` : ''}`);
|
|
70
|
+
return result;
|
|
71
|
+
}
|
|
57
72
|
}
|
|
58
73
|
exports.default = FileUploadingApi;
|
|
59
|
-
//# sourceMappingURL=fileUploadingApi.js.map
|
|
@@ -1,6 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a interface object of File Uploading Api.
|
|
3
|
+
*
|
|
4
|
+
* @property {function} upload - Upload file from CMS.
|
|
5
|
+
* @property {function} delete - Delete file from CMS.
|
|
6
|
+
* @property {function} getFile - Get file by parameters.
|
|
7
|
+
*/
|
|
1
8
|
interface IFileUploading {
|
|
2
9
|
upload(data: Event, userQuery?: IUploadingQuery): Promise<IUploadingReturns>;
|
|
3
10
|
delete(filename: string, userQuery?: IUploadingQuery): Promise<any>;
|
|
11
|
+
getFile(id: number, type: string, entity: string, filename?: string): Promise<IFileEntity>;
|
|
12
|
+
}
|
|
13
|
+
interface IFileEntity {
|
|
14
|
+
file: File | string | null;
|
|
4
15
|
}
|
|
5
16
|
interface IUploadingQuery {
|
|
6
17
|
type?: string | null;
|
|
@@ -16,4 +27,4 @@ interface IUploadingReturns {
|
|
|
16
27
|
downloadLink: string;
|
|
17
28
|
size: number;
|
|
18
29
|
}
|
|
19
|
-
export { IUploadingQuery, IUploadingReturns, IFileUploading };
|
|
30
|
+
export { IUploadingQuery, IUploadingReturns, IFileUploading, IFileEntity };
|
package/dist/forms/formsApi.d.ts
CHANGED
|
@@ -8,13 +8,20 @@ export default class FormsApi extends OneEntry implements IForms {
|
|
|
8
8
|
/**
|
|
9
9
|
* Get all forms.
|
|
10
10
|
*
|
|
11
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
12
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
13
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
14
|
+
*
|
|
11
15
|
* @returns Returns array for all objects of type FormEntity
|
|
12
16
|
*/
|
|
13
|
-
getAllForms(): Promise<Array<IFormsEntity>>;
|
|
17
|
+
getAllForms(langCode?: string, offset?: number, limit?: number): Promise<Array<IFormsEntity>>;
|
|
14
18
|
/**
|
|
15
19
|
* Get one form by form marker.
|
|
16
20
|
*
|
|
21
|
+
* @param {string} [marker] - Marker of form.
|
|
22
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
23
|
+
*
|
|
17
24
|
* @returns Returns object of type FormEntity
|
|
18
25
|
*/
|
|
19
|
-
getFormByMarker(marker: string): Promise<IFormsEntity>;
|
|
26
|
+
getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity>;
|
|
20
27
|
}
|
package/dist/forms/formsApi.js
CHANGED
|
@@ -12,21 +12,27 @@ class FormsApi extends oneEntry_1.default {
|
|
|
12
12
|
/**
|
|
13
13
|
* Get all forms.
|
|
14
14
|
*
|
|
15
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
16
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
17
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
18
|
+
*
|
|
15
19
|
* @returns Returns array for all objects of type FormEntity
|
|
16
20
|
*/
|
|
17
|
-
async getAllForms() {
|
|
18
|
-
const result = await this._fetchGet(
|
|
21
|
+
async getAllForms(langCode = 'en_US', offset = 0, limit = 30) {
|
|
22
|
+
const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
|
|
19
23
|
return result;
|
|
20
24
|
}
|
|
21
25
|
/**
|
|
22
26
|
* Get one form by form marker.
|
|
23
27
|
*
|
|
28
|
+
* @param {string} [marker] - Marker of form.
|
|
29
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
30
|
+
*
|
|
24
31
|
* @returns Returns object of type FormEntity
|
|
25
32
|
*/
|
|
26
|
-
async getFormByMarker(marker) {
|
|
27
|
-
const result = await this._fetchGet(`/marker/${marker}`);
|
|
33
|
+
async getFormByMarker(marker, langCode = 'en_US') {
|
|
34
|
+
const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
|
|
28
35
|
return result;
|
|
29
36
|
}
|
|
30
37
|
}
|
|
31
38
|
exports.default = FormsApi;
|
|
32
|
-
//# sourceMappingURL=formsApi.js.map
|
|
@@ -7,8 +7,8 @@ import { IAttributeValues, ILocalizeInfos } from "../base/utils";
|
|
|
7
7
|
* @property {function} getFormByMarker - Get one form by form marker.
|
|
8
8
|
*/
|
|
9
9
|
interface IForms {
|
|
10
|
-
getAllForms(): Promise<Array<IFormsEntity>>;
|
|
11
|
-
getFormByMarker(marker: string): Promise<IFormsEntity>;
|
|
10
|
+
getAllForms(langCode: string, offset?: number, limit?: number): Promise<Array<IFormsEntity>>;
|
|
11
|
+
getFormByMarker(marker: string, langCode: string): Promise<IFormsEntity>;
|
|
12
12
|
}
|
|
13
13
|
/**
|
|
14
14
|
* Represents an object with various properties.
|
|
@@ -30,7 +30,7 @@ interface IFormsEntity {
|
|
|
30
30
|
processingType: string;
|
|
31
31
|
localizeInfos: ILocalizeInfos;
|
|
32
32
|
processingData: object | string;
|
|
33
|
-
|
|
33
|
+
attributes: IAttributeValues;
|
|
34
34
|
version: number;
|
|
35
35
|
identifier: string;
|
|
36
36
|
position: number;
|
|
@@ -8,9 +8,13 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
|
|
|
8
8
|
/**
|
|
9
9
|
* Get all forms data.
|
|
10
10
|
*
|
|
11
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
12
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
13
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
14
|
+
*
|
|
11
15
|
* @returns Returns array for all objects of FormData
|
|
12
16
|
*/
|
|
13
|
-
getFormsData(): Promise<Array<IFormsDataEntity>>;
|
|
17
|
+
getFormsData(langCode?: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
|
|
14
18
|
/**
|
|
15
19
|
* Find all product page objects with pagination and multiple filtering.
|
|
16
20
|
*
|
|
@@ -34,8 +38,11 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
|
|
|
34
38
|
* Get one object of form data by marker.
|
|
35
39
|
*
|
|
36
40
|
* @param {string} [marker] - Marker of the form data
|
|
41
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
42
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
43
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
37
44
|
*
|
|
38
45
|
* @returns Returns array of object FormDataEntity
|
|
39
46
|
*/
|
|
40
|
-
getFormsDataByMarker(marker: string): Promise<Array<IFormsDataEntity>>;
|
|
47
|
+
getFormsDataByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
|
|
41
48
|
}
|
|
@@ -12,10 +12,14 @@ class FormsDataApi extends oneEntry_1.default {
|
|
|
12
12
|
/**
|
|
13
13
|
* Get all forms data.
|
|
14
14
|
*
|
|
15
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
16
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
17
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
18
|
+
*
|
|
15
19
|
* @returns Returns array for all objects of FormData
|
|
16
20
|
*/
|
|
17
|
-
async getFormsData() {
|
|
18
|
-
const result = await this._fetchGet(
|
|
21
|
+
async getFormsData(langCode = 'en_US', offset = 0, limit = 30) {
|
|
22
|
+
const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
|
|
19
23
|
return result;
|
|
20
24
|
}
|
|
21
25
|
/**
|
|
@@ -44,13 +48,15 @@ class FormsDataApi extends oneEntry_1.default {
|
|
|
44
48
|
* Get one object of form data by marker.
|
|
45
49
|
*
|
|
46
50
|
* @param {string} [marker] - Marker of the form data
|
|
51
|
+
* @param {string} [langCode] - Language code. Default "en_US"
|
|
52
|
+
* @param {number} [offset] - Parameter for pagination. Default 0
|
|
53
|
+
* @param {number} [limit] - Parameter for pagination. Default 30
|
|
47
54
|
*
|
|
48
55
|
* @returns Returns array of object FormDataEntity
|
|
49
56
|
*/
|
|
50
|
-
async getFormsDataByMarker(marker) {
|
|
51
|
-
const result = await this._fetchGet(`/${marker}`);
|
|
57
|
+
async getFormsDataByMarker(marker, langCode = 'en_US', offset = 0, limit = 30) {
|
|
58
|
+
const result = await this._fetchGet(`/${marker}?langCode=${langCode}&offset=${offset}&limit=${limit}`);
|
|
52
59
|
return result;
|
|
53
60
|
}
|
|
54
61
|
}
|
|
55
62
|
exports.default = FormsDataApi;
|
|
56
|
-
//# sourceMappingURL=formsDataApi.js.map
|
|
@@ -8,9 +8,9 @@
|
|
|
8
8
|
* @property {function} getFormsDataByMarker - Get one object of form data by marker.
|
|
9
9
|
*/
|
|
10
10
|
interface IFormsData {
|
|
11
|
-
getFormsData(): Promise<Array<IFormsDataEntity>>;
|
|
11
|
+
getFormsData(langCode: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
|
|
12
12
|
postFormsData(data: Array<IFormsPost>): Promise<IFormsDataEntity>;
|
|
13
|
-
getFormsDataByMarker(marker: string): Promise<Array<IFormsDataEntity>>;
|
|
13
|
+
getFormsDataByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
16
|
* Represents a form data.
|
|
@@ -26,6 +26,7 @@ interface IFormsDataEntity {
|
|
|
26
26
|
formIdentifier: string;
|
|
27
27
|
time: Date | string;
|
|
28
28
|
formData: IFormData;
|
|
29
|
+
attributeSetIdentifier: string;
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
32
|
* Form data get by langcode identifier
|
package/dist/index.js
CHANGED
package/dist/menus/menusApi.js
CHANGED
package/dist/pages/pagesApi.js
CHANGED
package/dist/system/systemApi.js
CHANGED