com.genesys.internal.engagement.api

Class AvailabilityApi

java.lang.Object

com.genesys.internal.engagement.api.AvailabilityApi

public class AvailabilityApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AvailabilityApi()
AvailabilityApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
OpenForResponse200	openFor(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.lang.String timezone) Gets Office Open Duration.
com.squareup.okhttp.Call	openForAsync(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.lang.String timezone, ApiCallback<OpenForResponse200> callback) Gets Office Open Duration.
com.squareup.okhttp.Call	openForCall(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.lang.String timezone, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for openFor
ApiResponse<OpenForResponse200>	openForWithHttpInfo(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.lang.String timezone) Gets Office Open Duration.
AvailabilitiesResponse200	queryAvailabilityV2(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.math.BigDecimal startMS, java.math.BigDecimal numberOfDays, org.threeten.bp.OffsetDateTime end, java.math.BigDecimal endMS, java.lang.String timezone, java.math.BigDecimal maxTimeSlots, java.lang.Boolean reportBusy) Gets available time slots for a given queue.
com.squareup.okhttp.Call	queryAvailabilityV2Async(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.math.BigDecimal startMS, java.math.BigDecimal numberOfDays, org.threeten.bp.OffsetDateTime end, java.math.BigDecimal endMS, java.lang.String timezone, java.math.BigDecimal maxTimeSlots, java.lang.Boolean reportBusy, ApiCallback<AvailabilitiesResponse200> callback) Gets available time slots for a given queue.
com.squareup.okhttp.Call	queryAvailabilityV2Call(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.math.BigDecimal startMS, java.math.BigDecimal numberOfDays, org.threeten.bp.OffsetDateTime end, java.math.BigDecimal endMS, java.lang.String timezone, java.math.BigDecimal maxTimeSlots, java.lang.Boolean reportBusy, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for queryAvailabilityV2
ApiResponse<AvailabilitiesResponse200>	queryAvailabilityV2WithHttpInfo(java.lang.String xApiKey, java.lang.String serviceName, org.threeten.bp.OffsetDateTime start, java.math.BigDecimal startMS, java.math.BigDecimal numberOfDays, org.threeten.bp.OffsetDateTime end, java.math.BigDecimal endMS, java.lang.String timezone, java.math.BigDecimal maxTimeSlots, java.lang.Boolean reportBusy) Gets available time slots for a given queue.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

AvailabilityApi

public AvailabilityApi()

AvailabilityApi

public AvailabilityApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

openForCall

public com.squareup.okhttp.Call openForCall(java.lang.String xApiKey,
                                            java.lang.String serviceName,
                                            org.threeten.bp.OffsetDateTime start,
                                            java.lang.String timezone,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for openFor

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as timezone: YYYY-MM-ddTHH:mm:ssZ. If not specified, the start date is assumed to be now. (optional)

timezone - Timezone to use if start and/or end time are not specified in any specific timezone. For a list of possible values, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

openFor

public OpenForResponse200 openFor(java.lang.String xApiKey,
                                  java.lang.String serviceName,
                                  org.threeten.bp.OffsetDateTime start,
                                  java.lang.String timezone)
                           throws ApiException

Gets Office Open Duration. Retrieves how long the office will stay open in seconds.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as timezone: YYYY-MM-ddTHH:mm:ssZ. If not specified, the start date is assumed to be now. (optional)

timezone - Timezone to use if start and/or end time are not specified in any specific timezone. For a list of possible values, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

Returns:

OpenForResponse200

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

openForWithHttpInfo

public ApiResponse<OpenForResponse200> openForWithHttpInfo(java.lang.String xApiKey,
                                                           java.lang.String serviceName,
                                                           org.threeten.bp.OffsetDateTime start,
                                                           java.lang.String timezone)
                                                    throws ApiException

Gets Office Open Duration. Retrieves how long the office will stay open in seconds.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as timezone: YYYY-MM-ddTHH:mm:ssZ. If not specified, the start date is assumed to be now. (optional)

timezone - Timezone to use if start and/or end time are not specified in any specific timezone. For a list of possible values, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

Returns:

ApiResponse<OpenForResponse200>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

openForAsync

public com.squareup.okhttp.Call openForAsync(java.lang.String xApiKey,
                                             java.lang.String serviceName,
                                             org.threeten.bp.OffsetDateTime start,
                                             java.lang.String timezone,
                                             ApiCallback<OpenForResponse200> callback)
                                      throws ApiException

Gets Office Open Duration. (asynchronously) Retrieves how long the office will stay open in seconds.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as timezone: YYYY-MM-ddTHH:mm:ssZ. If not specified, the start date is assumed to be now. (optional)

timezone - Timezone to use if start and/or end time are not specified in any specific timezone. For a list of possible values, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

queryAvailabilityV2Call

public com.squareup.okhttp.Call queryAvailabilityV2Call(java.lang.String xApiKey,
                                                        java.lang.String serviceName,
                                                        org.threeten.bp.OffsetDateTime start,
                                                        java.math.BigDecimal startMS,
                                                        java.math.BigDecimal numberOfDays,
                                                        org.threeten.bp.OffsetDateTime end,
                                                        java.math.BigDecimal endMS,
                                                        java.lang.String timezone,
                                                        java.math.BigDecimal maxTimeSlots,
                                                        java.lang.Boolean reportBusy,
                                                        ProgressResponseBody.ProgressListener progressListener,
                                                        ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                 throws ApiException

Build call for queryAvailabilityV2

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as the timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If not specified, the start date is assumed to be now. (optional)

startMS - Start date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). You must also set the endMS or numberOfDays parameter; otherwise, the end date is assumed to be the startMS date. If you set the startMS parameter, do not set the start or timestamp parameters. (optional)

numberOfDays - Used as an alternative to the end date. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

end - End date in ISO 8601 format, using UTC as timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

endMS - End date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). Set only one of the end, endMS, or numberOfDays parameters. (optional)

timezone - Timezone for the start and end date parameters. If not specified, the default is UTC. Additionally, the response object will return the localTime fields formatted in this timezone. For a list of possible values, see the TZ column of the list in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

maxTimeSlots - Maximum number of time slots to include in the response when the office is open and its capacity is above zero. Use this parameter to improve the performance of the query over a long period of time. (optional)

reportBusy - If true, the response includes the slots where the office is open and where callbacks are booked to full capacity. By default, reportBusy is false. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

queryAvailabilityV2

public AvailabilitiesResponse200 queryAvailabilityV2(java.lang.String xApiKey,
                                                     java.lang.String serviceName,
                                                     org.threeten.bp.OffsetDateTime start,
                                                     java.math.BigDecimal startMS,
                                                     java.math.BigDecimal numberOfDays,
                                                     org.threeten.bp.OffsetDateTime end,
                                                     java.math.BigDecimal endMS,
                                                     java.lang.String timezone,
                                                     java.math.BigDecimal maxTimeSlots,
                                                     java.lang.Boolean reportBusy)
                                              throws ApiException

Gets available time slots for a given queue. Retrieves a map of slots in which the office capacity is not full.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as the timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If not specified, the start date is assumed to be now. (optional)

startMS - Start date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). You must also set the endMS or numberOfDays parameter; otherwise, the end date is assumed to be the startMS date. If you set the startMS parameter, do not set the start or timestamp parameters. (optional)

numberOfDays - Used as an alternative to the end date. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

end - End date in ISO 8601 format, using UTC as timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

endMS - End date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). Set only one of the end, endMS, or numberOfDays parameters. (optional)

