InventoryDevicesApi
InventoryDevicesApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getOrganizationInventoryDevice() : object
- Operation getOrganizationInventoryDevice
- getOrganizationInventoryDeviceAsync() : PromiseInterface
- Operation getOrganizationInventoryDeviceAsync
- getOrganizationInventoryDeviceAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationInventoryDeviceAsyncWithHttpInfo
- getOrganizationInventoryDevices() : object
- Operation getOrganizationInventoryDevices
- getOrganizationInventoryDevicesAsync() : PromiseInterface
- Operation getOrganizationInventoryDevicesAsync
- getOrganizationInventoryDevicesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationInventoryDevicesAsyncWithHttpInfo
- getOrganizationInventoryDevicesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationInventoryDevicesWithHttpInfo
- getOrganizationInventoryDeviceWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationInventoryDeviceWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getOrganizationInventoryDeviceRequest() : Request
- Create request for operation 'getOrganizationInventoryDevice'
- getOrganizationInventoryDevicesRequest() : Request
- Create request for operation 'getOrganizationInventoryDevices'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getOrganizationInventoryDevice()
Operation getOrganizationInventoryDevice
public
getOrganizationInventoryDevice(string $organization_id, string $serial) : object
Return a single device from the inventory of an organization
Parameters
- $organization_id : string
-
organization_id (required)
- $serial : string
-
serial (required)
Tags
Return values
object —getOrganizationInventoryDeviceAsync()
Operation getOrganizationInventoryDeviceAsync
public
getOrganizationInventoryDeviceAsync(string $organization_id, string $serial) : PromiseInterface
Return a single device from the inventory of an organization
Parameters
- $organization_id : string
-
(required)
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationInventoryDeviceAsyncWithHttpInfo()
Operation getOrganizationInventoryDeviceAsyncWithHttpInfo
public
getOrganizationInventoryDeviceAsyncWithHttpInfo(string $organization_id, string $serial) : PromiseInterface
Return a single device from the inventory of an organization
Parameters
- $organization_id : string
-
(required)
- $serial : string
-
(required)
Tags
Return values
PromiseInterface —getOrganizationInventoryDevices()
Operation getOrganizationInventoryDevices
public
getOrganizationInventoryDevices(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $used_state = null ][, string $search = null ]) : object
Return the device inventory for an organization
Parameters
- $organization_id : string
-
organization_id (required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $used_state : string = null
-
Filter results by used or unused inventory. Accepted values are "used" or "unused". (optional)
- $search : string = null
-
Search for devices in inventory based on serial number, mac address, or model. (optional)
Tags
Return values
object —getOrganizationInventoryDevicesAsync()
Operation getOrganizationInventoryDevicesAsync
public
getOrganizationInventoryDevicesAsync(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $used_state = null ][, string $search = null ]) : PromiseInterface
Return the device inventory for an organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $used_state : string = null
-
Filter results by used or unused inventory. Accepted values are "used" or "unused". (optional)
- $search : string = null
-
Search for devices in inventory based on serial number, mac address, or model. (optional)
Tags
Return values
PromiseInterface —getOrganizationInventoryDevicesAsyncWithHttpInfo()
Operation getOrganizationInventoryDevicesAsyncWithHttpInfo
public
getOrganizationInventoryDevicesAsyncWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $used_state = null ][, string $search = null ]) : PromiseInterface
Return the device inventory for an organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $used_state : string = null
-
Filter results by used or unused inventory. Accepted values are "used" or "unused". (optional)
- $search : string = null
-
Search for devices in inventory based on serial number, mac address, or model. (optional)
Tags
Return values
PromiseInterface —getOrganizationInventoryDevicesWithHttpInfo()
Operation getOrganizationInventoryDevicesWithHttpInfo
public
getOrganizationInventoryDevicesWithHttpInfo(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $used_state = null ][, string $search = null ]) : array<string|int, mixed>
Return the device inventory for an organization
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $used_state : string = null
-
Filter results by used or unused inventory. Accepted values are "used" or "unused". (optional)
- $search : string = null
-
Search for devices in inventory based on serial number, mac address, or model. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getOrganizationInventoryDeviceWithHttpInfo()
Operation getOrganizationInventoryDeviceWithHttpInfo
public
getOrganizationInventoryDeviceWithHttpInfo(string $organization_id, string $serial) : array<string|int, mixed>
Return a single device from the inventory of an organization
Parameters
- $organization_id : string
-
(required)
- $serial : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getOrganizationInventoryDeviceRequest()
Create request for operation 'getOrganizationInventoryDevice'
protected
getOrganizationInventoryDeviceRequest(string $organization_id, string $serial) : Request
Parameters
- $organization_id : string
-
(required)
- $serial : string
-
(required)
Tags
Return values
Request —getOrganizationInventoryDevicesRequest()
Create request for operation 'getOrganizationInventoryDevices'
protected
getOrganizationInventoryDevicesRequest(string $organization_id[, int $per_page = null ][, string $starting_after = null ][, string $ending_before = null ][, string $used_state = null ][, string $search = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $per_page : int = null
-
The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (optional)
- $starting_after : string = null
-
A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $ending_before : string = null
-
A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. (optional)
- $used_state : string = null
-
Filter results by used or unused inventory. Accepted values are "used" or "unused". (optional)
- $search : string = null
-
Search for devices in inventory based on serial number, mac address, or model. (optional)