Package org.openapitools.client.api

Class DeviceApi

java.lang.Object
org.openapitools.client.api.DeviceApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-04-19T09:13:44.263607-05:00[America/Chicago]") @Component("org.openapitools.client.api.DeviceApi") public class DeviceApi extends Object

  • Constructor Details

    • DeviceApi

      public DeviceApi()

    • DeviceApi

      @Autowired public DeviceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateDevice

      public void activateDevice(String deviceId) throws org.springframework.web.client.RestClientException
      Activate a Device Activates a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • activateDeviceWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> activateDeviceWithHttpInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Activate a Device Activates a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deactivateDevice

      public void deactivateDevice(String deviceId) throws org.springframework.web.client.RestClientException
      Deactivate a Device Deactivates a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deactivateDeviceWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deactivateDeviceWithHttpInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Deactivate a Device Deactivates a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deleteDevice

      public void deleteDevice(String deviceId) throws org.springframework.web.client.RestClientException
      Delete a Device Deletes a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • deleteDeviceWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> deleteDeviceWithHttpInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Delete a Device Deletes a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getDevice

      public Device getDevice(String deviceId) throws org.springframework.web.client.RestClientException
      Retrieve a Device Retrieves a device by `deviceId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      Device
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getDeviceWithHttpInfo

      public org.springframework.http.ResponseEntity<Device> getDeviceWithHttpInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Retrieve a Device Retrieves a device by `deviceId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Device>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • getDeviceWithPaginationInfo

      public PagedList getDeviceWithPaginationInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Retrieve a Device Retrieves a device by `deviceId`

      200 - OK

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Device>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listDevices

      public List<Device> listDevices(String after, Integer limit, String search) throws org.springframework.web.client.RestClientException
      List all Devices Lists all devices with pagination support. A subset of Devices can be returned that match a supported search criteria using the `search` query parameter. Searches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request. > **Note:** Listing devices with `search` should not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss. `search` results may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object. <br> Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss. <br> Use an `id` lookup for records that you update to ensure your results contain the latest data. This operation equires [URL encoding](http://en.wikipedia.org/wiki/Percent-encoding). For example, `search=profile.displayName eq \"Bob\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.

      200 - OK

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return. (optional, default to 20)
      search - SCIM filter expression that filters the results. Searches include all Device `profile` properties, as well as the Device `id`, `status` and `lastUpdated` properties. (optional)
      Returns:
      List<Device>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listDevicesWithHttpInfo

      public org.springframework.http.ResponseEntity<List<Device>> listDevicesWithHttpInfo(String after, Integer limit, String search) throws org.springframework.web.client.RestClientException
      List all Devices Lists all devices with pagination support. A subset of Devices can be returned that match a supported search criteria using the `search` query parameter. Searches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request. > **Note:** Listing devices with `search` should not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss. `search` results may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object. <br> Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss. <br> Use an `id` lookup for records that you update to ensure your results contain the latest data. This operation equires [URL encoding](http://en.wikipedia.org/wiki/Percent-encoding). For example, `search=profile.displayName eq \"Bob\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.

      200 - OK

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return. (optional, default to 20)
      search - SCIM filter expression that filters the results. Searches include all Device `profile` properties, as well as the Device `id`, `status` and `lastUpdated` properties. (optional)
      Returns:
      ResponseEntity<List<Device>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • listDevicesWithPaginationInfo

      public PagedList listDevicesWithPaginationInfo(String after, Integer limit, String search) throws org.springframework.web.client.RestClientException
      List all Devices Lists all devices with pagination support. A subset of Devices can be returned that match a supported search criteria using the `search` query parameter. Searches for devices based on the properties specified in the `search` parameter conforming SCIM filter specifications (case-insensitive). This data is eventually consistent. The API returns different results depending on specified queries in the request. Empty list is returned if no objects match `search` request. > **Note:** Listing devices with `search` should not be used as a part of any critical flows—such as authentication or updates—to prevent potential data loss. `search` results may not reflect the latest information, as this endpoint uses a search index which may not be up-to-date with recent updates to the object. <br> Don't use search results directly for record updates, as the data might be stale and therefore overwrite newer data, resulting in data loss. <br> Use an `id` lookup for records that you update to ensure your results contain the latest data. This operation equires [URL encoding](http://en.wikipedia.org/wiki/Percent-encoding). For example, `search=profile.displayName eq \"Bob\"` is encoded as `search=profile.displayName%20eq%20%22Bob%22`.

      200 - OK

      403 - Forbidden

      429 - Too Many Requests

      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return. (optional, default to 20)
      search - SCIM filter expression that filters the results. Searches include all Device `profile` properties, as well as the Device `id`, `status` and `lastUpdated` properties. (optional)
      Returns:
      ResponseEntity<List<Device>>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • suspendDevice

      public void suspendDevice(String deviceId) throws org.springframework.web.client.RestClientException
      Suspend a Device Suspends a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • suspendDeviceWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> suspendDeviceWithHttpInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Suspend a Device Suspends a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • unsuspendDevice

      public void unsuspendDevice(String deviceId) throws org.springframework.web.client.RestClientException
      Unsuspend a Device Unsuspends a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

    • unsuspendDeviceWithHttpInfo

      public org.springframework.http.ResponseEntity<Void> unsuspendDeviceWithHttpInfo(String deviceId) throws org.springframework.web.client.RestClientException
      Unsuspend a Device Unsuspends a device by `deviceId`

      204 - No Content

      403 - Forbidden

      404 - Not Found

      429 - Too Many Requests

      Parameters:
      deviceId - `id` of the device (required)
      Returns:
      ResponseEntity<Void>
      Throws:
      org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API