timezone - Timezone for the start and end date parameters. If not specified, the default is UTC. Additionally, the response object will return the localTime fields formatted in this timezone. For a list of possible values, see the TZ column of the list in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

maxTimeSlots - Maximum number of time slots to include in the response when the office is open and its capacity is above zero. Use this parameter to improve the performance of the query over a long period of time. (optional)

reportBusy - If true, the response includes the slots where the office is open and where callbacks are booked to full capacity. By default, reportBusy is false. (optional)

Returns:

AvailabilitiesResponse200

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

queryAvailabilityV2WithHttpInfo

public ApiResponse<AvailabilitiesResponse200> queryAvailabilityV2WithHttpInfo(java.lang.String xApiKey,
                                                                              java.lang.String serviceName,
                                                                              org.threeten.bp.OffsetDateTime start,
                                                                              java.math.BigDecimal startMS,
                                                                              java.math.BigDecimal numberOfDays,
                                                                              org.threeten.bp.OffsetDateTime end,
                                                                              java.math.BigDecimal endMS,
                                                                              java.lang.String timezone,
                                                                              java.math.BigDecimal maxTimeSlots,
                                                                              java.lang.Boolean reportBusy)
                                                                       throws ApiException

Gets available time slots for a given queue. Retrieves a map of slots in which the office capacity is not full.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as the timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If not specified, the start date is assumed to be now. (optional)

