OnboardingApi
OnboardingApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getOrganizationCameraOnboardingStatuses() : object
- Operation getOrganizationCameraOnboardingStatuses
- getOrganizationCameraOnboardingStatusesAsync() : PromiseInterface
- Operation getOrganizationCameraOnboardingStatusesAsync
- getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo
- getOrganizationCameraOnboardingStatusesWithHttpInfo() : array<string|int, mixed>
- Operation getOrganizationCameraOnboardingStatusesWithHttpInfo
- updateOrganizationCameraOnboardingStatuses() : object
- Operation updateOrganizationCameraOnboardingStatuses
- updateOrganizationCameraOnboardingStatusesAsync() : PromiseInterface
- Operation updateOrganizationCameraOnboardingStatusesAsync
- updateOrganizationCameraOnboardingStatusesAsyncWithHttpInfo() : PromiseInterface
- Operation updateOrganizationCameraOnboardingStatusesAsyncWithHttpInfo
- updateOrganizationCameraOnboardingStatusesWithHttpInfo() : array<string|int, mixed>
- Operation updateOrganizationCameraOnboardingStatusesWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getOrganizationCameraOnboardingStatusesRequest() : Request
- Create request for operation 'getOrganizationCameraOnboardingStatuses'
- updateOrganizationCameraOnboardingStatusesRequest() : Request
- Create request for operation 'updateOrganizationCameraOnboardingStatuses'
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 —getOrganizationCameraOnboardingStatuses()
Operation getOrganizationCameraOnboardingStatuses
public
getOrganizationCameraOnboardingStatuses(string $organization_id[, array<string|int, string> $serials = null ][, array<string|int, string> $network_ids = null ]) : object
Fetch onboarding status of cameras
Parameters
- $organization_id : string
-
organization_id (required)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned cameras will be filtered to only include these serials. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned cameras will be filtered to only include these networks. (optional)
Tags
Return values
object —getOrganizationCameraOnboardingStatusesAsync()
Operation getOrganizationCameraOnboardingStatusesAsync
public
getOrganizationCameraOnboardingStatusesAsync(string $organization_id[, array<string|int, string> $serials = null ][, array<string|int, string> $network_ids = null ]) : PromiseInterface
Fetch onboarding status of cameras
Parameters
- $organization_id : string
-
(required)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned cameras will be filtered to only include these serials. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned cameras will be filtered to only include these networks. (optional)
Tags
Return values
PromiseInterface —getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo()
Operation getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo
public
getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo(string $organization_id[, array<string|int, string> $serials = null ][, array<string|int, string> $network_ids = null ]) : PromiseInterface
Fetch onboarding status of cameras
Parameters
- $organization_id : string
-
(required)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned cameras will be filtered to only include these serials. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned cameras will be filtered to only include these networks. (optional)
Tags
Return values
PromiseInterface —getOrganizationCameraOnboardingStatusesWithHttpInfo()
Operation getOrganizationCameraOnboardingStatusesWithHttpInfo
public
getOrganizationCameraOnboardingStatusesWithHttpInfo(string $organization_id[, array<string|int, string> $serials = null ][, array<string|int, string> $network_ids = null ]) : array<string|int, mixed>
Fetch onboarding status of cameras
Parameters
- $organization_id : string
-
(required)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned cameras will be filtered to only include these serials. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned cameras will be filtered to only include these networks. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
updateOrganizationCameraOnboardingStatuses()
Operation updateOrganizationCameraOnboardingStatuses
public
updateOrganizationCameraOnboardingStatuses(string $organization_id[, UpdateOrganizationCameraOnboardingStatuses $update_organization_camera_onboarding_statuses = null ]) : object
Notify that credential handoff to camera has completed
Parameters
- $organization_id : string
-
organization_id (required)
- $update_organization_camera_onboarding_statuses : UpdateOrganizationCameraOnboardingStatuses = null
-
update_organization_camera_onboarding_statuses (optional)
Tags
Return values
object —updateOrganizationCameraOnboardingStatusesAsync()
Operation updateOrganizationCameraOnboardingStatusesAsync
public
updateOrganizationCameraOnboardingStatusesAsync(string $organization_id[, UpdateOrganizationCameraOnboardingStatuses $update_organization_camera_onboarding_statuses = null ]) : PromiseInterface
Notify that credential handoff to camera has completed
Parameters
- $organization_id : string
-
(required)
- $update_organization_camera_onboarding_statuses : UpdateOrganizationCameraOnboardingStatuses = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationCameraOnboardingStatusesAsyncWithHttpInfo()
Operation updateOrganizationCameraOnboardingStatusesAsyncWithHttpInfo
public
updateOrganizationCameraOnboardingStatusesAsyncWithHttpInfo(string $organization_id[, UpdateOrganizationCameraOnboardingStatuses $update_organization_camera_onboarding_statuses = null ]) : PromiseInterface
Notify that credential handoff to camera has completed
Parameters
- $organization_id : string
-
(required)
- $update_organization_camera_onboarding_statuses : UpdateOrganizationCameraOnboardingStatuses = null
-
(optional)
Tags
Return values
PromiseInterface —updateOrganizationCameraOnboardingStatusesWithHttpInfo()
Operation updateOrganizationCameraOnboardingStatusesWithHttpInfo
public
updateOrganizationCameraOnboardingStatusesWithHttpInfo(string $organization_id[, UpdateOrganizationCameraOnboardingStatuses $update_organization_camera_onboarding_statuses = null ]) : array<string|int, mixed>
Notify that credential handoff to camera has completed
Parameters
- $organization_id : string
-
(required)
- $update_organization_camera_onboarding_statuses : UpdateOrganizationCameraOnboardingStatuses = null
-
(optional)
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
getOrganizationCameraOnboardingStatusesRequest()
Create request for operation 'getOrganizationCameraOnboardingStatuses'
protected
getOrganizationCameraOnboardingStatusesRequest(string $organization_id[, array<string|int, string> $serials = null ][, array<string|int, string> $network_ids = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $serials : array<string|int, string> = null
-
A list of serial numbers. The returned cameras will be filtered to only include these serials. (optional)
- $network_ids : array<string|int, string> = null
-
A list of network IDs. The returned cameras will be filtered to only include these networks. (optional)
Tags
Return values
Request —updateOrganizationCameraOnboardingStatusesRequest()
Create request for operation 'updateOrganizationCameraOnboardingStatuses'
protected
updateOrganizationCameraOnboardingStatusesRequest(string $organization_id[, UpdateOrganizationCameraOnboardingStatuses $update_organization_camera_onboarding_statuses = null ]) : Request
Parameters
- $organization_id : string
-
(required)
- $update_organization_camera_onboarding_statuses : UpdateOrganizationCameraOnboardingStatuses = null
-
(optional)