com.bookeo.api.service

Class ResourceBlocksApi

java.lang.Object

com.bookeo.api.service.ResourceBlocksApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-03T18:48:57.986-05:00")
public class ResourceBlocksApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ResourceBlocksApi()
ResourceBlocksApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
ResourceBlocksList	resourceblocksGet(Date startTime, Date endTime, Date lastUpdatedStartTime, Date lastUpdatedEndTime, String resourceId, Integer itemsPerPage, String pageNavigationToken, Integer pageNumber) Retrieve resource blocks Retrieve existing resource blocks\n The result is limited by the permissions of the apiKey.\n <p/>\n It is possible to filter by time blocked and/or time of the last change.\n To filter by time blocked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time.
void	resourceblocksIdDelete(String id) Delete a block
ResourceBlock	resourceblocksIdGet(String id) Retrieve a block Retrieve a block by its id
void	resourceblocksIdPut(ResourceBlock block, String id) Update an existing block A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.
void	resourceblocksPost(ResourceBlock block) Create a new resource block \"blocks\" time for one or more resources, so that they're not available for booking.\n A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceBlocksApi

public ResourceBlocksApi()

ResourceBlocksApi

public ResourceBlocksApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

resourceblocksGet

public ResourceBlocksList resourceblocksGet(Date startTime,
                                            Date endTime,
                                            Date lastUpdatedStartTime,
                                            Date lastUpdatedEndTime,
                                            String resourceId,
                                            Integer itemsPerPage,
                                            String pageNavigationToken,
                                            Integer pageNumber)
                                     throws ApiException

Retrieve resource blocks Retrieve existing resource blocks\n The result is limited by the permissions of the apiKey.\n <p/>\n It is possible to filter by time blocked and/or time of the last change.\n To filter by time blocked, the parameters startTime and endTime are required.\n To filter by last time changed, the parameters lastUpdatedStartTime and lastUpdatedEndTime are required.\n It is possible to filter by both at the same time. At least one of the two filters must be used.\n <p/>\n It is further possible to filter by resource.

Parameters:

startTime - if specified, only include blocks that start on or after this time. If specified, endTime must be specified as well.

endTime - if specified, only include blocks that start on or before this time. If specified, startTime must be specified as well. The maximum allowed interval is 31 days.

lastUpdatedStartTime - if specified, only include blocks that were last changed (or created) on or after this time. If specified, lastUpdatedEndTime must be specified as well.

lastUpdatedEndTime - if specified, only include blocks that were last changed (or created) on or before this time. If specified, lastUpdatedStartTime must be specified as well. The maximum allowed interval is 31 days.

resourceId - if specified, only include blocks that affect this resource

itemsPerPage - maximum: 100

pageNavigationToken -

pageNumber -

Returns:

ResourceBlocksList

Throws:

ApiException

resourceblocksPost

public void resourceblocksPost(ResourceBlock block)
                        throws ApiException

Create a new resource block \"blocks\" time for one or more resources, so that they're not available for booking.\n A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.

Parameters:

block -

Throws:

ApiException

resourceblocksIdGet

public ResourceBlock resourceblocksIdGet(String id)
                                  throws ApiException

Retrieve a block Retrieve a block by its id

Parameters:

id -

Returns:

ResourceBlock

Throws:

ApiException

resourceblocksIdPut

public void resourceblocksIdPut(ResourceBlock block,
                                String id)
                         throws ApiException

Update an existing block A resource block must be for at least one resource, but it can block more than one.\n When setting the resources in the block, only the id is required.

Parameters:

block -

id -

Throws:

ApiException

resourceblocksIdDelete

public void resourceblocksIdDelete(String id)
                            throws ApiException

Delete a block

Parameters:

id -

Throws:

ApiException