startMS - Start date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). You must also set the endMS or numberOfDays parameter; otherwise, the end date is assumed to be the startMS date. If you set the startMS parameter, do not set the start or timestamp parameters. (optional)

numberOfDays - Used as an alternative to the end date. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

end - End date in ISO 8601 format, using UTC as timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

endMS - End date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). Set only one of the end, endMS, or numberOfDays parameters. (optional)

timezone - Timezone for the start and end date parameters. If not specified, the default is UTC. Additionally, the response object will return the localTime fields formatted in this timezone. For a list of possible values, see the TZ column of the list in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

maxTimeSlots - Maximum number of time slots to include in the response when the office is open and its capacity is above zero. Use this parameter to improve the performance of the query over a long period of time. (optional)

reportBusy - If true, the response includes the slots where the office is open and where callbacks are booked to full capacity. By default, reportBusy is false. (optional)

Returns:

ApiResponse<AvailabilitiesResponse200>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

queryAvailabilityV2Async

public com.squareup.okhttp.Call queryAvailabilityV2Async(java.lang.String xApiKey,
                                                         java.lang.String serviceName,
                                                         org.threeten.bp.OffsetDateTime start,
                                                         java.math.BigDecimal startMS,
                                                         java.math.BigDecimal numberOfDays,
                                                         org.threeten.bp.OffsetDateTime end,
                                                         java.math.BigDecimal endMS,
                                                         java.lang.String timezone,
                                                         java.math.BigDecimal maxTimeSlots,
                                                         java.lang.Boolean reportBusy,
                                                         ApiCallback<AvailabilitiesResponse200> callback)
                                                  throws ApiException

Gets available time slots for a given queue. (asynchronously) Retrieves a map of slots in which the office capacity is not full.

Parameters:

xApiKey - API Key. For example, Z2y9eiTiQZ4ceKNpxy1YAarhpvxJXPCj4rFrbVep (required)

serviceName - Name of the callback execution service provisioned in GES. (required)

start - Start date in ISO 8601 format, using UTC as the timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If not specified, the start date is assumed to be now. (optional)

startMS - Start date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). You must also set the endMS or numberOfDays parameter; otherwise, the end date is assumed to be the startMS date. If you set the startMS parameter, do not set the start or timestamp parameters. (optional)

numberOfDays - Used as an alternative to the end date. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

end - End date in ISO 8601 format, using UTC as timezone: yyyy-MM-ddTHH:mm:ss.SSSZ. If neither end nor numberOfDays is specified, the end date is assumed to be the start date. (optional)

endMS - End date in epoch time, that is, the number of milliseconds since 00:00:00, Thursday, 1 January 1970 (UTC). Set only one of the end, endMS, or numberOfDays parameters. (optional)

timezone - Timezone for the start and end date parameters. If not specified, the default is UTC. Additionally, the response object will return the localTime fields formatted in this timezone. For a list of possible values, see the TZ column of the list in https://en.wikipedia.org/wiki/List_of_tz_database_time_zones (optional)

maxTimeSlots - Maximum number of time slots to include in the response when the office is open and its capacity is above zero. Use this parameter to improve the performance of the query over a long period of time. (optional)

reportBusy - If true, the response includes the slots where the office is open and where callbacks are booked to full capacity. By default, reportBusy is false. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object