Package io.voucherify.client.api

Class LocationsApi

java.lang.Object
io.voucherify.client.api.LocationsApi
public class LocationsApi extends Object

  • Constructor Details

    • LocationsApi

      public LocationsApi()

    • LocationsApi

      public LocationsApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • getLocationCall

      public okhttp3.Call getLocationCall(String locationId, ApiCallback _callback) throws ApiException
      Build call for getLocation
      Parameters:
      locationId - The unique location ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • getLocation

      public LocationsGetResponseBody getLocation(String locationId) throws ApiException
      Get Location Returns a location object.
      Parameters:
      locationId - The unique location ID. (required)
      Returns:
      LocationsGetResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getLocationWithHttpInfo

      public ApiResponse<LocationsGetResponseBody> getLocationWithHttpInfo(String locationId) throws ApiException
      Get Location Returns a location object.
      Parameters:
      locationId - The unique location ID. (required)
      Returns:
      ApiResponse<LocationsGetResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • getLocationAsync

      public okhttp3.Call getLocationAsync(String locationId, ApiCallback<LocationsGetResponseBody> _callback) throws ApiException
      Get Location (asynchronously) Returns a location object.
      Parameters:
      locationId - The unique location ID. (required)
      _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

    • listLocationsCall

      public okhttp3.Call listLocationsCall(Integer limit, ParameterOrderListLocations order, ParameterFiltersListLocations filters, OffsetDateTime endDate, ApiCallback _callback) throws ApiException
      Build call for listLocations
      Parameters:
      limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      filters - Filter the locations using one of the available filters. (optional)
      endDate - A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object

    • listLocations

      public LocationsListResponseBody listLocations(Integer limit, ParameterOrderListLocations order, ParameterFiltersListLocations filters, OffsetDateTime endDate) throws ApiException
      List Locations Returns a list of your locations.
      Parameters:
      limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      filters - Filter the locations using one of the available filters. (optional)
      endDate - A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (optional)
      Returns:
      LocationsListResponseBody
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLocationsWithHttpInfo

      public ApiResponse<LocationsListResponseBody> listLocationsWithHttpInfo(Integer limit, ParameterOrderListLocations order, ParameterFiltersListLocations filters, OffsetDateTime endDate) throws ApiException
      List Locations Returns a list of your locations.
      Parameters:
      limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      filters - Filter the locations using one of the available filters. (optional)
      endDate - A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (optional)
      Returns:
      ApiResponse<LocationsListResponseBody>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

    • listLocationsAsync

      public okhttp3.Call listLocationsAsync(Integer limit, ParameterOrderListLocations order, ParameterFiltersListLocations filters, OffsetDateTime endDate, ApiCallback<LocationsListResponseBody> _callback) throws ApiException
      List Locations (asynchronously) Returns a list of your locations.
      Parameters:
      limit - Limits the number of objects to be returned. The limit can range between 1 and 100 items. If no limit is set, it returns 10 items. (optional)
      order - Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order. (optional)
      filters - Filter the locations using one of the available filters. (optional)
      endDate - A filter on the list based on the end date. This will filter out all locations whose end date falls before the specified date and time. A date value must be presented in the ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). (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