Package io.moov.sdk

Class Scheduling

java.lang.Object

io.moov.sdk.Scheduling

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallCancelSchedule, SDKMethodInterfaces.MethodCallCreateSchedule, SDKMethodInterfaces.MethodCallGetScheduledOccurrence, SDKMethodInterfaces.MethodCallGetSchedules, SDKMethodInterfaces.MethodCallListSchedules, SDKMethodInterfaces.MethodCallUpdateSchedule

public class Scheduling
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallCreateSchedule, SDKMethodInterfaces.MethodCallListSchedules, SDKMethodInterfaces.MethodCallUpdateSchedule, SDKMethodInterfaces.MethodCallGetSchedules, SDKMethodInterfaces.MethodCallCancelSchedule, SDKMethodInterfaces.MethodCallGetScheduledOccurrence

Method Summary

Modifier and Type	Method	Description
CancelScheduleRequestBuilder	cancel()	Describes the schedule to cancel.
CancelScheduleResponse	cancel(java.lang.String accountID, java.lang.String scheduleID)	Describes the schedule to cancel.
CancelScheduleResponse	cancel(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String scheduleID)	Describes the schedule to cancel.
CreateScheduleRequestBuilder	create()	Describes the schedule to create or modify.
CreateScheduleResponse	create(java.lang.String accountID, UpsertSchedule upsertSchedule)	Describes the schedule to create or modify.
CreateScheduleResponse	create(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, UpsertSchedule upsertSchedule)	Describes the schedule to create or modify.
GetSchedulesRequestBuilder	get()	Describes a schedule associated with an account.
GetSchedulesResponse	get(java.lang.String accountID, java.lang.String scheduleID)	Describes a schedule associated with an account.
GetSchedulesResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String scheduleID)	Describes a schedule associated with an account.
GetScheduledOccurrenceRequestBuilder	getOccurrance()	Gets a specific occurrence.
GetScheduledOccurrenceResponse	getOccurrance(java.lang.String accountID, java.lang.String scheduleID, java.lang.String occurrenceFilter)	Gets a specific occurrence.
GetScheduledOccurrenceResponse	getOccurrance(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String scheduleID, java.lang.String occurrenceFilter)	Gets a specific occurrence.
ListSchedulesRequestBuilder	list()	Describes a list of schedules associated with an account.
ListSchedulesResponse	list(ListSchedulesRequest request)	Describes a list of schedules associated with an account.
UpdateScheduleRequestBuilder	update()	Describes the schedule to modify.
UpdateScheduleResponse	update(java.lang.String accountID, java.lang.String scheduleID, UpsertSchedule upsertSchedule)	Describes the schedule to modify.
UpdateScheduleResponse	update(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String accountID, java.lang.String scheduleID, UpsertSchedule upsertSchedule)	Describes the schedule to modify.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public CreateScheduleRequestBuilder create()

Describes the schedule to create or modify.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

create

public CreateScheduleResponse create(java.lang.String accountID,
                                     UpsertSchedule upsertSchedule)
                              throws java.lang.Exception

Describes the schedule to create or modify.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

accountID -

upsertSchedule -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

create

public CreateScheduleResponse create(java.util.Optional<java.lang.String> xMoovVersion,
                                     java.lang.String accountID,
                                     UpsertSchedule upsertSchedule)
                              throws java.lang.Exception

Describes the schedule to create or modify.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Specified by:

create in interface SDKMethodInterfaces.MethodCallCreateSchedule

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

upsertSchedule -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

list

public ListSchedulesRequestBuilder list()

Describes a list of schedules associated with an account. Append the `hydrate=accounts` query parameter to include partial account details in the response.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

list

public ListSchedulesResponse list(ListSchedulesRequest request)
                           throws java.lang.Exception

Describes a list of schedules associated with an account. Append the `hydrate=accounts` query parameter to include partial account details in the response.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Specified by:

list in interface SDKMethodInterfaces.MethodCallListSchedules

Parameters:

request - The request object containing all of the parameters for the API call.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateScheduleRequestBuilder update()

Describes the schedule to modify.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

update

public UpdateScheduleResponse update(java.lang.String accountID,
                                     java.lang.String scheduleID,
                                     UpsertSchedule upsertSchedule)
                              throws java.lang.Exception

Describes the schedule to modify.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

accountID -

scheduleID -

upsertSchedule -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

update

public UpdateScheduleResponse update(java.util.Optional<java.lang.String> xMoovVersion,
                                     java.lang.String accountID,
                                     java.lang.String scheduleID,
                                     UpsertSchedule upsertSchedule)
                              throws java.lang.Exception

Describes the schedule to modify.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Specified by:

update in interface SDKMethodInterfaces.MethodCallUpdateSchedule

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

scheduleID -

upsertSchedule -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetSchedulesRequestBuilder get()

Describes a schedule associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

get

public GetSchedulesResponse get(java.lang.String accountID,
                                java.lang.String scheduleID)
                         throws java.lang.Exception

Describes a schedule associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

accountID -

scheduleID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetSchedulesResponse get(java.util.Optional<java.lang.String> xMoovVersion,
                                java.lang.String accountID,
                                java.lang.String scheduleID)
                         throws java.lang.Exception

Describes a schedule associated with an account. Requires at least 1 occurrence or recurTransfer to be specified.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetSchedules

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

scheduleID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

cancel

public CancelScheduleRequestBuilder cancel()

Describes the schedule to cancel.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Returns:

The call builder

cancel

public CancelScheduleResponse cancel(java.lang.String accountID,
                                     java.lang.String scheduleID)
                              throws java.lang.Exception

Describes the schedule to cancel.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Parameters:

accountID -

scheduleID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

cancel

public CancelScheduleResponse cancel(java.util.Optional<java.lang.String> xMoovVersion,
                                     java.lang.String accountID,
                                     java.lang.String scheduleID)
                              throws java.lang.Exception

Describes the schedule to cancel.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.write` scope.

Specified by:

cancel in interface SDKMethodInterfaces.MethodCallCancelSchedule

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

scheduleID -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getOccurrance

public GetScheduledOccurrenceRequestBuilder getOccurrance()

Gets a specific occurrence.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Returns:

The call builder

getOccurrance

public GetScheduledOccurrenceResponse getOccurrance(java.lang.String accountID,
                                                    java.lang.String scheduleID,
                                                    java.lang.String occurrenceFilter)
                                             throws java.lang.Exception

Gets a specific occurrence.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Parameters:

accountID -

scheduleID -

occurrenceFilter - Allows the specification of additional filters beyond the UUID. Specifying a UUID string returns the exact occurrence. Specifying a RFC 3339 timestamp returns the latest occurrence at or before that timestamp. Specifying `latest` returns the latest occurrence at or before now.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

getOccurrance

public GetScheduledOccurrenceResponse getOccurrance(java.util.Optional<java.lang.String> xMoovVersion,
                                                    java.lang.String accountID,
                                                    java.lang.String scheduleID,
                                                    java.lang.String occurrenceFilter)
                                             throws java.lang.Exception

Gets a specific occurrence.

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/accounts/{accountID}/transfers.read` scope.

Specified by:

getOccurrance in interface SDKMethodInterfaces.MethodCallGetScheduledOccurrence

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

accountID -

scheduleID -

occurrenceFilter - Allows the specification of additional filters beyond the UUID. Specifying a UUID string returns the exact occurrence. Specifying a RFC 3339 timestamp returns the latest occurrence at or before that timestamp. Specifying `latest` returns the latest occurrence at or before now.

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails