oneentry 1.0.127 → 1.0.130
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 +3 -0
- package/dist/admins/adminsApi.d.ts +20 -20
- package/dist/admins/adminsApi.js +20 -20
- package/dist/admins/adminsInterfaces.d.ts +43 -43
- package/dist/attribute-sets/attributeSetsApi.d.ts +16 -16
- package/dist/attribute-sets/attributeSetsApi.js +16 -16
- package/dist/attribute-sets/attributeSetsInterfaces.d.ts +87 -85
- package/dist/auth-provider/authProviderApi.d.ts +127 -127
- package/dist/auth-provider/authProviderApi.js +127 -127
- package/dist/auth-provider/authProvidersInterfaces.d.ts +208 -202
- package/dist/base/asyncModules.d.ts +17 -17
- package/dist/base/asyncModules.js +39 -27
- package/dist/base/result.d.ts +11 -11
- package/dist/base/result.js +12 -16
- package/dist/base/stateModule.d.ts +6 -5
- package/dist/base/stateModule.js +15 -14
- package/dist/base/syncModules.d.ts +42 -37
- package/dist/base/syncModules.js +103 -49
- package/dist/base/utils.d.ts +45 -22
- package/dist/blocks/blocksApi.d.ts +24 -24
- package/dist/blocks/blocksApi.js +24 -24
- package/dist/blocks/blocksInterfaces.d.ts +85 -85
- package/dist/events/eventsApi.d.ts +11 -11
- package/dist/events/eventsApi.js +11 -11
- package/dist/events/eventsInterfaces.d.ts +23 -23
- package/dist/file-uploading/fileUploadingApi.d.ts +38 -38
- package/dist/file-uploading/fileUploadingApi.js +38 -38
- package/dist/file-uploading/fileUploadingInterfaces.d.ts +44 -44
- package/dist/forms/formsApi.d.ts +7 -7
- package/dist/forms/formsApi.js +7 -7
- package/dist/forms/formsInterfaces.d.ts +43 -31
- package/dist/forms-data/formsDataApi.d.ts +49 -37
- package/dist/forms-data/formsDataApi.js +49 -38
- package/dist/forms-data/formsDataInterfaces.d.ts +241 -219
- package/dist/general-types/generalTypesApi.d.ts +1 -1
- package/dist/general-types/generalTypesApi.js +1 -1
- package/dist/general-types/generalTypesInterfaces.d.ts +3 -3
- package/dist/index.d.ts +11 -10
- package/dist/index.js +11 -10
- package/dist/integration-collections/integrationCollectionsApi.d.ts +76 -80
- package/dist/integration-collections/integrationCollectionsApi.js +76 -80
- package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +145 -149
- package/dist/locales/localesInterfaces.d.ts +8 -8
- package/dist/menus/menusApi.d.ts +3 -3
- package/dist/menus/menusApi.js +3 -3
- package/dist/menus/menusInterfaces.d.ts +39 -39
- package/dist/orders/ordersApi.d.ts +56 -56
- package/dist/orders/ordersApi.js +56 -56
- package/dist/orders/ordersInterfaces.d.ts +204 -198
- package/dist/pages/pagesApi.d.ts +60 -60
- package/dist/pages/pagesApi.js +60 -60
- package/dist/pages/pagesInterfaces.d.ts +133 -141
- package/dist/payments/paymentsApi.d.ts +15 -15
- package/dist/payments/paymentsApi.js +15 -15
- package/dist/payments/paymentsInterfaces.d.ts +58 -57
- package/dist/product-statuses/productStatusesApi.d.ts +7 -7
- package/dist/product-statuses/productStatusesApi.js +7 -7
- package/dist/product-statuses/productStatusesInterfaces.d.ts +21 -21
- package/dist/products/productsApi.d.ts +240 -240
- package/dist/products/productsApi.js +240 -240
- package/dist/products/productsInterfaces.d.ts +311 -311
- package/dist/system/systemApi.d.ts +10 -10
- package/dist/system/systemApi.js +10 -10
- package/dist/templates/templatesApi.d.ts +8 -8
- package/dist/templates/templatesApi.js +8 -8
- package/dist/templates/templatesInterfaces.d.ts +22 -22
- package/dist/templates-preview/templatesPreviewApi.d.ts +5 -5
- package/dist/templates-preview/templatesPreviewApi.js +5 -5
- package/dist/templates-preview/templatesPreviewInterfaces.d.ts +54 -54
- package/dist/users/usersApi.d.ts +29 -29
- package/dist/users/usersApi.js +29 -29
- package/dist/users/usersInterfaces.d.ts +77 -77
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -97,6 +97,7 @@ const api = defineOneEntry('https://my-project.oneentry.cloud', {
|
|
|
97
97
|
auth: {
|
|
98
98
|
refreshToken: localStorage.getItem('refreshToken'),
|
|
99
99
|
saveFunction: tokenFunction,
|
|
100
|
+
providerMarker: 'email',
|
|
100
101
|
},
|
|
101
102
|
})
|
|
102
103
|
```
|
|
@@ -110,6 +111,7 @@ const api = defineOneEntry('https://my-project.oneentry.cloud', {
|
|
|
110
111
|
auth: {
|
|
111
112
|
customAuth: true,
|
|
112
113
|
refreshToken: localStorage.getItem('refreshToken'),
|
|
114
|
+
providerMarker: 'email',
|
|
113
115
|
},
|
|
114
116
|
})
|
|
115
117
|
```
|
|
@@ -147,6 +149,7 @@ const api = defineOneEntry('your-url', {
|
|
|
147
149
|
auth: {
|
|
148
150
|
customAuth: false,
|
|
149
151
|
userToken: 'rerfesh.token',
|
|
152
|
+
providerMarker: 'email',
|
|
150
153
|
saveFunction: saveTokenFromLocalStorage,
|
|
151
154
|
},
|
|
152
155
|
})
|
|
@@ -23,26 +23,26 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
|
|
|
23
23
|
/**
|
|
24
24
|
* Get all admins objects with filters.
|
|
25
25
|
* @handleName getAdminsInfo
|
|
26
|
-
* @param
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
* @param
|
|
40
|
-
* @param
|
|
41
|
-
* @param
|
|
42
|
-
* @param
|
|
43
|
-
* @param
|
|
44
|
-
* @param
|
|
45
|
-
* @returns {IAdminEntity[]}
|
|
26
|
+
* @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
|
|
27
|
+
[
|
|
28
|
+
{
|
|
29
|
+
"attributeMarker": "num",
|
|
30
|
+
"conditionMarker": "mth",
|
|
31
|
+
"conditionValue": 1
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"attributeMarker": "num",
|
|
35
|
+
"conditionMarker": "lth",
|
|
36
|
+
"conditionValue": 3
|
|
37
|
+
}
|
|
38
|
+
]
|
|
39
|
+
* @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
|
|
40
|
+
* @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
|
|
41
|
+
* @param {string} [body.conditionValue] - Value of the condition. Example: 1.
|
|
42
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
43
|
+
* @param {number} [offset] - Parameter for pagination. Default: 0.
|
|
44
|
+
* @param {number} [limit] - Parameter for pagination. Default: 30.
|
|
45
|
+
* @returns {IAdminEntity[]} Returns an array of admin objects.
|
|
46
46
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
47
47
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
48
48
|
*/
|
package/dist/admins/adminsApi.js
CHANGED
|
@@ -26,26 +26,26 @@ class AdminsApi extends asyncModules_1.default {
|
|
|
26
26
|
/**
|
|
27
27
|
* Get all admins objects with filters.
|
|
28
28
|
* @handleName getAdminsInfo
|
|
29
|
-
* @param
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
* @param
|
|
43
|
-
* @param
|
|
44
|
-
* @param
|
|
45
|
-
* @param
|
|
46
|
-
* @param
|
|
47
|
-
* @param
|
|
48
|
-
* @returns {IAdminEntity[]}
|
|
29
|
+
* @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
|
|
30
|
+
[
|
|
31
|
+
{
|
|
32
|
+
"attributeMarker": "num",
|
|
33
|
+
"conditionMarker": "mth",
|
|
34
|
+
"conditionValue": 1
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"attributeMarker": "num",
|
|
38
|
+
"conditionMarker": "lth",
|
|
39
|
+
"conditionValue": 3
|
|
40
|
+
}
|
|
41
|
+
]
|
|
42
|
+
* @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
|
|
43
|
+
* @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
|
|
44
|
+
* @param {string} [body.conditionValue] - Value of the condition. Example: 1.
|
|
45
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
46
|
+
* @param {number} [offset] - Parameter for pagination. Default: 0.
|
|
47
|
+
* @param {number} [limit] - Parameter for pagination. Default: 30.
|
|
48
|
+
* @returns {IAdminEntity[]} Returns an array of admin objects.
|
|
49
49
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
50
50
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
51
51
|
*/
|
|
@@ -8,26 +8,26 @@ interface IAdmins {
|
|
|
8
8
|
/**
|
|
9
9
|
* Get all admins objects with filters.
|
|
10
10
|
* @handleName getAdminsInfo
|
|
11
|
-
* @param
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
* @param
|
|
25
|
-
* @param
|
|
26
|
-
* @param
|
|
27
|
-
* @param
|
|
28
|
-
* @param
|
|
29
|
-
* @param
|
|
30
|
-
* @returns {IAdminEntity[]}
|
|
11
|
+
* @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: []. Example:
|
|
12
|
+
[
|
|
13
|
+
{
|
|
14
|
+
"attributeMarker": "num",
|
|
15
|
+
"conditionMarker": "mth",
|
|
16
|
+
"conditionValue": 1
|
|
17
|
+
},
|
|
18
|
+
{
|
|
19
|
+
"attributeMarker": "num",
|
|
20
|
+
"conditionMarker": "lth",
|
|
21
|
+
"conditionValue": 3
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
* @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
|
|
25
|
+
* @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
|
|
26
|
+
* @param {string} [body.conditionValue] - Value of the condition. Example: 1.
|
|
27
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
28
|
+
* @param {number} [offset] - Parameter for pagination. Default: 0.
|
|
29
|
+
* @param {number} [limit] - Parameter for pagination. Default: 30.
|
|
30
|
+
* @returns {IAdminEntity[]} Returns an array of admin objects.
|
|
31
31
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
32
32
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
33
33
|
*/
|
|
@@ -36,12 +36,12 @@ interface IAdmins {
|
|
|
36
36
|
/**
|
|
37
37
|
* Interface representing a Position entity.
|
|
38
38
|
* @interface IPosition
|
|
39
|
-
* @property {number}
|
|
40
|
-
* @property {boolean} [isLocked]
|
|
41
|
-
* @property {number}
|
|
42
|
-
* @property {number}
|
|
43
|
-
* @property {string}
|
|
44
|
-
* @property {number}
|
|
39
|
+
* @property {number} id - The unique identifier of the position. Example: 1764.
|
|
40
|
+
* @property {boolean} [isLocked] - Indicates whether the position is locked or not. Example: false.
|
|
41
|
+
* @property {number} objectId - The unique identifier of the object. Example: 120.
|
|
42
|
+
* @property {number} [objectCategoryId] - The unique identifier of the object's category. Example: 5.
|
|
43
|
+
* @property {string} objectType - The type of the object. Example: "admin".
|
|
44
|
+
* @property {number} position - The position of the object. Example: 192.
|
|
45
45
|
* @description This interface outlines the properties associated with a position within a system.
|
|
46
46
|
*/
|
|
47
47
|
interface IPosition {
|
|
@@ -55,21 +55,21 @@ interface IPosition {
|
|
|
55
55
|
/**
|
|
56
56
|
* Interface representing an Admin Entity.
|
|
57
57
|
* @interface IAdminEntity
|
|
58
|
-
* @property {number}
|
|
59
|
-
* @property {number | null}
|
|
60
|
-
* @property {string}
|
|
61
|
-
* @property {string | null}
|
|
62
|
-
* @property {number | null}
|
|
63
|
-
* @property {boolean}
|
|
64
|
-
* @property {IAttributeValues} attributeValues
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
58
|
+
* @property {number | null} id - The identifier of the object. Example: 1764.
|
|
59
|
+
* @property {number | null} attributeSetId - The identifier of the attribute set being used. Example: 120.
|
|
60
|
+
* @property {string} identifier - The textual identifier for the record field. Example: "admin1".
|
|
61
|
+
* @property {string | null} attributeSetIdentifier - The identifier of the attribute set. Example: "admins".
|
|
62
|
+
* @property {number | null} position - Position number (for sorting). Example: 1.
|
|
63
|
+
* @property {boolean} isSync - Page indexing flag (true or false). Example: true.
|
|
64
|
+
* @property {IAttributeValues} attributeValues - Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value). Example:
|
|
65
|
+
[
|
|
66
|
+
{
|
|
67
|
+
"marker": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"value": "Some value"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
]
|
|
73
73
|
* @description This interface captures the essential details and additional attributes of an admin entity.
|
|
74
74
|
*/
|
|
75
75
|
interface IAdminEntity {
|
|
@@ -86,8 +86,8 @@ interface IAdminEntity {
|
|
|
86
86
|
* Interface representing a query for fetching admin data.
|
|
87
87
|
* @interface IAdminQuery
|
|
88
88
|
* @property {string} langCode - Language code. Default: "en_US".
|
|
89
|
-
* @property {number} limit
|
|
90
|
-
* @property {number} offset
|
|
89
|
+
* @property {number} limit - Parameter for pagination. Default: 30.
|
|
90
|
+
* @property {number} offset - Parameter for pagination. Default: 0.
|
|
91
91
|
* @description This interface defines the parameters required for querying admin data, including optional defaults.
|
|
92
92
|
*/
|
|
93
93
|
interface IAdminQuery {
|
|
@@ -23,12 +23,12 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
|
|
|
23
23
|
/**
|
|
24
24
|
* Getting all attribute sets objects.
|
|
25
25
|
* @handleName getAttributes
|
|
26
|
-
* @param
|
|
27
|
-
* @param
|
|
28
|
-
* @param
|
|
29
|
-
* @param
|
|
30
|
-
* @param
|
|
31
|
-
* @returns {IAttributesSetsResponse}
|
|
26
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
27
|
+
* @param {number} [offset] - parameter offset of record selection. Default: 0.
|
|
28
|
+
* @param {number} [limit] - parameter limiting the selection of records. Default: 30.
|
|
29
|
+
* @param {number} [typeId] - identifier of the attribute set type. Default: null.
|
|
30
|
+
* @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
|
|
31
|
+
* @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
|
|
32
32
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
33
33
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
34
34
|
*/
|
|
@@ -36,9 +36,9 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
|
|
|
36
36
|
/**
|
|
37
37
|
* Getting all attributes with data from the attribute set.
|
|
38
38
|
* @handleName getAttributesByMarker
|
|
39
|
-
* @param
|
|
40
|
-
* @param
|
|
41
|
-
* @returns {IAttributeSetsEntity[]}
|
|
39
|
+
* @param {string} marker - Attribute marker. Example: "productAttributes".
|
|
40
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
41
|
+
* @returns {IAttributeSetsEntity[]} Returns an array of Attributes objects.
|
|
42
42
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
43
43
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
44
44
|
*/
|
|
@@ -46,10 +46,10 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
|
|
|
46
46
|
/**
|
|
47
47
|
* Get a single attribute with data from the attribute sets.
|
|
48
48
|
* @handleName getSingleAttributeByMarkerSet
|
|
49
|
-
* @param
|
|
50
|
-
* @param
|
|
51
|
-
* @param
|
|
52
|
-
* @returns {IAttributesSetsEntity}
|
|
49
|
+
* @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
|
|
50
|
+
* @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
|
|
51
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
52
|
+
* @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
|
|
53
53
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
54
54
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
55
55
|
*/
|
|
@@ -57,9 +57,9 @@ export default class AttributesSetsApi extends AsyncModules implements IAttribut
|
|
|
57
57
|
/**
|
|
58
58
|
* Getting a single object from a set of attributes by marker.
|
|
59
59
|
* @handleName getAttributeSetByMarker
|
|
60
|
-
* @param
|
|
61
|
-
* @param
|
|
62
|
-
* @returns {IAttributeSetsEntity}
|
|
60
|
+
* @param {string} marker - marker of the attribute set object. Example: "productAttributes".
|
|
61
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
62
|
+
* @returns {IAttributeSetsEntity} Returns one object of the attribute set.
|
|
63
63
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
64
64
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
65
65
|
*/
|
|
@@ -26,12 +26,12 @@ class AttributesSetsApi extends asyncModules_1.default {
|
|
|
26
26
|
/**
|
|
27
27
|
* Getting all attribute sets objects.
|
|
28
28
|
* @handleName getAttributes
|
|
29
|
-
* @param
|
|
30
|
-
* @param
|
|
31
|
-
* @param
|
|
32
|
-
* @param
|
|
33
|
-
* @param
|
|
34
|
-
* @returns {IAttributesSetsResponse}
|
|
29
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
30
|
+
* @param {number} [offset] - parameter offset of record selection. Default: 0.
|
|
31
|
+
* @param {number} [limit] - parameter limiting the selection of records. Default: 30.
|
|
32
|
+
* @param {number} [typeId] - identifier of the attribute set type. Default: null.
|
|
33
|
+
* @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
|
|
34
|
+
* @returns {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
|
|
35
35
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
36
36
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
37
37
|
*/
|
|
@@ -52,9 +52,9 @@ class AttributesSetsApi extends asyncModules_1.default {
|
|
|
52
52
|
/**
|
|
53
53
|
* Getting all attributes with data from the attribute set.
|
|
54
54
|
* @handleName getAttributesByMarker
|
|
55
|
-
* @param
|
|
56
|
-
* @param
|
|
57
|
-
* @returns {IAttributeSetsEntity[]}
|
|
55
|
+
* @param {string} marker - Attribute marker. Example: "productAttributes".
|
|
56
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
57
|
+
* @returns {IAttributeSetsEntity[]} Returns an array of Attributes objects.
|
|
58
58
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
59
59
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
60
60
|
*/
|
|
@@ -65,10 +65,10 @@ class AttributesSetsApi extends asyncModules_1.default {
|
|
|
65
65
|
/**
|
|
66
66
|
* Get a single attribute with data from the attribute sets.
|
|
67
67
|
* @handleName getSingleAttributeByMarkerSet
|
|
68
|
-
* @param
|
|
69
|
-
* @param
|
|
70
|
-
* @param
|
|
71
|
-
* @returns {IAttributesSetsEntity}
|
|
68
|
+
* @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
|
|
69
|
+
* @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
|
|
70
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
71
|
+
* @returns {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
|
|
72
72
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
73
73
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
74
74
|
*/
|
|
@@ -79,9 +79,9 @@ class AttributesSetsApi extends asyncModules_1.default {
|
|
|
79
79
|
/**
|
|
80
80
|
* Getting a single object from a set of attributes by marker.
|
|
81
81
|
* @handleName getAttributeSetByMarker
|
|
82
|
-
* @param
|
|
83
|
-
* @param
|
|
84
|
-
* @returns {IAttributeSetsEntity}
|
|
82
|
+
* @param {string} marker - marker of the attribute set object. Example: "productAttributes".
|
|
83
|
+
* @param {string} [langCode] - Language code. Default: "en_US".
|
|
84
|
+
* @returns {IAttributeSetsEntity} Returns one object of the attribute set.
|
|
85
85
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
86
86
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
87
87
|
*/
|
|
@@ -2,7 +2,7 @@ import type { IError, ILocalizeInfo } from '../base/utils';
|
|
|
2
2
|
/**
|
|
3
3
|
* Interface for retrieving attributes based on markers and language codes.
|
|
4
4
|
* @interface IAttributesSets
|
|
5
|
-
* @property {Function} getAttributesByMarker
|
|
5
|
+
* @property {Function} getAttributesByMarker - Get all attributes with data from the attribute sets.
|
|
6
6
|
* @property {Function} getSingleAttributeByMarkerSet - Get a single attribute with data from the attribute sets.
|
|
7
7
|
* @description This interface defines methods for retrieving attributes based on markers and language codes.
|
|
8
8
|
*/
|
|
@@ -10,9 +10,9 @@ interface IAttributesSets {
|
|
|
10
10
|
/**
|
|
11
11
|
* Fetches attributes by a specific marker.
|
|
12
12
|
* @handleName getAttributesByMarker
|
|
13
|
-
* @param
|
|
14
|
-
* @param
|
|
15
|
-
* @returns {IAttributeSetsEntity[]}
|
|
13
|
+
* @param {string} marker - The marker used to identify the attribute set. Example: "productAttributes".
|
|
14
|
+
* @param {string} [langCode] - The language code for localization purposes. Default: 'en_US'.
|
|
15
|
+
* @returns {IAttributeSetsEntity[]} A promise that resolves to an array of attribute set entities or an error.
|
|
16
16
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
17
17
|
* @description This method fetches attributes by a specific marker.
|
|
18
18
|
*/
|
|
@@ -20,10 +20,10 @@ interface IAttributesSets {
|
|
|
20
20
|
/**
|
|
21
21
|
* Fetches a single attribute by its marker and the set marker.
|
|
22
22
|
* @handleName getSingleAttributeByMarkerSet
|
|
23
|
-
* @param
|
|
24
|
-
* @param
|
|
25
|
-
* @param
|
|
26
|
-
* @returns {IAttributesSetsEntity}
|
|
23
|
+
* @param {string} attributeMarker - The marker identifying the attribute. Example: "color".
|
|
24
|
+
* @param {string} setMarker - The marker identifying the attribute set. Example: "productAttributes".
|
|
25
|
+
* @param {string} [langCode] - The language code for localization purposes. Default: "en_US".
|
|
26
|
+
* @returns {IAttributesSetsEntity} A promise that resolves to an attribute set entity or an error.
|
|
27
27
|
* @throws {IError} - If there is an error during the fetch operation, it will return an error object.
|
|
28
28
|
* @description This method fetches a single attribute by its marker and the set marker.
|
|
29
29
|
*/
|
|
@@ -32,10 +32,12 @@ interface IAttributesSets {
|
|
|
32
32
|
/**
|
|
33
33
|
* Represents the structure of a list item.
|
|
34
34
|
* @interface IListTitle
|
|
35
|
-
* @property {string}
|
|
36
|
-
* @property {number | string}
|
|
35
|
+
* @property {string} title - The title or name associated with the list item. Example: "Item Name".
|
|
36
|
+
* @property {number | string} value - The value of the list item, which can be either a number or a string depending on the context. Example: 42.
|
|
37
37
|
* @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable. Example: 1.
|
|
38
|
-
* @property {object}
|
|
38
|
+
* @property {object} extended - An object containing additional properties or metadata related to the list item. This could include any extra details that extend the basic information.
|
|
39
|
+
* @property {string | null} extended.value - The extended value, which can be a string or null. Example: "extra_value".
|
|
40
|
+
* @property {string | null} extended.type - The type of the extended value, which can be a string or null. Example: "color".
|
|
39
41
|
* @description This interface defines the structure of a list item, which includes properties for the title, value, position, and extended information.
|
|
40
42
|
*/
|
|
41
43
|
interface IListTitle {
|
|
@@ -56,42 +58,42 @@ type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' |
|
|
|
56
58
|
/**
|
|
57
59
|
* Represents an attribute set entity.
|
|
58
60
|
* @interface IAttributesSetsEntity
|
|
59
|
-
* @property {AttributeType}
|
|
60
|
-
* @property {any}
|
|
61
|
-
* @property {string}
|
|
62
|
-
* @property {number}
|
|
63
|
-
* @property {IListTitle[] | Record<string, any>} [listTitles]
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
* @property {Record<string, any>}
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
* @property {ILocalizeInfo}
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
* @property {Record<string, any>}
|
|
94
|
-
* @property {Record<string, any>}
|
|
61
|
+
* @property {AttributeType} type - Attribute type. Example: "string", "text", "integer", "etc".
|
|
62
|
+
* @property {any} [value] - Value of the attribute, which can be of any type.
|
|
63
|
+
* @property {string} marker - Textual identifier of the attribute (marker). Example: "color", "size", "etc".
|
|
64
|
+
* @property {number} position - Position number for sorting. Example: 1.
|
|
65
|
+
* @property {IListTitle[] | Record<string, any>} [listTitles] - Array of values (with extended data) for list and radioButton attributes. Example:
|
|
66
|
+
[
|
|
67
|
+
{
|
|
68
|
+
"title": "red",
|
|
69
|
+
"value": 1,
|
|
70
|
+
"position": 1,
|
|
71
|
+
"extendedValue": null,
|
|
72
|
+
"extendedValueType": null
|
|
73
|
+
},
|
|
74
|
+
{
|
|
75
|
+
"title": "yellow",
|
|
76
|
+
"value": 2,
|
|
77
|
+
"position": 2,
|
|
78
|
+
"extendedValue": null,
|
|
79
|
+
"extendedValueType": null
|
|
80
|
+
}
|
|
81
|
+
]
|
|
82
|
+
* @property {Record<string, any>} [validators] - Set of validators for validation. Example:
|
|
83
|
+
{
|
|
84
|
+
"requiredValidator": {
|
|
85
|
+
"strict": true
|
|
86
|
+
},
|
|
87
|
+
"defaultValueValidator": {
|
|
88
|
+
"fieldDefaultValue": 11
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
* @property {ILocalizeInfo} localizeInfos - The name of the template, taking into account localization. Example:
|
|
92
|
+
{
|
|
93
|
+
"title": "My attribute"
|
|
94
|
+
}
|
|
95
|
+
* @property {Record<string, any>} [additionalFields] - Additional fields for the attribute (optional).
|
|
96
|
+
* @property {Record<string, any>} [settings] - Additional attribute settings (optional).
|
|
95
97
|
* @description This interface defines the structure of an attribute set entity, including its type, marker, position, validators, localization information, list titles, additional fields, and settings.
|
|
96
98
|
*/
|
|
97
99
|
interface IAttributesSetsEntity {
|
|
@@ -108,33 +110,33 @@ interface IAttributesSetsEntity {
|
|
|
108
110
|
/**
|
|
109
111
|
* Represents an attribute set entity.
|
|
110
112
|
* @interface IAttributeSetsEntity
|
|
111
|
-
* @property {number}
|
|
112
|
-
* @property {string}
|
|
113
|
-
* @property {number}
|
|
114
|
-
* @property {string}
|
|
115
|
-
* @property {number}
|
|
116
|
-
* @property {string}
|
|
117
|
-
* @property {object}
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
* @property {boolean} isVisible
|
|
131
|
-
* @property {object}
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
* @property {string}
|
|
137
|
-
* @property {number}
|
|
113
|
+
* @property {number} id - The unique identifier of the attribute set entity. Example: 123.
|
|
114
|
+
* @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Example: "2023-10-01T12:00:00Z".
|
|
115
|
+
* @property {number} version - The version number of the attribute set, used for tracking changes or updates. Example: 1.
|
|
116
|
+
* @property {string} identifier - A string that uniquely identifies the attribute set. Example: "attributeSet1".
|
|
117
|
+
* @property {number} typeId - The numerical identifier representing the type of the attribute set. Example: 1.
|
|
118
|
+
* @property {string} title - The title or name of the attribute set. Example: "Product Attributes".
|
|
119
|
+
* @property {object} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data. Example:
|
|
120
|
+
{
|
|
121
|
+
"attribute1": {
|
|
122
|
+
"id": 1,
|
|
123
|
+
"type": "string",
|
|
124
|
+
"isPrice": false,
|
|
125
|
+
"original": true,
|
|
126
|
+
"identifier": "string",
|
|
127
|
+
"localizeInfos": {
|
|
128
|
+
"en_US": { "title": "String" }
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
* @property {boolean} isVisible - Indicates whether the attribute set is visible or not. Example: true.
|
|
133
|
+
* @property {object} properties - Additional properties associated with the attribute set, which can be of any type. Example:
|
|
134
|
+
{
|
|
135
|
+
"color": "red",
|
|
136
|
+
"size": "M"
|
|
137
|
+
}
|
|
138
|
+
* @property {string} type - The type of the attribute set, which could be a specific classification or category. Example: "product", "user", "etc".
|
|
139
|
+
* @property {number} position - The position number for sorting the attribute set. Example: 1.
|
|
138
140
|
* @description This interface defines the structure of an attribute set entity.
|
|
139
141
|
*/
|
|
140
142
|
interface IAttributeSetsEntity {
|
|
@@ -153,18 +155,18 @@ interface IAttributeSetsEntity {
|
|
|
153
155
|
/**
|
|
154
156
|
* Represents the response structure for attribute sets.
|
|
155
157
|
* @interface IAttributesSetsResponse
|
|
156
|
-
* @property {number}
|
|
158
|
+
* @property {number} total - Total items. Example: 100.
|
|
157
159
|
* @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity array containing attribute set entities. Example:
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
160
|
+
[
|
|
161
|
+
{
|
|
162
|
+
"id": 1,
|
|
163
|
+
"identifier": "set1"
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"id": 2,
|
|
167
|
+
"identifier": "set2"
|
|
168
|
+
}
|
|
169
|
+
]
|
|
168
170
|
* @description This interface defines the structure of a response object for attribute sets.
|
|
169
171
|
*/
|
|
170
172
|
interface IAttributesSetsResponse {
|