@digital-ai/dot-components 4.16.2 → 4.17.1
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/index.esm.js +461 -200
- package/package.json +1 -1
- package/src/lib/components/analytics/dashboard-utils/DashboardUtils.d.ts +2 -0
- package/src/lib/components/analytics/metadata-api/MetadataApiProvider.d.ts +4 -3
- package/src/lib/components/analytics/metadata-api/openapi/index.d.ts +7 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCopyBody.d.ts +4 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/DashboardCreateBody.d.ts +4 -4
- package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPatchBody.d.ts +4 -4
- package/src/lib/components/analytics/metadata-api/openapi/models/DashboardPutBody.d.ts +4 -4
- package/src/lib/components/analytics/metadata-api/openapi/models/DashboardView.d.ts +4 -4
- package/src/lib/components/analytics/metadata-api/openapi/models/Entity.d.ts +1 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/Error.d.ts +1 -1
- package/src/lib/components/analytics/metadata-api/openapi/models/HealthCheckResponse.d.ts +4 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/OriginInstance.d.ts +1 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/ProductConfigurationItem.d.ts +5 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/ProductConfigurationItemCreate.d.ts +8 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/ProductOrigin.d.ts +10 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/ProductView.d.ts +14 -0
- package/src/lib/components/analytics/metadata-api/openapi/models/ProductsResponse.d.ts +4 -0
- package/src/lib/components/analytics/metadata-api/openapi/services/BiService.d.ts +12 -6
- package/src/lib/components/analytics/metadata-api/openapi/services/CategoriesService.d.ts +4 -2
- package/src/lib/components/analytics/metadata-api/openapi/services/DashboardsService.d.ts +65 -20
- package/src/lib/components/analytics/metadata-api/openapi/services/EntitiesService.d.ts +10 -5
- package/src/lib/components/analytics/metadata-api/openapi/services/EntityAttributesService.d.ts +12 -6
- package/src/lib/components/analytics/metadata-api/openapi/services/EntityClassService.d.ts +10 -5
- package/src/lib/components/analytics/metadata-api/openapi/services/HelpContentService.d.ts +10 -5
- package/src/lib/components/analytics/metadata-api/openapi/services/MrProxyService.d.ts +40 -0
- package/src/lib/components/analytics/metadata-api/openapi/services/OriginInstancesService.d.ts +10 -5
- package/src/lib/components/analytics/metadata-api/openapi/services/OriginsService.d.ts +10 -5
- package/src/lib/components/analytics/metadata-api/openapi/services/ProductsService.d.ts +53 -0
- package/src/lib/components/analytics/metadata-api/openapi/services/UtilityService.d.ts +10 -1
package/src/lib/components/analytics/metadata-api/openapi/services/EntityAttributesService.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ export declare class EntityAttributesService {
|
|
|
6
6
|
/**
|
|
7
7
|
* Get a list of EntityAttributes.
|
|
8
8
|
* Return a list of EntityAttributes, filtered by query parameters.
|
|
9
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
9
10
|
* @param start Offset of the first fetched item.
|
|
10
11
|
* @param count Maximum number of fetched items.
|
|
11
12
|
* @param sort Sort ordering to apply to the query.
|
|
@@ -20,50 +21,55 @@ export declare class EntityAttributesService {
|
|
|
20
21
|
* @returns Error Default error response
|
|
21
22
|
* @throws ApiError
|
|
22
23
|
*/
|
|
23
|
-
static getEntityAttributesService(start?: number, count?: number, sort?: string, name?: string, description?: string, entityName?: string, originInstanceName?: string, isKey?: boolean, q?: string, id?: string): Promise<EntityAttributePagedResponse | Error>;
|
|
24
|
+
static getEntityAttributesService(xDigitalaiAccountId?: string, start?: number, count?: number, sort?: string, name?: string, description?: string, entityName?: string, originInstanceName?: string, isKey?: boolean, q?: string, id?: string): Promise<EntityAttributePagedResponse | Error>;
|
|
24
25
|
/**
|
|
25
26
|
* Create an EntityAttribute.
|
|
26
27
|
* Creates an EntityAttribute, owned by the authenticated API user.
|
|
27
28
|
* @param requestBody
|
|
29
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
28
30
|
* @returns EntityAttribute Entity created.
|
|
29
31
|
* @returns Error Default error response
|
|
30
32
|
* @throws ApiError
|
|
31
33
|
*/
|
|
32
|
-
static postEntityAttributesService(requestBody: EntityAttribute): Promise<EntityAttribute | Error>;
|
|
34
|
+
static postEntityAttributesService(requestBody: EntityAttribute, xDigitalaiAccountId?: string): Promise<EntityAttribute | Error>;
|
|
33
35
|
/**
|
|
34
36
|
* Create or Update multiple entity attributes.
|
|
35
37
|
* Creates an EntityAttribute incase id of the attribute is not present in the payload else modify the corresponding property of the attribute, owned by the authenticated API user.
|
|
36
38
|
* @param requestBody
|
|
39
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
37
40
|
* @returns EntityAttributeRequest OK
|
|
38
41
|
* @returns Error Default error response
|
|
39
42
|
* @throws ApiError
|
|
40
43
|
*/
|
|
41
|
-
static putEntityAttributesService(requestBody: EntityAttributeRequest): Promise<EntityAttributeRequest | Error>;
|
|
44
|
+
static putEntityAttributesService(requestBody: EntityAttributeRequest, xDigitalaiAccountId?: string): Promise<EntityAttributeRequest | Error>;
|
|
42
45
|
/**
|
|
43
46
|
* Get one EntityAttribute.
|
|
44
47
|
* Return a single EntityAttribute, selected by ID.
|
|
45
48
|
* @param id
|
|
49
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
46
50
|
* @returns EntityAttribute OK
|
|
47
51
|
* @returns Error Default error response
|
|
48
52
|
* @throws ApiError
|
|
49
53
|
*/
|
|
50
|
-
static getEntityAttributesService1(id: string): Promise<EntityAttribute | Error>;
|
|
54
|
+
static getEntityAttributesService1(id: string, xDigitalaiAccountId?: string): Promise<EntityAttribute | Error>;
|
|
51
55
|
/**
|
|
52
56
|
* Update a single EntityAttribute.
|
|
53
57
|
* Updates an EntityAttribute, selected by ID.
|
|
54
58
|
* @param id
|
|
55
59
|
* @param requestBody
|
|
60
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
56
61
|
* @returns EntityAttribute Entity updated.
|
|
57
62
|
* @returns Error Default error response
|
|
58
63
|
* @throws ApiError
|
|
59
64
|
*/
|
|
60
|
-
static putEntityAttributesService1(id: string, requestBody: EntityAttribute): Promise<EntityAttribute | Error>;
|
|
65
|
+
static putEntityAttributesService1(id: string, requestBody: EntityAttribute, xDigitalaiAccountId?: string): Promise<EntityAttribute | Error>;
|
|
61
66
|
/**
|
|
62
67
|
* Delete a EntityAttribute.
|
|
63
68
|
* Deletes a single EntityAttribute, selected by ID.
|
|
64
69
|
* @param id
|
|
70
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
65
71
|
* @returns Error Default error response
|
|
66
72
|
* @throws ApiError
|
|
67
73
|
*/
|
|
68
|
-
static deleteEntityAttributesService(id: string): Promise<Error>;
|
|
74
|
+
static deleteEntityAttributesService(id: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
69
75
|
}
|
|
@@ -5,6 +5,7 @@ export declare class EntityClassService {
|
|
|
5
5
|
/**
|
|
6
6
|
* Get a list of Entity Class.
|
|
7
7
|
* Return a list of Entity Classes, filtered by query parameters.
|
|
8
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
8
9
|
* @param start Offset of the first fetched item.
|
|
9
10
|
* @param count Maximum number of fetched items.
|
|
10
11
|
* @param sort Sort ordering to apply to the query.
|
|
@@ -16,41 +17,45 @@ export declare class EntityClassService {
|
|
|
16
17
|
* @returns Error Default error response
|
|
17
18
|
* @throws ApiError
|
|
18
19
|
*/
|
|
19
|
-
static getEntityClassService(start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<EntityClassPagedResponse | Error>;
|
|
20
|
+
static getEntityClassService(xDigitalaiAccountId?: string, start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<EntityClassPagedResponse | Error>;
|
|
20
21
|
/**
|
|
21
22
|
* Create an Entity Class.
|
|
22
23
|
* Creates an Entity Class, owned by the authenticated API user.
|
|
23
24
|
* @param requestBody
|
|
25
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
24
26
|
* @returns EntityClass Entity class created.
|
|
25
27
|
* @returns Error Default error response
|
|
26
28
|
* @throws ApiError
|
|
27
29
|
*/
|
|
28
|
-
static postEntityClassService(requestBody: EntityClass): Promise<EntityClass | Error>;
|
|
30
|
+
static postEntityClassService(requestBody: EntityClass, xDigitalaiAccountId?: string): Promise<EntityClass | Error>;
|
|
29
31
|
/**
|
|
30
32
|
* Get one Entity Class.
|
|
31
33
|
* Return a single Entity Class, selected by ID.
|
|
32
34
|
* @param id
|
|
35
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
33
36
|
* @returns EntityClass OK
|
|
34
37
|
* @returns Error Default error response
|
|
35
38
|
* @throws ApiError
|
|
36
39
|
*/
|
|
37
|
-
static getEntityClassService1(id: string): Promise<EntityClass | Error>;
|
|
40
|
+
static getEntityClassService1(id: string, xDigitalaiAccountId?: string): Promise<EntityClass | Error>;
|
|
38
41
|
/**
|
|
39
42
|
* Update a single Entity Class.
|
|
40
43
|
* Updates an Entity Class, selected by ID.
|
|
41
44
|
* @param id
|
|
42
45
|
* @param requestBody
|
|
46
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
43
47
|
* @returns EntityClass Entity Class updated.
|
|
44
48
|
* @returns Error Default error response
|
|
45
49
|
* @throws ApiError
|
|
46
50
|
*/
|
|
47
|
-
static putEntityClassService(id: string, requestBody: EntityClass): Promise<EntityClass | Error>;
|
|
51
|
+
static putEntityClassService(id: string, requestBody: EntityClass, xDigitalaiAccountId?: string): Promise<EntityClass | Error>;
|
|
48
52
|
/**
|
|
49
53
|
* Delete a Entity Class.
|
|
50
54
|
* Deletes a single Entity Class, selected by ID.
|
|
51
55
|
* @param id
|
|
56
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
52
57
|
* @returns Error Default error response
|
|
53
58
|
* @throws ApiError
|
|
54
59
|
*/
|
|
55
|
-
static deleteEntityClassService(id: string): Promise<Error>;
|
|
60
|
+
static deleteEntityClassService(id: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
56
61
|
}
|
|
@@ -7,45 +7,50 @@ export declare class HelpContentService {
|
|
|
7
7
|
/**
|
|
8
8
|
* Gets help content definitions.
|
|
9
9
|
* Return help content definitions.
|
|
10
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
10
11
|
* @returns HelpContentPagedResponse OK
|
|
11
12
|
* @returns Error Default error response
|
|
12
13
|
* @throws ApiError
|
|
13
14
|
*/
|
|
14
|
-
static getHelpContent(): Promise<HelpContentPagedResponse | Error>;
|
|
15
|
+
static getHelpContent(xDigitalaiAccountId?: string): Promise<HelpContentPagedResponse | Error>;
|
|
15
16
|
/**
|
|
16
17
|
* Upload an HTML file to be displayed as help content.
|
|
17
18
|
* Upload help content.
|
|
18
19
|
* @param requestBody
|
|
20
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
19
21
|
* @returns HelpContent Content uploaded.
|
|
20
22
|
* @returns Error Default error response
|
|
21
23
|
* @throws ApiError
|
|
22
24
|
*/
|
|
23
|
-
static createHelpContent(requestBody: HelpContentCreateBody): Promise<HelpContent | Error>;
|
|
25
|
+
static createHelpContent(requestBody: HelpContentCreateBody, xDigitalaiAccountId?: string): Promise<HelpContent | Error>;
|
|
24
26
|
/**
|
|
25
27
|
* Get a help content definition.
|
|
26
28
|
* Return a single help content definition, selected by ID.
|
|
27
29
|
* @param helpContentId
|
|
30
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
28
31
|
* @returns HelpContent OK
|
|
29
32
|
* @returns Error Default error response
|
|
30
33
|
* @throws ApiError
|
|
31
34
|
*/
|
|
32
|
-
static getHelpContentById(helpContentId: string): Promise<HelpContent | Error>;
|
|
35
|
+
static getHelpContentById(helpContentId: string, xDigitalaiAccountId?: string): Promise<HelpContent | Error>;
|
|
33
36
|
/**
|
|
34
37
|
* Update a help content definition.
|
|
35
38
|
* Update a single help content definition, selected by ID.
|
|
36
39
|
* @param helpContentId
|
|
37
40
|
* @param requestBody
|
|
41
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
38
42
|
* @returns HelpContent OK
|
|
39
43
|
* @returns Error Default error response
|
|
40
44
|
* @throws ApiError
|
|
41
45
|
*/
|
|
42
|
-
static putHelpContentById(helpContentId: string, requestBody: HelpContentPutBody): Promise<HelpContent | Error>;
|
|
46
|
+
static putHelpContentById(helpContentId: string, requestBody: HelpContentPutBody, xDigitalaiAccountId?: string): Promise<HelpContent | Error>;
|
|
43
47
|
/**
|
|
44
48
|
* Delete a help content definition.
|
|
45
49
|
* Delete a single help content definition, selected by ID.
|
|
46
50
|
* @param helpContentId
|
|
51
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
47
52
|
* @returns Error Default error response
|
|
48
53
|
* @throws ApiError
|
|
49
54
|
*/
|
|
50
|
-
static deleteHelpContentById(helpContentId: string): Promise<Error>;
|
|
55
|
+
static deleteHelpContentById(helpContentId: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
51
56
|
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { Error } from '../models/Error';
|
|
2
|
+
export declare class MrProxyService {
|
|
3
|
+
/**
|
|
4
|
+
* Passes the provided GET api path through to the metadata repository API.
|
|
5
|
+
* Returns the metadata repository response.
|
|
6
|
+
* @param mrPath
|
|
7
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
8
|
+
* @returns any OK
|
|
9
|
+
* @returns Error Default error response
|
|
10
|
+
* @throws ApiError
|
|
11
|
+
*/
|
|
12
|
+
static mrGet(mrPath: string, xDigitalaiAccountId?: string): Promise<any | Error>;
|
|
13
|
+
/**
|
|
14
|
+
* Passes the provided POST api path through to the metadata repository API.
|
|
15
|
+
* Returns the metadata repository response.
|
|
16
|
+
* @param mrPath
|
|
17
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
18
|
+
* @returns Error Default error response
|
|
19
|
+
* @throws ApiError
|
|
20
|
+
*/
|
|
21
|
+
static mrPost(mrPath: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
22
|
+
/**
|
|
23
|
+
* Passes the provided PUT api path through to the metadata repository API.
|
|
24
|
+
* Returns the metadata repository response.
|
|
25
|
+
* @param mrPath
|
|
26
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
27
|
+
* @returns Error Default error response
|
|
28
|
+
* @throws ApiError
|
|
29
|
+
*/
|
|
30
|
+
static mrPut(mrPath: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
31
|
+
/**
|
|
32
|
+
* Passes the provided DELETE api path through to the metadata repository API.
|
|
33
|
+
* Returns the metadata repository response.
|
|
34
|
+
* @param mrPath
|
|
35
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
36
|
+
* @returns Error Default error response
|
|
37
|
+
* @throws ApiError
|
|
38
|
+
*/
|
|
39
|
+
static mrDelete(mrPath: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
40
|
+
}
|
package/src/lib/components/analytics/metadata-api/openapi/services/OriginInstancesService.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ export declare class OriginInstancesService {
|
|
|
5
5
|
/**
|
|
6
6
|
* Get a list of OriginInstances.
|
|
7
7
|
* Return a list of OriginInstances, filtered by query parameters.
|
|
8
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
8
9
|
* @param start Offset of the first fetched item.
|
|
9
10
|
* @param count Maximum number of fetched items.
|
|
10
11
|
* @param sort Sort ordering to apply to the query.
|
|
@@ -16,41 +17,45 @@ export declare class OriginInstancesService {
|
|
|
16
17
|
* @returns Error Default error response
|
|
17
18
|
* @throws ApiError
|
|
18
19
|
*/
|
|
19
|
-
static getOriginInstancesService(start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<OriginInstancePagedResponse | Error>;
|
|
20
|
+
static getOriginInstancesService(xDigitalaiAccountId?: string, start?: number, count?: number, sort?: string, name?: string, description?: string, q?: string, id?: string): Promise<OriginInstancePagedResponse | Error>;
|
|
20
21
|
/**
|
|
21
22
|
* Create an OriginInstance.
|
|
22
23
|
* Creates an OriginInstance, owned by the authenticated API user.
|
|
23
24
|
* @param requestBody
|
|
25
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
24
26
|
* @returns OriginInstance OriginInstance created.
|
|
25
27
|
* @returns Error Default error response
|
|
26
28
|
* @throws ApiError
|
|
27
29
|
*/
|
|
28
|
-
static postOriginInstancesService(requestBody: OriginInstance): Promise<OriginInstance | Error>;
|
|
30
|
+
static postOriginInstancesService(requestBody: OriginInstance, xDigitalaiAccountId?: string): Promise<OriginInstance | Error>;
|
|
29
31
|
/**
|
|
30
32
|
* Get one OriginInstance.
|
|
31
33
|
* Return a single OriginInstance, selected by ID.
|
|
32
34
|
* @param id
|
|
35
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
33
36
|
* @returns OriginInstance OK
|
|
34
37
|
* @returns Error Default error response
|
|
35
38
|
* @throws ApiError
|
|
36
39
|
*/
|
|
37
|
-
static getOriginInstancesService1(id: string): Promise<OriginInstance | Error>;
|
|
40
|
+
static getOriginInstancesService1(id: string, xDigitalaiAccountId?: string): Promise<OriginInstance | Error>;
|
|
38
41
|
/**
|
|
39
42
|
* Update a single OriginInstance.
|
|
40
43
|
* Updates an OriginInstance, selected by ID.
|
|
41
44
|
* @param id
|
|
42
45
|
* @param requestBody
|
|
46
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
43
47
|
* @returns OriginInstance OriginInstance updated.
|
|
44
48
|
* @returns Error Default error response
|
|
45
49
|
* @throws ApiError
|
|
46
50
|
*/
|
|
47
|
-
static putOriginInstancesService(id: string, requestBody: OriginInstance): Promise<OriginInstance | Error>;
|
|
51
|
+
static putOriginInstancesService(id: string, requestBody: OriginInstance, xDigitalaiAccountId?: string): Promise<OriginInstance | Error>;
|
|
48
52
|
/**
|
|
49
53
|
* Delete a OriginInstance.
|
|
50
54
|
* Deletes a single OriginInstance, selected by ID.
|
|
51
55
|
* @param id
|
|
56
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
52
57
|
* @returns Error Default error response
|
|
53
58
|
* @throws ApiError
|
|
54
59
|
*/
|
|
55
|
-
static deleteOriginInstancesService(id: string): Promise<Error>;
|
|
60
|
+
static deleteOriginInstancesService(id: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
56
61
|
}
|
|
@@ -5,6 +5,7 @@ export declare class OriginsService {
|
|
|
5
5
|
/**
|
|
6
6
|
* Get a list of Origins.
|
|
7
7
|
* Return a list of Origins, filtered by query parameters.
|
|
8
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
8
9
|
* @param start Offset of the first fetched item.
|
|
9
10
|
* @param count Maximum number of fetched items.
|
|
10
11
|
* @param sort Sort ordering to apply to the query.
|
|
@@ -17,41 +18,45 @@ export declare class OriginsService {
|
|
|
17
18
|
* @returns Error Default error response
|
|
18
19
|
* @throws ApiError
|
|
19
20
|
*/
|
|
20
|
-
static getOriginsService(start?: number, count?: number, sort?: string, name?: string, description?: string, isPlatformOrigin?: boolean, q?: string, id?: string): Promise<OriginPagedResponse | Error>;
|
|
21
|
+
static getOriginsService(xDigitalaiAccountId?: string, start?: number, count?: number, sort?: string, name?: string, description?: string, isPlatformOrigin?: boolean, q?: string, id?: string): Promise<OriginPagedResponse | Error>;
|
|
21
22
|
/**
|
|
22
23
|
* Create an Origin.
|
|
23
24
|
* Creates an Origin, owned by the authenticated API user.
|
|
24
25
|
* @param requestBody
|
|
26
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
25
27
|
* @returns Origin Origin created.
|
|
26
28
|
* @returns Error Default error response
|
|
27
29
|
* @throws ApiError
|
|
28
30
|
*/
|
|
29
|
-
static postOriginsService(requestBody: Origin): Promise<Origin | Error>;
|
|
31
|
+
static postOriginsService(requestBody: Origin, xDigitalaiAccountId?: string): Promise<Origin | Error>;
|
|
30
32
|
/**
|
|
31
33
|
* Get one Origin.
|
|
32
34
|
* Return a single Origin, selected by ID.
|
|
33
35
|
* @param id
|
|
36
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
34
37
|
* @returns Origin OK
|
|
35
38
|
* @returns Error Default error response
|
|
36
39
|
* @throws ApiError
|
|
37
40
|
*/
|
|
38
|
-
static getOriginsService1(id: string): Promise<Origin | Error>;
|
|
41
|
+
static getOriginsService1(id: string, xDigitalaiAccountId?: string): Promise<Origin | Error>;
|
|
39
42
|
/**
|
|
40
43
|
* Update a single Origin.
|
|
41
44
|
* Updates an Origin, selected by ID.
|
|
42
45
|
* @param id
|
|
43
46
|
* @param requestBody
|
|
47
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
44
48
|
* @returns Origin Origin updated.
|
|
45
49
|
* @returns Error Default error response
|
|
46
50
|
* @throws ApiError
|
|
47
51
|
*/
|
|
48
|
-
static putOriginsService(id: string, requestBody: Origin): Promise<Origin | Error>;
|
|
52
|
+
static putOriginsService(id: string, requestBody: Origin, xDigitalaiAccountId?: string): Promise<Origin | Error>;
|
|
49
53
|
/**
|
|
50
54
|
* Delete a Origin.
|
|
51
55
|
* Deletes a single Origin, selected by ID.
|
|
52
56
|
* @param id
|
|
57
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
53
58
|
* @returns Error Default error response
|
|
54
59
|
* @throws ApiError
|
|
55
60
|
*/
|
|
56
|
-
static deleteOriginsService(id: string): Promise<Error>;
|
|
61
|
+
static deleteOriginsService(id: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
57
62
|
}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import type { Error } from '../models/Error';
|
|
2
|
+
import type { ProductConfigurationItem } from '../models/ProductConfigurationItem';
|
|
3
|
+
import type { ProductConfigurationItemCreate } from '../models/ProductConfigurationItemCreate';
|
|
4
|
+
import type { ProductsResponse } from '../models/ProductsResponse';
|
|
5
|
+
import type { ProductView } from '../models/ProductView';
|
|
6
|
+
export declare class ProductsService {
|
|
7
|
+
/**
|
|
8
|
+
* Get a list of enabled products
|
|
9
|
+
* Return a list of product definitions, filtered by query parameters.
|
|
10
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
11
|
+
* @param isSync Sync the products from metadata repository. This parameter has no effect if there are filters in the request.
|
|
12
|
+
* @param filter List of filters (each filter is a separate query param, and they are OR'ed).
|
|
13
|
+
*
|
|
14
|
+
* * **Filterable field names**: created_dt, dashboard_origins, external_id, id, name, updated_dt
|
|
15
|
+
* * **Searchable field names**: name
|
|
16
|
+
*
|
|
17
|
+
* @returns ProductsResponse OK
|
|
18
|
+
* @returns Error Default error response
|
|
19
|
+
* @throws ApiError
|
|
20
|
+
*/
|
|
21
|
+
static getProducts(xDigitalaiAccountId?: string, isSync?: boolean, filter?: Array<string>): Promise<ProductsResponse | Error>;
|
|
22
|
+
/**
|
|
23
|
+
* Get single product information.
|
|
24
|
+
* Returns a single product definition, selected by ID.
|
|
25
|
+
* @param productId
|
|
26
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
27
|
+
* @param isSync Sync the products from metadata repository. This parameter has no effect if there are filters in the request.
|
|
28
|
+
* @returns ProductView OK
|
|
29
|
+
* @returns Error Default error response
|
|
30
|
+
* @throws ApiError
|
|
31
|
+
*/
|
|
32
|
+
static getProductById(productId: string, xDigitalaiAccountId?: string, isSync?: boolean): Promise<ProductView | Error>;
|
|
33
|
+
/**
|
|
34
|
+
* Creates a configuration item and associates it with the product
|
|
35
|
+
* Returns new configuration item information.
|
|
36
|
+
* @param productId
|
|
37
|
+
* @param requestBody
|
|
38
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
39
|
+
* @returns Error Default error response
|
|
40
|
+
* @returns ProductConfigurationItem Created
|
|
41
|
+
* @throws ApiError
|
|
42
|
+
*/
|
|
43
|
+
static createProductConfigurationItem(productId: string, requestBody: ProductConfigurationItemCreate, xDigitalaiAccountId?: string): Promise<Error | ProductConfigurationItem>;
|
|
44
|
+
/**
|
|
45
|
+
* Removes a configuration item from the product
|
|
46
|
+
* @param configurationItemId
|
|
47
|
+
* @param productId
|
|
48
|
+
* @param xDigitalaiAccountId Perform the requested operation in the context of the Digital.ai account represented by this GUID. <em>Requires elevated permissions.</em>
|
|
49
|
+
* @returns Error Default error response
|
|
50
|
+
* @throws ApiError
|
|
51
|
+
*/
|
|
52
|
+
static removeProductConfigurationItem(configurationItemId: string, productId: string, xDigitalaiAccountId?: string): Promise<Error>;
|
|
53
|
+
}
|
|
@@ -34,6 +34,15 @@ export declare class UtilityService {
|
|
|
34
34
|
* @throws ApiError
|
|
35
35
|
*/
|
|
36
36
|
static getUtilityService3(): Promise<any | Error>;
|
|
37
|
+
/**
|
|
38
|
+
* NOC Server health
|
|
39
|
+
* Returns 201 if the NOC server is alive and configured.
|
|
40
|
+
* @param xDigitalaiNocInstance The instance name in the NOC server configuration
|
|
41
|
+
* @returns any OK
|
|
42
|
+
* @returns Error Default error response
|
|
43
|
+
* @throws ApiError
|
|
44
|
+
*/
|
|
45
|
+
static getUtilityService4(xDigitalaiNocInstance?: string): Promise<any | Error>;
|
|
37
46
|
/**
|
|
38
47
|
* [EXPERIMENTAL] Get Tenant information specific to this Service.
|
|
39
48
|
* Returns information about a single Tenant identified by account/tenant ID.
|
|
@@ -42,5 +51,5 @@ export declare class UtilityService {
|
|
|
42
51
|
* @returns Error Default error response
|
|
43
52
|
* @throws ApiError
|
|
44
53
|
*/
|
|
45
|
-
static
|
|
54
|
+
static getUtilityService5(xDigitalaiAccountId?: string): Promise<TenantInfo | Error>;
|
|
46
55
|
}
|