@io-orkes/conductor-javascript 2.2.1 → 2.4.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 +258 -0
- package/dist/index.d.mts +478 -1
- package/dist/index.d.ts +478 -1
- package/dist/index.js +1369 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1366 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -74,6 +74,17 @@ type CircuitBreakerTransitionResponse = {
|
|
|
74
74
|
type Config$2 = {
|
|
75
75
|
circuitBreakerConfig?: OrkesCircuitBreakerConfig;
|
|
76
76
|
};
|
|
77
|
+
type ConnectivityTestInput = {
|
|
78
|
+
input?: {
|
|
79
|
+
[key: string]: unknown;
|
|
80
|
+
};
|
|
81
|
+
sink: string;
|
|
82
|
+
};
|
|
83
|
+
type ConnectivityTestResult = {
|
|
84
|
+
reason?: string;
|
|
85
|
+
successful?: boolean;
|
|
86
|
+
workflowId?: string;
|
|
87
|
+
};
|
|
77
88
|
type Declaration = {
|
|
78
89
|
allFields?: {
|
|
79
90
|
[key: string]: unknown;
|
|
@@ -452,6 +463,50 @@ type EventHandler = {
|
|
|
452
463
|
orgId?: string;
|
|
453
464
|
tags?: Array<Tag>;
|
|
454
465
|
};
|
|
466
|
+
type EventMessage = {
|
|
467
|
+
createdAt?: number;
|
|
468
|
+
eventExecutions?: Array<ExtendedEventExecution>;
|
|
469
|
+
eventTarget?: string;
|
|
470
|
+
eventType?: 'WEBHOOK' | 'MESSAGE';
|
|
471
|
+
fullPayload?: {
|
|
472
|
+
[key: string]: unknown;
|
|
473
|
+
};
|
|
474
|
+
id?: string;
|
|
475
|
+
orgId?: string;
|
|
476
|
+
payload?: string;
|
|
477
|
+
status?: 'RECEIVED' | 'HANDLED' | 'REJECTED';
|
|
478
|
+
statusDescription?: string;
|
|
479
|
+
};
|
|
480
|
+
type ExtendedConductorApplication$1 = {
|
|
481
|
+
createTime?: number;
|
|
482
|
+
createdBy?: string;
|
|
483
|
+
id?: string;
|
|
484
|
+
name?: string;
|
|
485
|
+
tags?: Array<Tag>;
|
|
486
|
+
updateTime?: number;
|
|
487
|
+
updatedBy?: string;
|
|
488
|
+
};
|
|
489
|
+
type ExtendedEventExecution = {
|
|
490
|
+
action?: 'start_workflow' | 'complete_task' | 'fail_task' | 'terminate_workflow' | 'update_workflow_variables';
|
|
491
|
+
created?: number;
|
|
492
|
+
event?: string;
|
|
493
|
+
eventHandler?: EventHandler;
|
|
494
|
+
fullMessagePayload?: {
|
|
495
|
+
[key: string]: unknown;
|
|
496
|
+
};
|
|
497
|
+
id?: string;
|
|
498
|
+
messageId?: string;
|
|
499
|
+
name?: string;
|
|
500
|
+
orgId?: string;
|
|
501
|
+
output?: {
|
|
502
|
+
[key: string]: unknown;
|
|
503
|
+
};
|
|
504
|
+
payload?: {
|
|
505
|
+
[key: string]: unknown;
|
|
506
|
+
};
|
|
507
|
+
status?: 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'SKIPPED';
|
|
508
|
+
statusDescription?: string;
|
|
509
|
+
};
|
|
455
510
|
type ExtendedTaskDef$1 = {
|
|
456
511
|
backoffScaleFactor?: number;
|
|
457
512
|
baseType?: string;
|
|
@@ -953,6 +1008,13 @@ type GenerateTokenRequest = {
|
|
|
953
1008
|
keyId: string;
|
|
954
1009
|
keySecret: string;
|
|
955
1010
|
};
|
|
1011
|
+
type HandledEventResponse = {
|
|
1012
|
+
active?: boolean;
|
|
1013
|
+
event?: string;
|
|
1014
|
+
name?: string;
|
|
1015
|
+
numberOfActions?: number;
|
|
1016
|
+
numberOfMessages?: number;
|
|
1017
|
+
};
|
|
956
1018
|
type HumanTaskAssignment = {
|
|
957
1019
|
assignee?: HumanTaskUser;
|
|
958
1020
|
slaMinutes?: number;
|
|
@@ -1553,6 +1615,10 @@ type ScrollableSearchResultWorkflowSummary = {
|
|
|
1553
1615
|
results?: Array<WorkflowSummary>;
|
|
1554
1616
|
totalHits?: number;
|
|
1555
1617
|
};
|
|
1618
|
+
type SearchResultHandledEventResponse = {
|
|
1619
|
+
results?: Array<HandledEventResponse>;
|
|
1620
|
+
totalHits?: number;
|
|
1621
|
+
};
|
|
1556
1622
|
type SearchResultTaskSummary = {
|
|
1557
1623
|
results?: Array<TaskSummary>;
|
|
1558
1624
|
totalHits?: number;
|
|
@@ -2718,6 +2784,19 @@ interface SignalResponse extends SignalResponse$1 {
|
|
|
2718
2784
|
taskDefName?: string;
|
|
2719
2785
|
workflowType?: string;
|
|
2720
2786
|
}
|
|
2787
|
+
interface AccessKey {
|
|
2788
|
+
id: string;
|
|
2789
|
+
secret: string;
|
|
2790
|
+
}
|
|
2791
|
+
interface AccessKeyInfo {
|
|
2792
|
+
id: string;
|
|
2793
|
+
createdAt: number;
|
|
2794
|
+
status: "ACTIVE" | "INACTIVE";
|
|
2795
|
+
}
|
|
2796
|
+
type ApplicationRole = "ADMIN" | "UNRESTRICTED_WORKER" | "METADATA_MANAGER" | "WORKFLOW_MANAGER" | "APPLICATION_MANAGER" | "USER" | "USER_READ_ONLY" | "WORKER" | "APPLICATION_CREATOR" | "METADATA_API" | "PROMPT_MANAGER";
|
|
2797
|
+
interface ExtendedConductorApplication extends Required<Omit<ExtendedConductorApplication$1, "tags">> {
|
|
2798
|
+
tags?: Tag[];
|
|
2799
|
+
}
|
|
2721
2800
|
|
|
2722
2801
|
type TimeoutPolicy = {
|
|
2723
2802
|
type: string;
|
|
@@ -3608,6 +3687,404 @@ declare class MetadataClient {
|
|
|
3608
3687
|
unregisterWorkflow(workflowName: string, version?: number): Promise<void>;
|
|
3609
3688
|
}
|
|
3610
3689
|
|
|
3690
|
+
declare class EventClient {
|
|
3691
|
+
readonly _client: Client;
|
|
3692
|
+
constructor(client: Client);
|
|
3693
|
+
/**
|
|
3694
|
+
* Get all the event handlers
|
|
3695
|
+
* @returns {Promise<EventHandler[]>}
|
|
3696
|
+
* @throws {ConductorSdkError}
|
|
3697
|
+
*/
|
|
3698
|
+
getAllEventHandlers(): Promise<EventHandler[]>;
|
|
3699
|
+
/**
|
|
3700
|
+
* Add event handlers
|
|
3701
|
+
* @param {EventHandler[]} eventHandlers
|
|
3702
|
+
* @returns {Promise<void>}
|
|
3703
|
+
* @throws {ConductorSdkError}
|
|
3704
|
+
*/
|
|
3705
|
+
addEventHandlers(eventHandlers: EventHandler[]): Promise<void>;
|
|
3706
|
+
/**
|
|
3707
|
+
* Add an event handler
|
|
3708
|
+
* @param {EventHandler} eventHandler
|
|
3709
|
+
* @returns {Promise<void>}
|
|
3710
|
+
* @throws {ConductorSdkError}
|
|
3711
|
+
*/
|
|
3712
|
+
addEventHandler(eventHandler: EventHandler): Promise<void>;
|
|
3713
|
+
/**
|
|
3714
|
+
* Update an event handler
|
|
3715
|
+
* @param {EventHandler} eventHandler
|
|
3716
|
+
* @returns {Promise<void>}
|
|
3717
|
+
* @throws {ConductorSdkError}
|
|
3718
|
+
*/
|
|
3719
|
+
updateEventHandler(eventHandler: EventHandler): Promise<void>;
|
|
3720
|
+
/**
|
|
3721
|
+
* Handle an incoming event
|
|
3722
|
+
* @param {Record<string, string>} data
|
|
3723
|
+
* @returns {Promise<void>}
|
|
3724
|
+
* @throws {ConductorSdkError}
|
|
3725
|
+
*/
|
|
3726
|
+
handleIncomingEvent(data: Record<string, string>): Promise<void>;
|
|
3727
|
+
/**
|
|
3728
|
+
* Get an event handler by name
|
|
3729
|
+
* @param {string} eventHandlerName
|
|
3730
|
+
* @returns {Promise<EventHandler>}
|
|
3731
|
+
* @throws {ConductorSdkError}
|
|
3732
|
+
*/
|
|
3733
|
+
getEventHandlerByName(eventHandlerName: string): Promise<EventHandler>;
|
|
3734
|
+
/**
|
|
3735
|
+
* Get all queue configs
|
|
3736
|
+
* @returns {Promise<Record<string, string>>}
|
|
3737
|
+
* @throws {ConductorSdkError}
|
|
3738
|
+
*/
|
|
3739
|
+
getAllQueueConfigs(): Promise<Record<string, string>>;
|
|
3740
|
+
/**
|
|
3741
|
+
* Delete queue config
|
|
3742
|
+
* @param {string} queueType
|
|
3743
|
+
* @param {string} queueName
|
|
3744
|
+
* @returns {Promise<void>}
|
|
3745
|
+
* @throws {ConductorSdkError}
|
|
3746
|
+
*/
|
|
3747
|
+
deleteQueueConfig(queueType: string, queueName: string): Promise<void>;
|
|
3748
|
+
/**
|
|
3749
|
+
* Get queue config
|
|
3750
|
+
* @param {string} queueType
|
|
3751
|
+
* @param {string} queueName
|
|
3752
|
+
* @returns {Promise<Record<string, unknown>>}
|
|
3753
|
+
* @throws {ConductorSdkError}
|
|
3754
|
+
*/
|
|
3755
|
+
getQueueConfig(queueType: string, queueName: string): Promise<Record<string, unknown>>;
|
|
3756
|
+
/**
|
|
3757
|
+
* Get event handlers for a given event
|
|
3758
|
+
* @param {string} event
|
|
3759
|
+
* @param {boolean} [activeOnly=false] Only return active handlers.
|
|
3760
|
+
* @returns {Promise<EventHandler[]>}
|
|
3761
|
+
* @throws {ConductorSdkError}
|
|
3762
|
+
*/
|
|
3763
|
+
getEventHandlersForEvent(event: string, activeOnly?: boolean): Promise<EventHandler[]>;
|
|
3764
|
+
/**
|
|
3765
|
+
* Remove an event handler by name
|
|
3766
|
+
* @param {string} name
|
|
3767
|
+
* @returns {Promise<void>}
|
|
3768
|
+
* @throws {ConductorSdkError}
|
|
3769
|
+
*/
|
|
3770
|
+
removeEventHandler(name: string): Promise<void>;
|
|
3771
|
+
/**
|
|
3772
|
+
* Get tags for an event handler
|
|
3773
|
+
* @param {string} name
|
|
3774
|
+
* @returns {Promise<Tag[]>}
|
|
3775
|
+
* @throws {ConductorSdkError}
|
|
3776
|
+
*/
|
|
3777
|
+
getTagsForEventHandler(name: string): Promise<Tag[]>;
|
|
3778
|
+
/**
|
|
3779
|
+
* Put tags for an event handler
|
|
3780
|
+
* @param {string} name
|
|
3781
|
+
* @param {Tag[]} tags
|
|
3782
|
+
* @returns {Promise<void>}
|
|
3783
|
+
* @throws {ConductorSdkError}
|
|
3784
|
+
*/
|
|
3785
|
+
putTagForEventHandler(name: string, tags: Tag[]): Promise<void>;
|
|
3786
|
+
/**
|
|
3787
|
+
* Delete tags for an event handler
|
|
3788
|
+
* @param {string} name
|
|
3789
|
+
* @param {Tag[]} tags
|
|
3790
|
+
* @returns {Promise<void>}
|
|
3791
|
+
* @throws {ConductorSdkError}
|
|
3792
|
+
*/
|
|
3793
|
+
deleteTagsForEventHandler(name: string, tags: Tag[]): Promise<void>;
|
|
3794
|
+
/**
|
|
3795
|
+
* Delete a tag for an event handler
|
|
3796
|
+
* @param {string} name
|
|
3797
|
+
* @param {Tag} tag
|
|
3798
|
+
* @returns {Promise<void>}
|
|
3799
|
+
* @throws {ConductorSdkError}
|
|
3800
|
+
*/
|
|
3801
|
+
deleteTagForEventHandler(name: string, tag: Tag): Promise<void>;
|
|
3802
|
+
/**
|
|
3803
|
+
* Test connectivity for a given queue using a workflow with EVENT task and an EventHandler
|
|
3804
|
+
* @param {ConnectivityTestInput} input
|
|
3805
|
+
* @returns {Promise<ConnectivityTestResult>}
|
|
3806
|
+
* @throws {ConductorSdkError}
|
|
3807
|
+
*/
|
|
3808
|
+
testConnectivity(input: ConnectivityTestInput): Promise<ConnectivityTestResult>;
|
|
3809
|
+
/**
|
|
3810
|
+
* Create or update queue config by name
|
|
3811
|
+
* @deprecated Prefer server's newer endpoints if available
|
|
3812
|
+
* @param {string} queueType
|
|
3813
|
+
* @param {string} queueName
|
|
3814
|
+
* @param {string} config
|
|
3815
|
+
* @returns {Promise<void>}
|
|
3816
|
+
* @throws {ConductorSdkError}
|
|
3817
|
+
*/
|
|
3818
|
+
putQueueConfig(queueType: string, queueName: string, config: string): Promise<void>;
|
|
3819
|
+
/**
|
|
3820
|
+
* Test endpoint (as exposed by API)
|
|
3821
|
+
* @returns {Promise<EventHandler>}
|
|
3822
|
+
* @throws {ConductorSdkError}
|
|
3823
|
+
*/
|
|
3824
|
+
test(): Promise<EventHandler>;
|
|
3825
|
+
/**
|
|
3826
|
+
* Get all active event handlers (execution view)
|
|
3827
|
+
* @returns {Promise<SearchResultHandledEventResponse>}
|
|
3828
|
+
* @throws {ConductorSdkError}
|
|
3829
|
+
*/
|
|
3830
|
+
getAllActiveEventHandlers(): Promise<SearchResultHandledEventResponse>;
|
|
3831
|
+
/**
|
|
3832
|
+
* Get event executions for a specific handler
|
|
3833
|
+
* @param {string} eventHandlerName
|
|
3834
|
+
* @param {number} [from] Pagination cursor
|
|
3835
|
+
* @returns {Promise<ExtendedEventExecution[]>}
|
|
3836
|
+
* @throws {ConductorSdkError}
|
|
3837
|
+
*/
|
|
3838
|
+
getEventExecutions(eventHandlerName: string, from?: number): Promise<ExtendedEventExecution[]>;
|
|
3839
|
+
/**
|
|
3840
|
+
* Get all event handlers with statistics (messages view)
|
|
3841
|
+
* @param {number} [from] Pagination cursor
|
|
3842
|
+
* @returns {Promise<SearchResultHandledEventResponse>}
|
|
3843
|
+
* @throws {ConductorSdkError}
|
|
3844
|
+
*/
|
|
3845
|
+
getEventHandlersWithStats(from?: number): Promise<SearchResultHandledEventResponse>;
|
|
3846
|
+
/**
|
|
3847
|
+
* Get event messages for a given event
|
|
3848
|
+
* @param {string} event
|
|
3849
|
+
* @param {number} [from] Pagination cursor
|
|
3850
|
+
* @returns {Promise<EventMessage[]>}
|
|
3851
|
+
* @throws {ConductorSdkError}
|
|
3852
|
+
*/
|
|
3853
|
+
getEventMessages(event: string, from?: number): Promise<EventMessage[]>;
|
|
3854
|
+
}
|
|
3855
|
+
|
|
3856
|
+
/**
|
|
3857
|
+
* Client for interacting with the Service Registry API
|
|
3858
|
+
*/
|
|
3859
|
+
declare class ServiceRegistryClient {
|
|
3860
|
+
readonly _client: Client;
|
|
3861
|
+
constructor(client: Client);
|
|
3862
|
+
/**
|
|
3863
|
+
* Retrieve all registered services
|
|
3864
|
+
* @returns Array of all registered services
|
|
3865
|
+
*/
|
|
3866
|
+
getRegisteredServices(): Promise<ServiceRegistry[]>;
|
|
3867
|
+
/**
|
|
3868
|
+
* Remove a service by name
|
|
3869
|
+
* @param name The name of the service to remove
|
|
3870
|
+
* @returns Promise that resolves when service is removed
|
|
3871
|
+
*/
|
|
3872
|
+
removeService(name: string): Promise<void>;
|
|
3873
|
+
/**
|
|
3874
|
+
* Get a service by name
|
|
3875
|
+
* @param name The name of the service to retrieve
|
|
3876
|
+
* @returns The requested service registry
|
|
3877
|
+
*/
|
|
3878
|
+
getService(name: string): Promise<ServiceRegistry | undefined>;
|
|
3879
|
+
/**
|
|
3880
|
+
* Open the circuit breaker for a service
|
|
3881
|
+
* @param name The name of the service
|
|
3882
|
+
* @returns Response with circuit breaker status
|
|
3883
|
+
*/
|
|
3884
|
+
openCircuitBreaker(name: string): Promise<CircuitBreakerTransitionResponse>;
|
|
3885
|
+
/**
|
|
3886
|
+
* Close the circuit breaker for a service
|
|
3887
|
+
* @param name The name of the service
|
|
3888
|
+
* @returns Response with circuit breaker status
|
|
3889
|
+
*/
|
|
3890
|
+
closeCircuitBreaker(name: string): Promise<CircuitBreakerTransitionResponse>;
|
|
3891
|
+
/**
|
|
3892
|
+
* Get circuit breaker status for a service
|
|
3893
|
+
* @param name The name of the service
|
|
3894
|
+
* @returns Response with circuit breaker status
|
|
3895
|
+
*/
|
|
3896
|
+
getCircuitBreakerStatus(name: string): Promise<CircuitBreakerTransitionResponse>;
|
|
3897
|
+
/**
|
|
3898
|
+
* Add or update a service registry
|
|
3899
|
+
* @param serviceRegistry The service registry to add or update
|
|
3900
|
+
* @returns Promise that resolves when service is added or updated
|
|
3901
|
+
*/
|
|
3902
|
+
addOrUpdateService(serviceRegistry: ServiceRegistry): Promise<void>;
|
|
3903
|
+
/**
|
|
3904
|
+
* Add or update a service method
|
|
3905
|
+
* @param registryName The name of the registry
|
|
3906
|
+
* @param method The service method to add or update
|
|
3907
|
+
* @returns Promise that resolves when method is added or updated
|
|
3908
|
+
*/
|
|
3909
|
+
addOrUpdateServiceMethod(registryName: string, method: ServiceMethod): Promise<void>;
|
|
3910
|
+
/**
|
|
3911
|
+
* Remove a service method
|
|
3912
|
+
* @param registryName The name of the registry
|
|
3913
|
+
* @param serviceName The name of the service
|
|
3914
|
+
* @param method The name of the method
|
|
3915
|
+
* @param methodType The type of the method
|
|
3916
|
+
* @returns Promise that resolves when method is removed
|
|
3917
|
+
*/
|
|
3918
|
+
removeMethod(registryName: string, serviceName: string, method: string, methodType: string): Promise<void>;
|
|
3919
|
+
/**
|
|
3920
|
+
* Get proto data
|
|
3921
|
+
* @param registryName The name of the registry
|
|
3922
|
+
* @param filename The name of the proto file
|
|
3923
|
+
* @returns The proto file data as a Blob
|
|
3924
|
+
*/
|
|
3925
|
+
getProtoData(registryName: string, filename: string): Promise<Blob>;
|
|
3926
|
+
/**
|
|
3927
|
+
* Set proto data
|
|
3928
|
+
* @param registryName The name of the registry
|
|
3929
|
+
* @param filename The name of the proto file
|
|
3930
|
+
* @param data The proto file data
|
|
3931
|
+
* @returns Promise that resolves when proto data is set
|
|
3932
|
+
*/
|
|
3933
|
+
setProtoData(registryName: string, filename: string, data: Blob): Promise<void>;
|
|
3934
|
+
/**
|
|
3935
|
+
* Delete a proto file
|
|
3936
|
+
* @param registryName The name of the registry
|
|
3937
|
+
* @param filename The name of the proto file
|
|
3938
|
+
* @returns Promise that resolves when proto file is deleted
|
|
3939
|
+
*/
|
|
3940
|
+
deleteProto(registryName: string, filename: string): Promise<void>;
|
|
3941
|
+
/**
|
|
3942
|
+
* Get all proto files for a registry
|
|
3943
|
+
* @param registryName The name of the registry
|
|
3944
|
+
* @returns List of proto registry entries
|
|
3945
|
+
*/
|
|
3946
|
+
getAllProtos(registryName: string): Promise<ProtoRegistryEntry[]>;
|
|
3947
|
+
/**
|
|
3948
|
+
* Discover service methods
|
|
3949
|
+
* @param name The name of the service
|
|
3950
|
+
* @param create Whether to create the discovered methods (defaults to false)
|
|
3951
|
+
* @returns The discovered service methods
|
|
3952
|
+
*/
|
|
3953
|
+
discover(name: string, create?: boolean): Promise<ServiceMethod[]>;
|
|
3954
|
+
}
|
|
3955
|
+
|
|
3956
|
+
declare class ApplicationClient {
|
|
3957
|
+
readonly _client: Client;
|
|
3958
|
+
constructor(client: Client);
|
|
3959
|
+
/**
|
|
3960
|
+
* Get all applications
|
|
3961
|
+
* @returns {Promise<ExtendedConductorApplication[]>}
|
|
3962
|
+
* @throws {ConductorSdkError}
|
|
3963
|
+
*/
|
|
3964
|
+
getAllApplications(): Promise<ExtendedConductorApplication[]>;
|
|
3965
|
+
/**
|
|
3966
|
+
* Create an application
|
|
3967
|
+
* @param {string} applicationName
|
|
3968
|
+
* @returns {Promise<ExtendedConductorApplication>}
|
|
3969
|
+
* @throws {ConductorSdkError}
|
|
3970
|
+
*/
|
|
3971
|
+
createApplication(applicationName: string): Promise<ExtendedConductorApplication>;
|
|
3972
|
+
/**
|
|
3973
|
+
* Get application by access key id
|
|
3974
|
+
* @param {string} accessKeyId
|
|
3975
|
+
* @returns {Promise<ExtendedConductorApplication>}
|
|
3976
|
+
* @throws {ConductorSdkError}
|
|
3977
|
+
*/
|
|
3978
|
+
getAppByAccessKeyId(accessKeyId: string): Promise<ExtendedConductorApplication>;
|
|
3979
|
+
/**
|
|
3980
|
+
* Delete an access key
|
|
3981
|
+
* @param {string} applicationId
|
|
3982
|
+
* @param {string} keyId
|
|
3983
|
+
* @returns {Promise<void>}
|
|
3984
|
+
* @throws {ConductorSdkError}
|
|
3985
|
+
*/
|
|
3986
|
+
deleteAccessKey(applicationId: string, keyId: string): Promise<void>;
|
|
3987
|
+
/**
|
|
3988
|
+
* Toggle the status of an access key
|
|
3989
|
+
* @param {string} applicationId
|
|
3990
|
+
* @param {string} keyId
|
|
3991
|
+
* @returns {Promise<AccessKeyInfo>}
|
|
3992
|
+
* @throws {ConductorSdkError}
|
|
3993
|
+
*/
|
|
3994
|
+
toggleAccessKeyStatus(applicationId: string, keyId: string): Promise<AccessKeyInfo>;
|
|
3995
|
+
/**
|
|
3996
|
+
* Remove role from application user
|
|
3997
|
+
* @param {string} applicationId
|
|
3998
|
+
* @param {string} role
|
|
3999
|
+
* @returns {Promise<void>}
|
|
4000
|
+
* @throws {ConductorSdkError}
|
|
4001
|
+
*/
|
|
4002
|
+
removeRoleFromApplicationUser(applicationId: string, role: string): Promise<void>;
|
|
4003
|
+
/**
|
|
4004
|
+
* Add role to application
|
|
4005
|
+
* @param {string} applicationId
|
|
4006
|
+
* @param {ApplicationRole} role
|
|
4007
|
+
* @returns {Promise<void>}
|
|
4008
|
+
* @throws {ConductorSdkError}
|
|
4009
|
+
*/
|
|
4010
|
+
addApplicationRole(applicationId: string, role: ApplicationRole): Promise<void>;
|
|
4011
|
+
/**
|
|
4012
|
+
* Delete an application
|
|
4013
|
+
* @param {string} applicationId
|
|
4014
|
+
* @returns {Promise<void>}
|
|
4015
|
+
* @throws {ConductorSdkError}
|
|
4016
|
+
*/
|
|
4017
|
+
deleteApplication(applicationId: string): Promise<void>;
|
|
4018
|
+
/**
|
|
4019
|
+
* Get an application by id
|
|
4020
|
+
* @param {string} applicationId
|
|
4021
|
+
* @returns {Promise<ExtendedConductorApplication>}
|
|
4022
|
+
* @throws {ConductorSdkError}
|
|
4023
|
+
*/
|
|
4024
|
+
getApplication(applicationId: string): Promise<ExtendedConductorApplication>;
|
|
4025
|
+
/**
|
|
4026
|
+
* Update an application
|
|
4027
|
+
* @param {string} applicationId
|
|
4028
|
+
* @param {string} newApplicationName
|
|
4029
|
+
* @returns {Promise<ExtendedConductorApplication>}
|
|
4030
|
+
* @throws {ConductorSdkError}
|
|
4031
|
+
*/
|
|
4032
|
+
updateApplication(applicationId: string, newApplicationName: string): Promise<ExtendedConductorApplication>;
|
|
4033
|
+
/**
|
|
4034
|
+
* Get application's access keys
|
|
4035
|
+
* @param {string} applicationId
|
|
4036
|
+
* @returns {Promise<AccessKeyInfo[]>}
|
|
4037
|
+
* @throws {ConductorSdkError}
|
|
4038
|
+
*/
|
|
4039
|
+
getAccessKeys(applicationId: string): Promise<AccessKeyInfo[]>;
|
|
4040
|
+
/**
|
|
4041
|
+
* Create an access key for an application
|
|
4042
|
+
* @param {string} applicationId
|
|
4043
|
+
* @returns {Promise<AccessKey>}
|
|
4044
|
+
* @throws {ConductorSdkError}
|
|
4045
|
+
*/
|
|
4046
|
+
createAccessKey(applicationId: string): Promise<AccessKey>;
|
|
4047
|
+
/**
|
|
4048
|
+
* Delete application tags
|
|
4049
|
+
* @param {string} applicationId
|
|
4050
|
+
* @param {Tag[]} tags
|
|
4051
|
+
* @returns {Promise<void>}
|
|
4052
|
+
* @throws {ConductorSdkError}
|
|
4053
|
+
*/
|
|
4054
|
+
deleteApplicationTags(applicationId: string, tags: Tag[]): Promise<void>;
|
|
4055
|
+
/**
|
|
4056
|
+
* Delete a single application tag
|
|
4057
|
+
* @param {string} applicationId
|
|
4058
|
+
* @param {Tag} tag
|
|
4059
|
+
* @returns {Promise<void>}
|
|
4060
|
+
* @throws {ConductorSdkError}
|
|
4061
|
+
*/
|
|
4062
|
+
deleteApplicationTag(applicationId: string, tag: Tag): Promise<void>;
|
|
4063
|
+
/**
|
|
4064
|
+
* Get application tags
|
|
4065
|
+
* @param {string} applicationId
|
|
4066
|
+
* @returns {Promise<Tag[]>}
|
|
4067
|
+
* @throws {ConductorSdkError}
|
|
4068
|
+
*/
|
|
4069
|
+
getApplicationTags(applicationId: string): Promise<Tag[]>;
|
|
4070
|
+
/**
|
|
4071
|
+
* Add application tags
|
|
4072
|
+
* @param {string} applicationId
|
|
4073
|
+
* @param {Tag[]} tags
|
|
4074
|
+
* @returns {Promise<void>}
|
|
4075
|
+
* @throws {ConductorSdkError}
|
|
4076
|
+
*/
|
|
4077
|
+
addApplicationTags(applicationId: string, tags: Tag[]): Promise<void>;
|
|
4078
|
+
/**
|
|
4079
|
+
* Add a single application tag
|
|
4080
|
+
* @param {string} applicationId
|
|
4081
|
+
* @param {Tag} tag
|
|
4082
|
+
* @returns {Promise<void>}
|
|
4083
|
+
* @throws {ConductorSdkError}
|
|
4084
|
+
*/
|
|
4085
|
+
addApplicationTag(applicationId: string, tag: Tag): Promise<void>;
|
|
4086
|
+
}
|
|
4087
|
+
|
|
3611
4088
|
interface OrkesApiConfig {
|
|
3612
4089
|
serverUrl?: string;
|
|
3613
4090
|
keyId?: string;
|
|
@@ -3827,4 +4304,4 @@ declare const orkesConductorClient: (config?: OrkesApiConfig, customFetch?: type
|
|
|
3827
4304
|
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
3828
4305
|
}>;
|
|
3829
4306
|
|
|
3830
|
-
export { type Action, ApiError, type ApiRequestOptions, type ApiResult, type Auth, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type ClientOptions, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, type Config, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, type EventHandler, type EventTaskDef, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type Middleware, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type QuerySerializerOptions, type RequestOptions, type RerunWorkflowRequest, type ResolvedRequestOptions, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type StreamEvent, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, completedTaskMatchingType, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, noopLogger, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|
|
4307
|
+
export { type AccessKey, type AccessKeyInfo, type Action, ApiError, type ApiRequestOptions, type ApiResult, ApplicationClient, type ApplicationRole, type Auth, BaseHttpRequest, CancelError, CancelablePromise, type CircuitBreakerTransitionResponse, type Client, type ClientOptions, type CommonTaskDef, type ConductorClient, type ConductorLogLevel, type ConductorLogger, ConductorSdkError, type ConductorWorker, type Config, type ConnectivityTestInput, type ConnectivityTestResult, Consistency, DefaultLogger, type DefaultLoggerConfig, type DoWhileTaskDef, type EnhancedSignalResponse, EventClient, type EventHandler, type EventMessage, type EventTaskDef, type ExtendedConductorApplication, type ExtendedEventExecution, type ExtendedTaskDef, type ExtendedWorkflowDef, type ExternalStorageLocation, type ForkJoinDynamicDef, type ForkJoinTaskDef, type GenerateTokenRequest, type HTScrollableSearchResultHumanTaskEntry, type HttpInputParameters, type HttpTaskDef, HumanExecutor, type HumanTaskAssignment, type HumanTaskDefinition, type HumanTaskEntry, type HumanTaskSearch, type HumanTaskSearchResult, type HumanTaskTemplate, type HumanTaskTrigger, type HumanTaskUser, type InlineTaskDef, type InlineTaskInputParameters, type JoinTaskDef, type JsonJQTransformTaskDef, type KafkaPublishInputParameters, type KafkaPublishTaskDef, MAX_RETRIES, MetadataClient, type Middleware, type OnCancel, type OpenAPIConfig, type OrkesApiConfig, type PollData, type ProtoRegistryEntry, type QuerySerializerOptions, type RequestOptions, type RerunWorkflowRequest, type ResolvedRequestOptions, type Response$1 as Response, ReturnStrategy, type RunnerArgs, type SaveScheduleRequest, SchedulerClient, type ScrollableSearchResultWorkflowSummary, type SearchResultHandledEventResponse, type SearchResultTask, type SearchResultTaskSummary, type SearchResultWorkflow, type SearchResultWorkflowScheduleExecutionModel, type SearchResultWorkflowSummary, type ServiceMethod, type ServiceRegistry, ServiceRegistryClient, ServiceType, type SetVariableTaskDef, type SignalResponse, type SimpleTaskDef, type SkipTaskRequest, type StartWorkflow, type StartWorkflowRequest, type StreamEvent, type SubWorkflowParams, type SubWorkflowTaskDef, type SwitchTaskDef, type Tag, type Task, TaskClient, type TaskDef, type TaskDefTypes, type TaskDetails, type TaskErrorHandler, type TaskExecLog, type TaskFinderPredicate, type TaskListSearchResultSummary, TaskManager, type TaskManagerConfig, type TaskManagerOptions, type TaskResult, type TaskResultOutputData, type TaskResultStatus, TaskResultStatusEnum, TaskRunner, type TaskRunnerOptions, type TaskSummary, TaskType, TemplateClient, type Terminate, type TerminateTaskDef, type TimeoutPolicy, type UserFormTemplate, type WaitTaskDef, type Workflow, type WorkflowDef$1 as WorkflowDef, WorkflowExecutor, type WorkflowRun, type WorkflowSchedule, type WorkflowScheduleExecutionModel, type WorkflowScheduleModel, type WorkflowStatus, type WorkflowSummary, type WorkflowTask, completedTaskMatchingType, conductorEventTask, doWhileTask, dynamicForkTask, eventTask, forkTask, forkTaskJoin, generate, generateDoWhileTask, generateEventTask, generateForkJoinTask, generateHTTPTask, generateInlineTask, generateJQTransformTask, generateJoinTask, generateKafkaPublishTask, generateSetVariableTask, generateSimpleTask, generateSubWorkflowTask, generateSwitchTask, generateTerminateTask, generateWaitTask, httpTask, inlineTask, joinTask, jsonJqTask, kafkaPublishTask, newLoopTask, noopErrorHandler, noopLogger, orkesConductorClient, setVariableTask, simpleTask, sqsEventTask, subWorkflowTask, switchTask, taskDefinition, taskGenMapper, terminateTask, waitTaskDuration, waitTaskUntil, workflow };
|