Interface ScheduleService
-
- All Implemented Interfaces:
public interface ScheduleService
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceScheduleService.WithRawResponseA view of ScheduleService that provides access to raw HTTP responses for each method.
-
Method Summary
Modifier and Type Method Description abstract ScheduleService.WithRawResponsewithRawResponse()Returns a view of this service that provides access to raw HTTP responses for each method. abstract BulkServicebulk()List<Schedule>create(ScheduleCreateParams params)Creates one or more schedules for a workflow with the specified recipients, timing, and data. abstract List<Schedule>create(ScheduleCreateParams params, RequestOptions requestOptions)List<Schedule>update(ScheduleUpdateParams params)Updates one or more existing schedules with new timing, data, or other properties. abstract List<Schedule>update(ScheduleUpdateParams params, RequestOptions requestOptions)ScheduleListPagelist(ScheduleListParams params)Returns a paginated list of schedules for the current environment, filtered by workflow and optionally by recipients and tenant. abstract ScheduleListPagelist(ScheduleListParams params, RequestOptions requestOptions)List<Schedule>delete(ScheduleDeleteParams params)Permanently deletes one or more schedules identified by the provided schedule IDs. abstract List<Schedule>delete(ScheduleDeleteParams params, RequestOptions requestOptions)-
-
Method Detail
-
withRawResponse
abstract ScheduleService.WithRawResponse withRawResponse()
Returns a view of this service that provides access to raw HTTP responses for each method.
-
bulk
abstract BulkService bulk()
-
create
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 List<Schedule> create(ScheduleCreateParams params, RequestOptions requestOptions)
-
update
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 List<Schedule> update(ScheduleUpdateParams params, RequestOptions requestOptions)
-
list
ScheduleListPage list(ScheduleListParams params)
Returns a paginated list of schedules for the current environment, filtered by workflow and optionally by recipients and tenant.
-
list
abstract ScheduleListPage list(ScheduleListParams params, RequestOptions requestOptions)
-
delete
List<Schedule> delete(ScheduleDeleteParams params)
Permanently deletes one or more schedules identified by the provided schedule IDs. This operation cannot be undone.
-
delete
abstract List<Schedule> delete(ScheduleDeleteParams params, RequestOptions requestOptions)
-
-
-
-