@memberjunction/graphql-dataprovider 2.75.0 → 2.77.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/README.md +1 -1
- package/dist/index.cjs +54 -48
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +110 -25
- package/dist/index.d.mts +110 -25
- package/dist/index.mjs +64 -58
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -5
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { GraphQLClient } from 'graphql-request';
|
|
2
2
|
export { gql } from 'graphql-request';
|
|
3
|
-
import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, TransactionResult } from '@memberjunction/core';
|
|
3
|
+
import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, EntityMergeOptions, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, TransactionResult } from '@memberjunction/core';
|
|
4
4
|
import { UserViewEntityExtended } from '@memberjunction/core-entities';
|
|
5
5
|
import { Observable } from 'rxjs';
|
|
6
6
|
import { ActionParam, ActionResult, EntityActionInvocationParams, EntityActionResult } from '@memberjunction/actions-base';
|
|
@@ -125,8 +125,8 @@ declare class GraphQLDataProvider extends ProviderBase implements IEntityDataPro
|
|
|
125
125
|
/**************************************************************************/
|
|
126
126
|
/**************************************************************************/
|
|
127
127
|
RunQuery(params: RunQueryParams, contextUser?: UserInfo): Promise<RunQueryResult>;
|
|
128
|
-
RunQueryByID(QueryID: string, CategoryID?: string,
|
|
129
|
-
RunQueryByName(QueryName: string, CategoryID?: string,
|
|
128
|
+
RunQueryByID(QueryID: string, CategoryID?: string, CategoryPath?: string, contextUser?: UserInfo, Parameters?: Record<string, any>, MaxRows?: number, StartRow?: number): Promise<RunQueryResult>;
|
|
129
|
+
RunQueryByName(QueryName: string, CategoryID?: string, CategoryPath?: string, contextUser?: UserInfo, Parameters?: Record<string, any>, MaxRows?: number, StartRow?: number): Promise<RunQueryResult>;
|
|
130
130
|
protected get QueryReturnFieldList(): string;
|
|
131
131
|
protected TransformQueryPayload(data: any): RunQueryResult;
|
|
132
132
|
/**************************************************************************/
|
|
@@ -160,7 +160,7 @@ declare class GraphQLDataProvider extends ProviderBase implements IEntityDataPro
|
|
|
160
160
|
Value: string;
|
|
161
161
|
}[];
|
|
162
162
|
GetRecordDuplicates(params: PotentialDuplicateRequest, contextUser?: UserInfo): Promise<PotentialDuplicateResponse>;
|
|
163
|
-
MergeRecords(request: RecordMergeRequest): Promise<RecordMergeResult>;
|
|
163
|
+
MergeRecords(request: RecordMergeRequest, contextUser?: UserInfo, options?: EntityMergeOptions): Promise<RecordMergeResult>;
|
|
164
164
|
Save(entity: BaseEntity, user: UserInfo, options: EntitySaveOptions): Promise<{}>;
|
|
165
165
|
Load(entity: BaseEntity, primaryKey: CompositeKey, EntityRelationshipsToLoad: string[], user: UserInfo): Promise<{}>;
|
|
166
166
|
/**
|
|
@@ -447,54 +447,51 @@ declare class GraphQLSystemUserClient {
|
|
|
447
447
|
* @param input - View input parameters for running by name
|
|
448
448
|
* @returns Promise containing the view execution results
|
|
449
449
|
*/
|
|
450
|
-
|
|
450
|
+
RunViewByName(input: RunViewByNameSystemUserInput): Promise<RunViewSystemUserResult>;
|
|
451
451
|
/**
|
|
452
452
|
* Runs a view by ID using the RunViewByIDSystemUser resolver.
|
|
453
453
|
* @param input - View input parameters for running by ID
|
|
454
454
|
* @returns Promise containing the view execution results
|
|
455
455
|
*/
|
|
456
|
-
|
|
456
|
+
RunViewByID(input: RunViewByIDSystemUserInput): Promise<RunViewSystemUserResult>;
|
|
457
457
|
/**
|
|
458
458
|
* Runs a dynamic view using the RunDynamicViewSystemUser resolver.
|
|
459
459
|
* @param input - View input parameters for dynamic view execution
|
|
460
460
|
* @returns Promise containing the view execution results
|
|
461
461
|
*/
|
|
462
|
-
|
|
462
|
+
RunDynamicView(input: RunDynamicViewSystemUserInput): Promise<RunViewSystemUserResult>;
|
|
463
463
|
/**
|
|
464
464
|
* Runs multiple views using the RunViewsSystemUser resolver. This method allows system users
|
|
465
465
|
* to execute view queries with the same functionality as regular users but with system-level privileges.
|
|
466
466
|
* @param input - Array of view input parameters
|
|
467
467
|
* @returns Promise containing the results from all view executions
|
|
468
468
|
*/
|
|
469
|
-
|
|
469
|
+
RunViews(input: RunViewSystemUserInput[]): Promise<RunViewSystemUserResult[]>;
|
|
470
470
|
/**
|
|
471
471
|
* Executes a stored query by ID using the GetQueryDataSystemUser resolver.
|
|
472
|
-
* @param
|
|
473
|
-
* @param categoryId - Optional category ID filter
|
|
474
|
-
* @param categoryName - Optional category name filter
|
|
475
|
-
* @param parameters - Optional parameters for templated queries
|
|
476
|
-
* @param maxRows - Optional maximum number of rows to return
|
|
477
|
-
* @param startRow - Optional starting row number for pagination
|
|
472
|
+
* @param input - Query input parameters for execution by ID
|
|
478
473
|
* @returns Promise containing the query execution results
|
|
479
474
|
*/
|
|
480
|
-
|
|
475
|
+
GetQueryData(input: GetQueryDataSystemUserInput): Promise<RunQuerySystemUserResult>;
|
|
481
476
|
/**
|
|
482
477
|
* Executes a stored query by name using the GetQueryDataByNameSystemUser resolver.
|
|
483
|
-
* @param
|
|
484
|
-
* @param categoryId - Optional category ID filter
|
|
485
|
-
* @param categoryName - Optional category name filter
|
|
486
|
-
* @param parameters - Optional parameters for templated queries
|
|
487
|
-
* @param maxRows - Optional maximum number of rows to return
|
|
488
|
-
* @param startRow - Optional starting row number for pagination
|
|
478
|
+
* @param input - Query input parameters for execution by name
|
|
489
479
|
* @returns Promise containing the query execution results
|
|
490
480
|
*/
|
|
491
|
-
|
|
481
|
+
GetQueryDataByName(input: GetQueryDataByNameSystemUserInput): Promise<RunQuerySystemUserResult>;
|
|
492
482
|
/**
|
|
493
|
-
* Creates a new query using the
|
|
494
|
-
* @param input -
|
|
483
|
+
* Creates a new query using the CreateQuerySystemUser mutation. This method is restricted to system users only.
|
|
484
|
+
* @param input - CreateQuerySystemUserInput containing all the query attributes including optional CategoryPath
|
|
495
485
|
* @returns Promise containing the result of the query creation
|
|
496
486
|
*/
|
|
497
487
|
CreateQuery(input: CreateQueryInput): Promise<CreateQueryResult>;
|
|
488
|
+
/**
|
|
489
|
+
* Deletes a query by ID using the DeleteQuerySystemResolver mutation. This method is restricted to system users only.
|
|
490
|
+
* @param ID - The ID of the query to delete
|
|
491
|
+
* @param options - Optional delete options controlling action execution
|
|
492
|
+
* @returns Promise containing the result of the query deletion
|
|
493
|
+
*/
|
|
494
|
+
DeleteQuery(ID: string, options?: DeleteQueryOptionsInput): Promise<DeleteQueryResult>;
|
|
498
495
|
}
|
|
499
496
|
/**
|
|
500
497
|
* Output type for GetData calls - contains results from executing multiple SQL queries
|
|
@@ -939,6 +936,64 @@ interface RunQuerySystemUserResult {
|
|
|
939
936
|
*/
|
|
940
937
|
AppliedParameters?: string;
|
|
941
938
|
}
|
|
939
|
+
/**
|
|
940
|
+
* Input type for GetQueryDataSystemUser method calls - executes a stored query by ID
|
|
941
|
+
*/
|
|
942
|
+
interface GetQueryDataSystemUserInput {
|
|
943
|
+
/**
|
|
944
|
+
* The ID of the query to execute
|
|
945
|
+
*/
|
|
946
|
+
QueryID: string;
|
|
947
|
+
/**
|
|
948
|
+
* Optional category ID filter
|
|
949
|
+
*/
|
|
950
|
+
CategoryID?: string;
|
|
951
|
+
/**
|
|
952
|
+
* Optional category path filter (hierarchical path like "/MJ/AI/Agents/" or simple name)
|
|
953
|
+
*/
|
|
954
|
+
CategoryPath?: string;
|
|
955
|
+
/**
|
|
956
|
+
* Optional parameters for templated queries
|
|
957
|
+
*/
|
|
958
|
+
Parameters?: Record<string, any>;
|
|
959
|
+
/**
|
|
960
|
+
* Optional maximum number of rows to return
|
|
961
|
+
*/
|
|
962
|
+
MaxRows?: number;
|
|
963
|
+
/**
|
|
964
|
+
* Optional starting row number for pagination
|
|
965
|
+
*/
|
|
966
|
+
StartRow?: number;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* Input type for GetQueryDataByNameSystemUser method calls - executes a stored query by name
|
|
970
|
+
*/
|
|
971
|
+
interface GetQueryDataByNameSystemUserInput {
|
|
972
|
+
/**
|
|
973
|
+
* The name of the query to execute
|
|
974
|
+
*/
|
|
975
|
+
QueryName: string;
|
|
976
|
+
/**
|
|
977
|
+
* Optional category ID filter
|
|
978
|
+
*/
|
|
979
|
+
CategoryID?: string;
|
|
980
|
+
/**
|
|
981
|
+
* Optional category path filter (hierarchical path like "/MJ/AI/Agents/" or simple name)
|
|
982
|
+
*/
|
|
983
|
+
CategoryPath?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Optional parameters for templated queries
|
|
986
|
+
*/
|
|
987
|
+
Parameters?: Record<string, any>;
|
|
988
|
+
/**
|
|
989
|
+
* Optional maximum number of rows to return
|
|
990
|
+
*/
|
|
991
|
+
MaxRows?: number;
|
|
992
|
+
/**
|
|
993
|
+
* Optional starting row number for pagination
|
|
994
|
+
*/
|
|
995
|
+
StartRow?: number;
|
|
996
|
+
}
|
|
942
997
|
/**
|
|
943
998
|
* Input type for CreateQuery mutation calls - creates a new query with optional hierarchical category path
|
|
944
999
|
*/
|
|
@@ -1013,6 +1068,36 @@ interface CreateQueryResult {
|
|
|
1013
1068
|
*/
|
|
1014
1069
|
QueryData?: string;
|
|
1015
1070
|
}
|
|
1071
|
+
/**
|
|
1072
|
+
* Delete options input type for controlling delete behavior
|
|
1073
|
+
*/
|
|
1074
|
+
interface DeleteQueryOptionsInput {
|
|
1075
|
+
/**
|
|
1076
|
+
* Whether to skip AI actions during deletion
|
|
1077
|
+
*/
|
|
1078
|
+
SkipEntityAIActions: boolean;
|
|
1079
|
+
/**
|
|
1080
|
+
* Whether to skip regular entity actions during deletion
|
|
1081
|
+
*/
|
|
1082
|
+
SkipEntityActions: boolean;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* Result type for DeleteQuery mutation calls - contains deletion success status and deleted query data
|
|
1086
|
+
*/
|
|
1087
|
+
interface DeleteQueryResult {
|
|
1088
|
+
/**
|
|
1089
|
+
* Whether the query deletion was successful
|
|
1090
|
+
*/
|
|
1091
|
+
Success: boolean;
|
|
1092
|
+
/**
|
|
1093
|
+
* Error message if the deletion failed (optional)
|
|
1094
|
+
*/
|
|
1095
|
+
ErrorMessage?: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* JSON string containing the deleted query data if successful (optional)
|
|
1098
|
+
*/
|
|
1099
|
+
QueryData?: string;
|
|
1100
|
+
}
|
|
1016
1101
|
|
|
1017
1102
|
/**
|
|
1018
1103
|
* Client for executing actions and entity actions through GraphQL.
|
|
@@ -1205,4 +1290,4 @@ declare class GraphQLActionClient {
|
|
|
1205
1290
|
private handleEntityActionError;
|
|
1206
1291
|
}
|
|
1207
1292
|
|
|
1208
|
-
export { ActionItemInput, ActionItemOutput, type CreateQueryInput, type CreateQueryResult, FieldMapper, GetDataOutput, GraphQLActionClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, RoleInput, RolesAndUsersInput, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, UserInput, setupGraphQLClient };
|
|
1293
|
+
export { ActionItemInput, ActionItemOutput, type CreateQueryInput, type CreateQueryResult, type DeleteQueryOptionsInput, type DeleteQueryResult, FieldMapper, GetDataOutput, type GetQueryDataByNameSystemUserInput, type GetQueryDataSystemUserInput, GraphQLActionClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, RoleInput, RolesAndUsersInput, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, UserInput, setupGraphQLClient };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { GraphQLClient } from 'graphql-request';
|
|
2
2
|
export { gql } from 'graphql-request';
|
|
3
|
-
import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, TransactionResult } from '@memberjunction/core';
|
|
3
|
+
import { ProviderConfigDataBase, ProviderBase, IEntityDataProvider, IMetadataProvider, IRunViewProvider, IRunReportProvider, IRunQueryProvider, UserInfo, RunReportParams, RunReportResult, RunQueryParams, RunQueryResult, RunViewParams, RunViewResult, EntityInfo, ProviderType, CompositeKey, RecordChange, RecordDependency, KeyValuePair, PotentialDuplicateRequest, PotentialDuplicateResponse, RecordMergeRequest, EntityMergeOptions, RecordMergeResult, BaseEntity, EntitySaveOptions, EntityDeleteOptions, DatasetItemFilterType, DatasetResultType, DatasetStatusResultType, TransactionGroupBase, EntityRecordNameInput, EntityRecordNameResult, ILocalStorageProvider, TransactionResult } from '@memberjunction/core';
|
|
4
4
|
import { UserViewEntityExtended } from '@memberjunction/core-entities';
|
|
5
5
|
import { Observable } from 'rxjs';
|
|
6
6
|
import { ActionParam, ActionResult, EntityActionInvocationParams, EntityActionResult } from '@memberjunction/actions-base';
|
|
@@ -125,8 +125,8 @@ declare class GraphQLDataProvider extends ProviderBase implements IEntityDataPro
|
|
|
125
125
|
/**************************************************************************/
|
|
126
126
|
/**************************************************************************/
|
|
127
127
|
RunQuery(params: RunQueryParams, contextUser?: UserInfo): Promise<RunQueryResult>;
|
|
128
|
-
RunQueryByID(QueryID: string, CategoryID?: string,
|
|
129
|
-
RunQueryByName(QueryName: string, CategoryID?: string,
|
|
128
|
+
RunQueryByID(QueryID: string, CategoryID?: string, CategoryPath?: string, contextUser?: UserInfo, Parameters?: Record<string, any>, MaxRows?: number, StartRow?: number): Promise<RunQueryResult>;
|
|
129
|
+
RunQueryByName(QueryName: string, CategoryID?: string, CategoryPath?: string, contextUser?: UserInfo, Parameters?: Record<string, any>, MaxRows?: number, StartRow?: number): Promise<RunQueryResult>;
|
|
130
130
|
protected get QueryReturnFieldList(): string;
|
|
131
131
|
protected TransformQueryPayload(data: any): RunQueryResult;
|
|
132
132
|
/**************************************************************************/
|
|
@@ -160,7 +160,7 @@ declare class GraphQLDataProvider extends ProviderBase implements IEntityDataPro
|
|
|
160
160
|
Value: string;
|
|
161
161
|
}[];
|
|
162
162
|
GetRecordDuplicates(params: PotentialDuplicateRequest, contextUser?: UserInfo): Promise<PotentialDuplicateResponse>;
|
|
163
|
-
MergeRecords(request: RecordMergeRequest): Promise<RecordMergeResult>;
|
|
163
|
+
MergeRecords(request: RecordMergeRequest, contextUser?: UserInfo, options?: EntityMergeOptions): Promise<RecordMergeResult>;
|
|
164
164
|
Save(entity: BaseEntity, user: UserInfo, options: EntitySaveOptions): Promise<{}>;
|
|
165
165
|
Load(entity: BaseEntity, primaryKey: CompositeKey, EntityRelationshipsToLoad: string[], user: UserInfo): Promise<{}>;
|
|
166
166
|
/**
|
|
@@ -447,54 +447,51 @@ declare class GraphQLSystemUserClient {
|
|
|
447
447
|
* @param input - View input parameters for running by name
|
|
448
448
|
* @returns Promise containing the view execution results
|
|
449
449
|
*/
|
|
450
|
-
|
|
450
|
+
RunViewByName(input: RunViewByNameSystemUserInput): Promise<RunViewSystemUserResult>;
|
|
451
451
|
/**
|
|
452
452
|
* Runs a view by ID using the RunViewByIDSystemUser resolver.
|
|
453
453
|
* @param input - View input parameters for running by ID
|
|
454
454
|
* @returns Promise containing the view execution results
|
|
455
455
|
*/
|
|
456
|
-
|
|
456
|
+
RunViewByID(input: RunViewByIDSystemUserInput): Promise<RunViewSystemUserResult>;
|
|
457
457
|
/**
|
|
458
458
|
* Runs a dynamic view using the RunDynamicViewSystemUser resolver.
|
|
459
459
|
* @param input - View input parameters for dynamic view execution
|
|
460
460
|
* @returns Promise containing the view execution results
|
|
461
461
|
*/
|
|
462
|
-
|
|
462
|
+
RunDynamicView(input: RunDynamicViewSystemUserInput): Promise<RunViewSystemUserResult>;
|
|
463
463
|
/**
|
|
464
464
|
* Runs multiple views using the RunViewsSystemUser resolver. This method allows system users
|
|
465
465
|
* to execute view queries with the same functionality as regular users but with system-level privileges.
|
|
466
466
|
* @param input - Array of view input parameters
|
|
467
467
|
* @returns Promise containing the results from all view executions
|
|
468
468
|
*/
|
|
469
|
-
|
|
469
|
+
RunViews(input: RunViewSystemUserInput[]): Promise<RunViewSystemUserResult[]>;
|
|
470
470
|
/**
|
|
471
471
|
* Executes a stored query by ID using the GetQueryDataSystemUser resolver.
|
|
472
|
-
* @param
|
|
473
|
-
* @param categoryId - Optional category ID filter
|
|
474
|
-
* @param categoryName - Optional category name filter
|
|
475
|
-
* @param parameters - Optional parameters for templated queries
|
|
476
|
-
* @param maxRows - Optional maximum number of rows to return
|
|
477
|
-
* @param startRow - Optional starting row number for pagination
|
|
472
|
+
* @param input - Query input parameters for execution by ID
|
|
478
473
|
* @returns Promise containing the query execution results
|
|
479
474
|
*/
|
|
480
|
-
|
|
475
|
+
GetQueryData(input: GetQueryDataSystemUserInput): Promise<RunQuerySystemUserResult>;
|
|
481
476
|
/**
|
|
482
477
|
* Executes a stored query by name using the GetQueryDataByNameSystemUser resolver.
|
|
483
|
-
* @param
|
|
484
|
-
* @param categoryId - Optional category ID filter
|
|
485
|
-
* @param categoryName - Optional category name filter
|
|
486
|
-
* @param parameters - Optional parameters for templated queries
|
|
487
|
-
* @param maxRows - Optional maximum number of rows to return
|
|
488
|
-
* @param startRow - Optional starting row number for pagination
|
|
478
|
+
* @param input - Query input parameters for execution by name
|
|
489
479
|
* @returns Promise containing the query execution results
|
|
490
480
|
*/
|
|
491
|
-
|
|
481
|
+
GetQueryDataByName(input: GetQueryDataByNameSystemUserInput): Promise<RunQuerySystemUserResult>;
|
|
492
482
|
/**
|
|
493
|
-
* Creates a new query using the
|
|
494
|
-
* @param input -
|
|
483
|
+
* Creates a new query using the CreateQuerySystemUser mutation. This method is restricted to system users only.
|
|
484
|
+
* @param input - CreateQuerySystemUserInput containing all the query attributes including optional CategoryPath
|
|
495
485
|
* @returns Promise containing the result of the query creation
|
|
496
486
|
*/
|
|
497
487
|
CreateQuery(input: CreateQueryInput): Promise<CreateQueryResult>;
|
|
488
|
+
/**
|
|
489
|
+
* Deletes a query by ID using the DeleteQuerySystemResolver mutation. This method is restricted to system users only.
|
|
490
|
+
* @param ID - The ID of the query to delete
|
|
491
|
+
* @param options - Optional delete options controlling action execution
|
|
492
|
+
* @returns Promise containing the result of the query deletion
|
|
493
|
+
*/
|
|
494
|
+
DeleteQuery(ID: string, options?: DeleteQueryOptionsInput): Promise<DeleteQueryResult>;
|
|
498
495
|
}
|
|
499
496
|
/**
|
|
500
497
|
* Output type for GetData calls - contains results from executing multiple SQL queries
|
|
@@ -939,6 +936,64 @@ interface RunQuerySystemUserResult {
|
|
|
939
936
|
*/
|
|
940
937
|
AppliedParameters?: string;
|
|
941
938
|
}
|
|
939
|
+
/**
|
|
940
|
+
* Input type for GetQueryDataSystemUser method calls - executes a stored query by ID
|
|
941
|
+
*/
|
|
942
|
+
interface GetQueryDataSystemUserInput {
|
|
943
|
+
/**
|
|
944
|
+
* The ID of the query to execute
|
|
945
|
+
*/
|
|
946
|
+
QueryID: string;
|
|
947
|
+
/**
|
|
948
|
+
* Optional category ID filter
|
|
949
|
+
*/
|
|
950
|
+
CategoryID?: string;
|
|
951
|
+
/**
|
|
952
|
+
* Optional category path filter (hierarchical path like "/MJ/AI/Agents/" or simple name)
|
|
953
|
+
*/
|
|
954
|
+
CategoryPath?: string;
|
|
955
|
+
/**
|
|
956
|
+
* Optional parameters for templated queries
|
|
957
|
+
*/
|
|
958
|
+
Parameters?: Record<string, any>;
|
|
959
|
+
/**
|
|
960
|
+
* Optional maximum number of rows to return
|
|
961
|
+
*/
|
|
962
|
+
MaxRows?: number;
|
|
963
|
+
/**
|
|
964
|
+
* Optional starting row number for pagination
|
|
965
|
+
*/
|
|
966
|
+
StartRow?: number;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* Input type for GetQueryDataByNameSystemUser method calls - executes a stored query by name
|
|
970
|
+
*/
|
|
971
|
+
interface GetQueryDataByNameSystemUserInput {
|
|
972
|
+
/**
|
|
973
|
+
* The name of the query to execute
|
|
974
|
+
*/
|
|
975
|
+
QueryName: string;
|
|
976
|
+
/**
|
|
977
|
+
* Optional category ID filter
|
|
978
|
+
*/
|
|
979
|
+
CategoryID?: string;
|
|
980
|
+
/**
|
|
981
|
+
* Optional category path filter (hierarchical path like "/MJ/AI/Agents/" or simple name)
|
|
982
|
+
*/
|
|
983
|
+
CategoryPath?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Optional parameters for templated queries
|
|
986
|
+
*/
|
|
987
|
+
Parameters?: Record<string, any>;
|
|
988
|
+
/**
|
|
989
|
+
* Optional maximum number of rows to return
|
|
990
|
+
*/
|
|
991
|
+
MaxRows?: number;
|
|
992
|
+
/**
|
|
993
|
+
* Optional starting row number for pagination
|
|
994
|
+
*/
|
|
995
|
+
StartRow?: number;
|
|
996
|
+
}
|
|
942
997
|
/**
|
|
943
998
|
* Input type for CreateQuery mutation calls - creates a new query with optional hierarchical category path
|
|
944
999
|
*/
|
|
@@ -1013,6 +1068,36 @@ interface CreateQueryResult {
|
|
|
1013
1068
|
*/
|
|
1014
1069
|
QueryData?: string;
|
|
1015
1070
|
}
|
|
1071
|
+
/**
|
|
1072
|
+
* Delete options input type for controlling delete behavior
|
|
1073
|
+
*/
|
|
1074
|
+
interface DeleteQueryOptionsInput {
|
|
1075
|
+
/**
|
|
1076
|
+
* Whether to skip AI actions during deletion
|
|
1077
|
+
*/
|
|
1078
|
+
SkipEntityAIActions: boolean;
|
|
1079
|
+
/**
|
|
1080
|
+
* Whether to skip regular entity actions during deletion
|
|
1081
|
+
*/
|
|
1082
|
+
SkipEntityActions: boolean;
|
|
1083
|
+
}
|
|
1084
|
+
/**
|
|
1085
|
+
* Result type for DeleteQuery mutation calls - contains deletion success status and deleted query data
|
|
1086
|
+
*/
|
|
1087
|
+
interface DeleteQueryResult {
|
|
1088
|
+
/**
|
|
1089
|
+
* Whether the query deletion was successful
|
|
1090
|
+
*/
|
|
1091
|
+
Success: boolean;
|
|
1092
|
+
/**
|
|
1093
|
+
* Error message if the deletion failed (optional)
|
|
1094
|
+
*/
|
|
1095
|
+
ErrorMessage?: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* JSON string containing the deleted query data if successful (optional)
|
|
1098
|
+
*/
|
|
1099
|
+
QueryData?: string;
|
|
1100
|
+
}
|
|
1016
1101
|
|
|
1017
1102
|
/**
|
|
1018
1103
|
* Client for executing actions and entity actions through GraphQL.
|
|
@@ -1205,4 +1290,4 @@ declare class GraphQLActionClient {
|
|
|
1205
1290
|
private handleEntityActionError;
|
|
1206
1291
|
}
|
|
1207
1292
|
|
|
1208
|
-
export { ActionItemInput, ActionItemOutput, type CreateQueryInput, type CreateQueryResult, FieldMapper, GetDataOutput, GraphQLActionClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, RoleInput, RolesAndUsersInput, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, UserInput, setupGraphQLClient };
|
|
1293
|
+
export { ActionItemInput, ActionItemOutput, type CreateQueryInput, type CreateQueryResult, type DeleteQueryOptionsInput, type DeleteQueryResult, FieldMapper, GetDataOutput, type GetQueryDataByNameSystemUserInput, type GetQueryDataSystemUserInput, GraphQLActionClient, GraphQLDataProvider, GraphQLProviderConfigData, GraphQLSystemUserClient, GraphQLTransactionGroup, RoleInput, RolesAndUsersInput, type RunDynamicViewSystemUserInput, type RunQuerySystemUserResult, type RunViewByIDSystemUserInput, type RunViewByNameSystemUserInput, type RunViewSystemUserInput, type RunViewSystemUserResult, type RunViewSystemUserResultRow, SimpleRemoteEntity, SimpleRemoteEntityField, SimpleRemoteEntityOutput, SyncDataAction, SyncDataResult, SyncRolesAndUsersResult, UserInput, setupGraphQLClient };
|