Interface ScheduleServiceAsync
-
- All Implemented Interfaces:
public interface ScheduleServiceAsync
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceScheduleServiceAsync.WithRawResponseA view of ScheduleServiceAsync that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract ScheduleServiceAsync.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract BulkServiceAsyncbulk()CompletableFuture<List<Schedule>>create(ScheduleCreateParams params)Creates one or more schedules for a workflow with the specified recipients, timing, and data. abstract CompletableFuture<List<Schedule>>create(ScheduleCreateParams params, RequestOptions requestOptions)CompletableFuture<List<Schedule>>update(ScheduleUpdateParams params)Updates one or more existing schedules with new timing, data, or other properties. abstract CompletableFuture<List<Schedule>>update(ScheduleUpdateParams params, RequestOptions requestOptions)CompletableFuture<ScheduleListPageAsync>list(ScheduleListParams params)Returns a paginated list of schedules for the current environment, filtered by workflow and optionally by recipients and tenant. abstract CompletableFuture<ScheduleListPageAsync>list(ScheduleListParams params, RequestOptions requestOptions)CompletableFuture<List<Schedule>>delete(ScheduleDeleteParams params)Permanently deletes one or more schedules identified by the provided schedule IDs. abstract CompletableFuture<List<Schedule>>delete(ScheduleDeleteParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract ScheduleServiceAsync.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
bulk
abstract BulkServiceAsync bulk()
-
create
CompletableFuture<List<Schedule>> create(ScheduleCreateParams params)
Creates one or more schedules for a workflow with the specified recipients, timing, and data. Schedules can be one-time or recurring. This endpoint also handles /managing-recipients/identifying-recipients#inline-identifying-recipients for the
actor,recipient, andtenantfields.
-
create
abstract CompletableFuture<List<Schedule>> create(ScheduleCreateParams params, RequestOptions requestOptions)
-
update
CompletableFuture<List<Schedule>> update(ScheduleUpdateParams params)
Updates one or more existing schedules with new timing, data, or other properties. All specified schedule IDs will be updated with the same values. This endpoint also handles /managing-recipients/identifying-recipients#inline-identifying-recipients for the
actor,recipient, andtenantfields.
-
update
abstract CompletableFuture<List<Schedule>> update(ScheduleUpdateParams params, RequestOptions requestOptions)
-
list
CompletableFuture<ScheduleListPageAsync> list(ScheduleListParams params)
Returns a paginated list of schedules for the current environment, filtered by workflow and optionally by recipients and tenant.
-
list
abstract CompletableFuture<ScheduleListPageAsync> list(ScheduleListParams params, RequestOptions requestOptions)
-
delete
CompletableFuture<List<Schedule>> delete(ScheduleDeleteParams params)
Permanently deletes one or more schedules identified by the provided schedule IDs. This operation cannot be undone.
-
delete
abstract CompletableFuture<List<Schedule>> delete(ScheduleDeleteParams params, RequestOptions requestOptions)
-
-
-
-