Documentation

CameraApi

CameraApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
createNetworkCameraQualityRetentionProfile()  : object
Operation createNetworkCameraQualityRetentionProfile
createNetworkCameraQualityRetentionProfileAsync()  : PromiseInterface
Operation createNetworkCameraQualityRetentionProfileAsync
createNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()  : PromiseInterface
Operation createNetworkCameraQualityRetentionProfileAsyncWithHttpInfo
createNetworkCameraQualityRetentionProfileWithHttpInfo()  : array<string|int, mixed>
Operation createNetworkCameraQualityRetentionProfileWithHttpInfo
createNetworkCameraWirelessProfile()  : object
Operation createNetworkCameraWirelessProfile
createNetworkCameraWirelessProfileAsync()  : PromiseInterface
Operation createNetworkCameraWirelessProfileAsync
createNetworkCameraWirelessProfileAsyncWithHttpInfo()  : PromiseInterface
Operation createNetworkCameraWirelessProfileAsyncWithHttpInfo
createNetworkCameraWirelessProfileWithHttpInfo()  : array<string|int, mixed>
Operation createNetworkCameraWirelessProfileWithHttpInfo
deleteNetworkCameraQualityRetentionProfile()  : void
Operation deleteNetworkCameraQualityRetentionProfile
deleteNetworkCameraQualityRetentionProfileAsync()  : PromiseInterface
Operation deleteNetworkCameraQualityRetentionProfileAsync
deleteNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()  : PromiseInterface
Operation deleteNetworkCameraQualityRetentionProfileAsyncWithHttpInfo
deleteNetworkCameraQualityRetentionProfileWithHttpInfo()  : array<string|int, mixed>
Operation deleteNetworkCameraQualityRetentionProfileWithHttpInfo
deleteNetworkCameraWirelessProfile()  : void
Operation deleteNetworkCameraWirelessProfile
deleteNetworkCameraWirelessProfileAsync()  : PromiseInterface
Operation deleteNetworkCameraWirelessProfileAsync
deleteNetworkCameraWirelessProfileAsyncWithHttpInfo()  : PromiseInterface
Operation deleteNetworkCameraWirelessProfileAsyncWithHttpInfo
deleteNetworkCameraWirelessProfileWithHttpInfo()  : array<string|int, mixed>
Operation deleteNetworkCameraWirelessProfileWithHttpInfo
generateDeviceCameraSnapshot()  : object
Operation generateDeviceCameraSnapshot
generateDeviceCameraSnapshotAsync()  : PromiseInterface
Operation generateDeviceCameraSnapshotAsync
generateDeviceCameraSnapshotAsyncWithHttpInfo()  : PromiseInterface
Operation generateDeviceCameraSnapshotAsyncWithHttpInfo
generateDeviceCameraSnapshotWithHttpInfo()  : array<string|int, mixed>
Operation generateDeviceCameraSnapshotWithHttpInfo
getConfig()  : Configuration
getDeviceCameraAnalyticsLive()  : object
Operation getDeviceCameraAnalyticsLive
getDeviceCameraAnalyticsLiveAsync()  : PromiseInterface
Operation getDeviceCameraAnalyticsLiveAsync
getDeviceCameraAnalyticsLiveAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraAnalyticsLiveAsyncWithHttpInfo
getDeviceCameraAnalyticsLiveWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraAnalyticsLiveWithHttpInfo
getDeviceCameraAnalyticsOverview()  : object
Operation getDeviceCameraAnalyticsOverview
getDeviceCameraAnalyticsOverviewAsync()  : PromiseInterface
Operation getDeviceCameraAnalyticsOverviewAsync
getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo
getDeviceCameraAnalyticsOverviewWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraAnalyticsOverviewWithHttpInfo
getDeviceCameraAnalyticsRecent()  : object
Operation getDeviceCameraAnalyticsRecent
getDeviceCameraAnalyticsRecentAsync()  : PromiseInterface
Operation getDeviceCameraAnalyticsRecentAsync
getDeviceCameraAnalyticsRecentAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraAnalyticsRecentAsyncWithHttpInfo
getDeviceCameraAnalyticsRecentWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraAnalyticsRecentWithHttpInfo
getDeviceCameraAnalyticsZoneHistory()  : object
Operation getDeviceCameraAnalyticsZoneHistory
getDeviceCameraAnalyticsZoneHistoryAsync()  : PromiseInterface
Operation getDeviceCameraAnalyticsZoneHistoryAsync
getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo
getDeviceCameraAnalyticsZoneHistoryWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraAnalyticsZoneHistoryWithHttpInfo
getDeviceCameraAnalyticsZones()  : object
Operation getDeviceCameraAnalyticsZones
getDeviceCameraAnalyticsZonesAsync()  : PromiseInterface
Operation getDeviceCameraAnalyticsZonesAsync
getDeviceCameraAnalyticsZonesAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraAnalyticsZonesAsyncWithHttpInfo
getDeviceCameraAnalyticsZonesWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraAnalyticsZonesWithHttpInfo
getDeviceCameraQualityAndRetention()  : object
Operation getDeviceCameraQualityAndRetention
getDeviceCameraQualityAndRetentionAsync()  : PromiseInterface
Operation getDeviceCameraQualityAndRetentionAsync
getDeviceCameraQualityAndRetentionAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraQualityAndRetentionAsyncWithHttpInfo
getDeviceCameraQualityAndRetentionWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraQualityAndRetentionWithHttpInfo
getDeviceCameraSense()  : object
Operation getDeviceCameraSense
getDeviceCameraSenseAsync()  : PromiseInterface
Operation getDeviceCameraSenseAsync
getDeviceCameraSenseAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraSenseAsyncWithHttpInfo
getDeviceCameraSenseObjectDetectionModels()  : object
Operation getDeviceCameraSenseObjectDetectionModels
getDeviceCameraSenseObjectDetectionModelsAsync()  : PromiseInterface
Operation getDeviceCameraSenseObjectDetectionModelsAsync
getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo
getDeviceCameraSenseObjectDetectionModelsWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraSenseObjectDetectionModelsWithHttpInfo
getDeviceCameraSenseWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraSenseWithHttpInfo
getDeviceCameraVideoLink()  : object
Operation getDeviceCameraVideoLink
getDeviceCameraVideoLinkAsync()  : PromiseInterface
Operation getDeviceCameraVideoLinkAsync
getDeviceCameraVideoLinkAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraVideoLinkAsyncWithHttpInfo
getDeviceCameraVideoLinkWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraVideoLinkWithHttpInfo
getDeviceCameraVideoSettings()  : object
Operation getDeviceCameraVideoSettings
getDeviceCameraVideoSettingsAsync()  : PromiseInterface
Operation getDeviceCameraVideoSettingsAsync
getDeviceCameraVideoSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraVideoSettingsAsyncWithHttpInfo
getDeviceCameraVideoSettingsWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraVideoSettingsWithHttpInfo
getDeviceCameraWirelessProfiles()  : object
Operation getDeviceCameraWirelessProfiles
getDeviceCameraWirelessProfilesAsync()  : PromiseInterface
Operation getDeviceCameraWirelessProfilesAsync
getDeviceCameraWirelessProfilesAsyncWithHttpInfo()  : PromiseInterface
Operation getDeviceCameraWirelessProfilesAsyncWithHttpInfo
getDeviceCameraWirelessProfilesWithHttpInfo()  : array<string|int, mixed>
Operation getDeviceCameraWirelessProfilesWithHttpInfo
getNetworkCameraQualityRetentionProfile()  : object
Operation getNetworkCameraQualityRetentionProfile
getNetworkCameraQualityRetentionProfileAsync()  : PromiseInterface
Operation getNetworkCameraQualityRetentionProfileAsync
getNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkCameraQualityRetentionProfileAsyncWithHttpInfo
getNetworkCameraQualityRetentionProfiles()  : object
Operation getNetworkCameraQualityRetentionProfiles
getNetworkCameraQualityRetentionProfilesAsync()  : PromiseInterface
Operation getNetworkCameraQualityRetentionProfilesAsync
getNetworkCameraQualityRetentionProfilesAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkCameraQualityRetentionProfilesAsyncWithHttpInfo
getNetworkCameraQualityRetentionProfilesWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkCameraQualityRetentionProfilesWithHttpInfo
getNetworkCameraQualityRetentionProfileWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkCameraQualityRetentionProfileWithHttpInfo
getNetworkCameraSchedules()  : object
Operation getNetworkCameraSchedules
getNetworkCameraSchedulesAsync()  : PromiseInterface
Operation getNetworkCameraSchedulesAsync
getNetworkCameraSchedulesAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkCameraSchedulesAsyncWithHttpInfo
getNetworkCameraSchedulesWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkCameraSchedulesWithHttpInfo
getNetworkCameraWirelessProfile()  : object
Operation getNetworkCameraWirelessProfile
getNetworkCameraWirelessProfileAsync()  : PromiseInterface
Operation getNetworkCameraWirelessProfileAsync
getNetworkCameraWirelessProfileAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkCameraWirelessProfileAsyncWithHttpInfo
getNetworkCameraWirelessProfiles()  : object
Operation getNetworkCameraWirelessProfiles
getNetworkCameraWirelessProfilesAsync()  : PromiseInterface
Operation getNetworkCameraWirelessProfilesAsync
getNetworkCameraWirelessProfilesAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkCameraWirelessProfilesAsyncWithHttpInfo
getNetworkCameraWirelessProfilesWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkCameraWirelessProfilesWithHttpInfo
getNetworkCameraWirelessProfileWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkCameraWirelessProfileWithHttpInfo
getOrganizationCameraOnboardingStatuses()  : object
Operation getOrganizationCameraOnboardingStatuses
getOrganizationCameraOnboardingStatusesAsync()  : PromiseInterface
Operation getOrganizationCameraOnboardingStatusesAsync
getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo()  : PromiseInterface
Operation getOrganizationCameraOnboardingStatusesAsyncWithHttpInfo
getOrganizationCameraOnboardingStatusesWithHttpInfo()  : array<string|int, mixed>
Operation getOrganizationCameraOnboardingStatusesWithHttpInfo
updateDeviceCameraQualityAndRetention()  : object
Operation updateDeviceCameraQualityAndRetention
updateDeviceCameraQualityAndRetentionAsync()  : PromiseInterface
Operation updateDeviceCameraQualityAndRetentionAsync
updateDeviceCameraQualityAndRetentionAsyncWithHttpInfo()  : PromiseInterface
Operation updateDeviceCameraQualityAndRetentionAsyncWithHttpInfo
updateDeviceCameraQualityAndRetentionWithHttpInfo()  : array<string|int, mixed>
Operation updateDeviceCameraQualityAndRetentionWithHttpInfo
updateDeviceCameraSense()  : object
Operation updateDeviceCameraSense
updateDeviceCameraSenseAsync()  : PromiseInterface
Operation updateDeviceCameraSenseAsync
updateDeviceCameraSenseAsyncWithHttpInfo()  : PromiseInterface
Operation updateDeviceCameraSenseAsyncWithHttpInfo
updateDeviceCameraSenseWithHttpInfo()  : array<string|int, mixed>
Operation updateDeviceCameraSenseWithHttpInfo
updateDeviceCameraVideoSettings()  : object
Operation updateDeviceCameraVideoSettings
updateDeviceCameraVideoSettingsAsync()  : PromiseInterface
Operation updateDeviceCameraVideoSettingsAsync
updateDeviceCameraVideoSettingsAsyncWithHttpInfo()  : PromiseInterface
Operation updateDeviceCameraVideoSettingsAsyncWithHttpInfo
updateDeviceCameraVideoSettingsWithHttpInfo()  : array<string|int, mixed>
Operation updateDeviceCameraVideoSettingsWithHttpInfo
updateDeviceCameraWirelessProfiles()  : object
Operation updateDeviceCameraWirelessProfiles
updateDeviceCameraWirelessProfilesAsync()  : PromiseInterface
Operation updateDeviceCameraWirelessProfilesAsync
updateDeviceCameraWirelessProfilesAsyncWithHttpInfo()  : PromiseInterface
Operation updateDeviceCameraWirelessProfilesAsyncWithHttpInfo
updateDeviceCameraWirelessProfilesWithHttpInfo()  : array<string|int, mixed>
Operation updateDeviceCameraWirelessProfilesWithHttpInfo
updateNetworkCameraQualityRetentionProfile()  : object
Operation updateNetworkCameraQualityRetentionProfile
updateNetworkCameraQualityRetentionProfileAsync()  : PromiseInterface
Operation updateNetworkCameraQualityRetentionProfileAsync
updateNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()  : PromiseInterface
Operation updateNetworkCameraQualityRetentionProfileAsyncWithHttpInfo
updateNetworkCameraQualityRetentionProfileWithHttpInfo()  : array<string|int, mixed>
Operation updateNetworkCameraQualityRetentionProfileWithHttpInfo
updateNetworkCameraWirelessProfile()  : object
Operation updateNetworkCameraWirelessProfile
updateNetworkCameraWirelessProfileAsync()  : PromiseInterface
Operation updateNetworkCameraWirelessProfileAsync
updateNetworkCameraWirelessProfileAsyncWithHttpInfo()  : PromiseInterface
Operation updateNetworkCameraWirelessProfileAsyncWithHttpInfo
updateNetworkCameraWirelessProfileWithHttpInfo()  : array<string|int, mixed>
Operation updateNetworkCameraWirelessProfileWithHttpInfo
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
createNetworkCameraQualityRetentionProfileRequest()  : Request
Create request for operation 'createNetworkCameraQualityRetentionProfile'
createNetworkCameraWirelessProfileRequest()  : Request
Create request for operation 'createNetworkCameraWirelessProfile'
deleteNetworkCameraQualityRetentionProfileRequest()  : Request
Create request for operation 'deleteNetworkCameraQualityRetentionProfile'
deleteNetworkCameraWirelessProfileRequest()  : Request
Create request for operation 'deleteNetworkCameraWirelessProfile'
generateDeviceCameraSnapshotRequest()  : Request
Create request for operation 'generateDeviceCameraSnapshot'
getDeviceCameraAnalyticsLiveRequest()  : Request
Create request for operation 'getDeviceCameraAnalyticsLive'
getDeviceCameraAnalyticsOverviewRequest()  : Request
Create request for operation 'getDeviceCameraAnalyticsOverview'
getDeviceCameraAnalyticsRecentRequest()  : Request
Create request for operation 'getDeviceCameraAnalyticsRecent'
getDeviceCameraAnalyticsZoneHistoryRequest()  : Request
Create request for operation 'getDeviceCameraAnalyticsZoneHistory'
getDeviceCameraAnalyticsZonesRequest()  : Request
Create request for operation 'getDeviceCameraAnalyticsZones'
getDeviceCameraQualityAndRetentionRequest()  : Request
Create request for operation 'getDeviceCameraQualityAndRetention'
getDeviceCameraSenseObjectDetectionModelsRequest()  : Request
Create request for operation 'getDeviceCameraSenseObjectDetectionModels'
getDeviceCameraSenseRequest()  : Request
Create request for operation 'getDeviceCameraSense'
getDeviceCameraVideoLinkRequest()  : Request
Create request for operation 'getDeviceCameraVideoLink'
getDeviceCameraVideoSettingsRequest()  : Request
Create request for operation 'getDeviceCameraVideoSettings'
getDeviceCameraWirelessProfilesRequest()  : Request
Create request for operation 'getDeviceCameraWirelessProfiles'
getNetworkCameraQualityRetentionProfileRequest()  : Request
Create request for operation 'getNetworkCameraQualityRetentionProfile'
getNetworkCameraQualityRetentionProfilesRequest()  : Request
Create request for operation 'getNetworkCameraQualityRetentionProfiles'
getNetworkCameraSchedulesRequest()  : Request
Create request for operation 'getNetworkCameraSchedules'
getNetworkCameraWirelessProfileRequest()  : Request
Create request for operation 'getNetworkCameraWirelessProfile'
getNetworkCameraWirelessProfilesRequest()  : Request
Create request for operation 'getNetworkCameraWirelessProfiles'
getOrganizationCameraOnboardingStatusesRequest()  : Request
Create request for operation 'getOrganizationCameraOnboardingStatuses'
updateDeviceCameraQualityAndRetentionRequest()  : Request
Create request for operation 'updateDeviceCameraQualityAndRetention'
updateDeviceCameraSenseRequest()  : Request
Create request for operation 'updateDeviceCameraSense'
updateDeviceCameraVideoSettingsRequest()  : Request
Create request for operation 'updateDeviceCameraVideoSettings'
updateDeviceCameraWirelessProfilesRequest()  : Request
Create request for operation 'updateDeviceCameraWirelessProfiles'
updateNetworkCameraQualityRetentionProfileRequest()  : Request
Create request for operation 'updateNetworkCameraQualityRetentionProfile'
updateNetworkCameraWirelessProfileRequest()  : Request
Create request for operation 'updateNetworkCameraWirelessProfile'
updateOrganizationCameraOnboardingStatusesRequest()  : Request
Create request for operation 'updateOrganizationCameraOnboardingStatuses'

Properties

Methods

createNetworkCameraQualityRetentionProfile()

Operation createNetworkCameraQualityRetentionProfile

public createNetworkCameraQualityRetentionProfile(string $network_id, CreateNetworkCameraQualityRetentionProfile $create_network_camera_quality_retention_profile) : object

Creates new quality retention profile for this network.

Parameters
$network_id : string

network_id (required)

$create_network_camera_quality_retention_profile : CreateNetworkCameraQualityRetentionProfile

create_network_camera_quality_retention_profile (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

createNetworkCameraQualityRetentionProfileAsync()

Operation createNetworkCameraQualityRetentionProfileAsync

public createNetworkCameraQualityRetentionProfileAsync(string $network_id, CreateNetworkCameraQualityRetentionProfile $create_network_camera_quality_retention_profile) : PromiseInterface

Creates new quality retention profile for this network.

Parameters
$network_id : string

(required)

$create_network_camera_quality_retention_profile : CreateNetworkCameraQualityRetentionProfile

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()

Operation createNetworkCameraQualityRetentionProfileAsyncWithHttpInfo

public createNetworkCameraQualityRetentionProfileAsyncWithHttpInfo(string $network_id, CreateNetworkCameraQualityRetentionProfile $create_network_camera_quality_retention_profile) : PromiseInterface

Creates new quality retention profile for this network.

Parameters
$network_id : string

(required)

$create_network_camera_quality_retention_profile : CreateNetworkCameraQualityRetentionProfile

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createNetworkCameraQualityRetentionProfileWithHttpInfo()

Operation createNetworkCameraQualityRetentionProfileWithHttpInfo

public createNetworkCameraQualityRetentionProfileWithHttpInfo(string $network_id, CreateNetworkCameraQualityRetentionProfile $create_network_camera_quality_retention_profile) : array<string|int, mixed>

Creates new quality retention profile for this network.

Parameters
$network_id : string

(required)

$create_network_camera_quality_retention_profile : CreateNetworkCameraQualityRetentionProfile

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

createNetworkCameraWirelessProfile()

Operation createNetworkCameraWirelessProfile

public createNetworkCameraWirelessProfile(string $network_id, CreateNetworkCameraWirelessProfile $create_network_camera_wireless_profile) : object

Creates a new camera wireless profile for this network.

Parameters
$network_id : string

network_id (required)

$create_network_camera_wireless_profile : CreateNetworkCameraWirelessProfile

create_network_camera_wireless_profile (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

createNetworkCameraWirelessProfileAsync()

Operation createNetworkCameraWirelessProfileAsync

public createNetworkCameraWirelessProfileAsync(string $network_id, CreateNetworkCameraWirelessProfile $create_network_camera_wireless_profile) : PromiseInterface

Creates a new camera wireless profile for this network.

Parameters
$network_id : string

(required)

$create_network_camera_wireless_profile : CreateNetworkCameraWirelessProfile

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createNetworkCameraWirelessProfileAsyncWithHttpInfo()

Operation createNetworkCameraWirelessProfileAsyncWithHttpInfo

public createNetworkCameraWirelessProfileAsyncWithHttpInfo(string $network_id, CreateNetworkCameraWirelessProfile $create_network_camera_wireless_profile) : PromiseInterface

Creates a new camera wireless profile for this network.

Parameters
$network_id : string

(required)

$create_network_camera_wireless_profile : CreateNetworkCameraWirelessProfile

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

createNetworkCameraWirelessProfileWithHttpInfo()

Operation createNetworkCameraWirelessProfileWithHttpInfo

public createNetworkCameraWirelessProfileWithHttpInfo(string $network_id, CreateNetworkCameraWirelessProfile $create_network_camera_wireless_profile) : array<string|int, mixed>

Creates a new camera wireless profile for this network.

Parameters
$network_id : string

(required)

$create_network_camera_wireless_profile : CreateNetworkCameraWirelessProfile

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

deleteNetworkCameraQualityRetentionProfile()

Operation deleteNetworkCameraQualityRetentionProfile

public deleteNetworkCameraQualityRetentionProfile(string $network_id, string $quality_retention_profile_id) : void

Delete an existing quality retention profile for this network.

Parameters
$network_id : string

network_id (required)

$quality_retention_profile_id : string

quality_retention_profile_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

deleteNetworkCameraQualityRetentionProfileAsync()

Operation deleteNetworkCameraQualityRetentionProfileAsync

public deleteNetworkCameraQualityRetentionProfileAsync(string $network_id, string $quality_retention_profile_id) : PromiseInterface

Delete an existing quality retention profile for this network.

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()

Operation deleteNetworkCameraQualityRetentionProfileAsyncWithHttpInfo

public deleteNetworkCameraQualityRetentionProfileAsyncWithHttpInfo(string $network_id, string $quality_retention_profile_id) : PromiseInterface

Delete an existing quality retention profile for this network.

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteNetworkCameraQualityRetentionProfileWithHttpInfo()

Operation deleteNetworkCameraQualityRetentionProfileWithHttpInfo

public deleteNetworkCameraQualityRetentionProfileWithHttpInfo(string $network_id, string $quality_retention_profile_id) : array<string|int, mixed>

Delete an existing quality retention profile for this network.

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

deleteNetworkCameraWirelessProfile()

Operation deleteNetworkCameraWirelessProfile

public deleteNetworkCameraWirelessProfile(string $network_id, string $wireless_profile_id) : void

Delete an existing camera wireless profile for this network.

Parameters
$network_id : string

network_id (required)

$wireless_profile_id : string

wireless_profile_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
void —

deleteNetworkCameraWirelessProfileAsync()

Operation deleteNetworkCameraWirelessProfileAsync

public deleteNetworkCameraWirelessProfileAsync(string $network_id, string $wireless_profile_id) : PromiseInterface

Delete an existing camera wireless profile for this network.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteNetworkCameraWirelessProfileAsyncWithHttpInfo()

Operation deleteNetworkCameraWirelessProfileAsyncWithHttpInfo

public deleteNetworkCameraWirelessProfileAsyncWithHttpInfo(string $network_id, string $wireless_profile_id) : PromiseInterface

Delete an existing camera wireless profile for this network.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

deleteNetworkCameraWirelessProfileWithHttpInfo()

Operation deleteNetworkCameraWirelessProfileWithHttpInfo

public deleteNetworkCameraWirelessProfileWithHttpInfo(string $network_id, string $wireless_profile_id) : array<string|int, mixed>

Delete an existing camera wireless profile for this network.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

generateDeviceCameraSnapshot()

Operation generateDeviceCameraSnapshot

public generateDeviceCameraSnapshot(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : object

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters
$serial : string

serial (required)

$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null

generate_device_camera_snapshot (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

generateDeviceCameraSnapshotAsync()

Operation generateDeviceCameraSnapshotAsync

public generateDeviceCameraSnapshotAsync(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : PromiseInterface

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters
$serial : string

(required)

$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateDeviceCameraSnapshotAsyncWithHttpInfo()

Operation generateDeviceCameraSnapshotAsyncWithHttpInfo

public generateDeviceCameraSnapshotAsyncWithHttpInfo(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : PromiseInterface

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters
$serial : string

(required)

$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

generateDeviceCameraSnapshotWithHttpInfo()

Operation generateDeviceCameraSnapshotWithHttpInfo

public generateDeviceCameraSnapshotWithHttpInfo(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : array<string|int, mixed>

Generate a snapshot of what the camera sees at the specified time and return a link to that image.

Parameters
$serial : string

(required)

$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsLive()

Operation getDeviceCameraAnalyticsLive

public getDeviceCameraAnalyticsLive(string $serial) : object

Returns live state from camera of analytics zones

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraAnalyticsLiveAsync()

Operation getDeviceCameraAnalyticsLiveAsync

public getDeviceCameraAnalyticsLiveAsync(string $serial) : PromiseInterface

Returns live state from camera of analytics zones

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsLiveAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsLiveAsyncWithHttpInfo

public getDeviceCameraAnalyticsLiveAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns live state from camera of analytics zones

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsLiveWithHttpInfo()

Operation getDeviceCameraAnalyticsLiveWithHttpInfo

public getDeviceCameraAnalyticsLiveWithHttpInfo(string $serial) : array<string|int, mixed>

Returns live state from camera of analytics zones

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsOverview()

Operation getDeviceCameraAnalyticsOverview

public getDeviceCameraAnalyticsOverview(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : object

Returns an overview of aggregate analytics data for a timespan

Parameters
$serial : string

serial (required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraAnalyticsOverviewAsync()

Operation getDeviceCameraAnalyticsOverviewAsync

public getDeviceCameraAnalyticsOverviewAsync(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : PromiseInterface

Returns an overview of aggregate analytics data for a timespan

Parameters
$serial : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo

public getDeviceCameraAnalyticsOverviewAsyncWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : PromiseInterface

Returns an overview of aggregate analytics data for a timespan

Parameters
$serial : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsOverviewWithHttpInfo()

Operation getDeviceCameraAnalyticsOverviewWithHttpInfo

public getDeviceCameraAnalyticsOverviewWithHttpInfo(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : array<string|int, mixed>

Returns an overview of aggregate analytics data for a timespan

Parameters
$serial : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsRecent()

Operation getDeviceCameraAnalyticsRecent

public getDeviceCameraAnalyticsRecent(string $serial[, string $object_type = null ]) : object

Returns most recent record for analytics zones

Parameters
$serial : string

serial (required)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraAnalyticsRecentAsync()

Operation getDeviceCameraAnalyticsRecentAsync

public getDeviceCameraAnalyticsRecentAsync(string $serial[, string $object_type = null ]) : PromiseInterface

Returns most recent record for analytics zones

Parameters
$serial : string

(required)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsRecentAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsRecentAsyncWithHttpInfo

public getDeviceCameraAnalyticsRecentAsyncWithHttpInfo(string $serial[, string $object_type = null ]) : PromiseInterface

Returns most recent record for analytics zones

Parameters
$serial : string

(required)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsRecentWithHttpInfo()

Operation getDeviceCameraAnalyticsRecentWithHttpInfo

public getDeviceCameraAnalyticsRecentWithHttpInfo(string $serial[, string $object_type = null ]) : array<string|int, mixed>

Returns most recent record for analytics zones

Parameters
$serial : string

(required)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsZoneHistory()

Operation getDeviceCameraAnalyticsZoneHistory

public getDeviceCameraAnalyticsZoneHistory(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : object

Return historical records for analytic zones

Parameters
$serial : string

serial (required)

$zone_id : string

zone_id (required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour. (optional)

$resolution : int = null

The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraAnalyticsZoneHistoryAsync()

Operation getDeviceCameraAnalyticsZoneHistoryAsync

public getDeviceCameraAnalyticsZoneHistoryAsync(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : PromiseInterface

Return historical records for analytic zones

Parameters
$serial : string

(required)

$zone_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour. (optional)

$resolution : int = null

The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo

public getDeviceCameraAnalyticsZoneHistoryAsyncWithHttpInfo(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : PromiseInterface

Return historical records for analytic zones

Parameters
$serial : string

(required)

$zone_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour. (optional)

$resolution : int = null

The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsZoneHistoryWithHttpInfo()

Operation getDeviceCameraAnalyticsZoneHistoryWithHttpInfo

public getDeviceCameraAnalyticsZoneHistoryWithHttpInfo(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : array<string|int, mixed>

Return historical records for analytic zones

Parameters
$serial : string

(required)

$zone_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour. (optional)

$resolution : int = null

The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraAnalyticsZones()

Operation getDeviceCameraAnalyticsZones

public getDeviceCameraAnalyticsZones(string $serial) : object

Returns all configured analytic zones for this camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraAnalyticsZonesAsync()

Operation getDeviceCameraAnalyticsZonesAsync

public getDeviceCameraAnalyticsZonesAsync(string $serial) : PromiseInterface

Returns all configured analytic zones for this camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsZonesAsyncWithHttpInfo()

Operation getDeviceCameraAnalyticsZonesAsyncWithHttpInfo

public getDeviceCameraAnalyticsZonesAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns all configured analytic zones for this camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraAnalyticsZonesWithHttpInfo()

Operation getDeviceCameraAnalyticsZonesWithHttpInfo

public getDeviceCameraAnalyticsZonesWithHttpInfo(string $serial) : array<string|int, mixed>

Returns all configured analytic zones for this camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraQualityAndRetention()

Operation getDeviceCameraQualityAndRetention

public getDeviceCameraQualityAndRetention(string $serial) : object

Returns quality and retention settings for the given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraQualityAndRetentionAsync()

Operation getDeviceCameraQualityAndRetentionAsync

public getDeviceCameraQualityAndRetentionAsync(string $serial) : PromiseInterface

Returns quality and retention settings for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraQualityAndRetentionAsyncWithHttpInfo()

Operation getDeviceCameraQualityAndRetentionAsyncWithHttpInfo

public getDeviceCameraQualityAndRetentionAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns quality and retention settings for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraQualityAndRetentionWithHttpInfo()

Operation getDeviceCameraQualityAndRetentionWithHttpInfo

public getDeviceCameraQualityAndRetentionWithHttpInfo(string $serial) : array<string|int, mixed>

Returns quality and retention settings for the given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraSense()

Operation getDeviceCameraSense

public getDeviceCameraSense(string $serial) : object

Returns sense settings for a given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraSenseAsync()

Operation getDeviceCameraSenseAsync

public getDeviceCameraSenseAsync(string $serial) : PromiseInterface

Returns sense settings for a given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraSenseAsyncWithHttpInfo()

Operation getDeviceCameraSenseAsyncWithHttpInfo

public getDeviceCameraSenseAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns sense settings for a given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraSenseObjectDetectionModels()

Operation getDeviceCameraSenseObjectDetectionModels

public getDeviceCameraSenseObjectDetectionModels(string $serial) : object

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraSenseObjectDetectionModelsAsync()

Operation getDeviceCameraSenseObjectDetectionModelsAsync

public getDeviceCameraSenseObjectDetectionModelsAsync(string $serial) : PromiseInterface

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo()

Operation getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo

public getDeviceCameraSenseObjectDetectionModelsAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraSenseObjectDetectionModelsWithHttpInfo()

Operation getDeviceCameraSenseObjectDetectionModelsWithHttpInfo

public getDeviceCameraSenseObjectDetectionModelsWithHttpInfo(string $serial) : array<string|int, mixed>

Returns the MV Sense object detection model list for the given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraSenseWithHttpInfo()

Operation getDeviceCameraSenseWithHttpInfo

public getDeviceCameraSenseWithHttpInfo(string $serial) : array<string|int, mixed>

Returns sense settings for a given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

Operation getDeviceCameraVideoLink

public getDeviceCameraVideoLink(string $serial[, DateTime $timestamp = null ]) : object

Returns video link to the specified camera

Parameters
$serial : string

serial (required)

$timestamp : DateTime = null

[optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraVideoLinkAsync()

Operation getDeviceCameraVideoLinkAsync

public getDeviceCameraVideoLinkAsync(string $serial[, DateTime $timestamp = null ]) : PromiseInterface

Returns video link to the specified camera

Parameters
$serial : string

(required)

$timestamp : DateTime = null

[optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraVideoLinkAsyncWithHttpInfo()

Operation getDeviceCameraVideoLinkAsyncWithHttpInfo

public getDeviceCameraVideoLinkAsyncWithHttpInfo(string $serial[, DateTime $timestamp = null ]) : PromiseInterface

Returns video link to the specified camera

Parameters
$serial : string

(required)

$timestamp : DateTime = null

[optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time. (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraVideoLinkWithHttpInfo()

Operation getDeviceCameraVideoLinkWithHttpInfo

public getDeviceCameraVideoLinkWithHttpInfo(string $serial[, DateTime $timestamp = null ]) : array<string|int, mixed>

Returns video link to the specified camera

Parameters
$serial : string

(required)

$timestamp : DateTime = null

[optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time. (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraVideoSettings()

Operation getDeviceCameraVideoSettings

public getDeviceCameraVideoSettings(string $serial) : object

Returns video settings for the given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraVideoSettingsAsync()

Operation getDeviceCameraVideoSettingsAsync

public getDeviceCameraVideoSettingsAsync(string $serial) : PromiseInterface

Returns video settings for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraVideoSettingsAsyncWithHttpInfo()

Operation getDeviceCameraVideoSettingsAsyncWithHttpInfo

public getDeviceCameraVideoSettingsAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns video settings for the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraVideoSettingsWithHttpInfo()

Operation getDeviceCameraVideoSettingsWithHttpInfo

public getDeviceCameraVideoSettingsWithHttpInfo(string $serial) : array<string|int, mixed>

Returns video settings for the given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getDeviceCameraWirelessProfiles()

Operation getDeviceCameraWirelessProfiles

public getDeviceCameraWirelessProfiles(string $serial) : object

Returns wireless profile assigned to the given camera

Parameters
$serial : string

serial (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getDeviceCameraWirelessProfilesAsync()

Operation getDeviceCameraWirelessProfilesAsync

public getDeviceCameraWirelessProfilesAsync(string $serial) : PromiseInterface

Returns wireless profile assigned to the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraWirelessProfilesAsyncWithHttpInfo()

Operation getDeviceCameraWirelessProfilesAsyncWithHttpInfo

public getDeviceCameraWirelessProfilesAsyncWithHttpInfo(string $serial) : PromiseInterface

Returns wireless profile assigned to the given camera

Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getDeviceCameraWirelessProfilesWithHttpInfo()

Operation getDeviceCameraWirelessProfilesWithHttpInfo

public getDeviceCameraWirelessProfilesWithHttpInfo(string $serial) : array<string|int, mixed>

Returns wireless profile assigned to the given camera

Parameters
$serial : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkCameraQualityRetentionProfile()

Operation getNetworkCameraQualityRetentionProfile

public getNetworkCameraQualityRetentionProfile(string $network_id, string $quality_retention_profile_id) : object

Retrieve a single quality retention profile

Parameters
$network_id : string

network_id (required)

$quality_retention_profile_id : string

quality_retention_profile_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getNetworkCameraQualityRetentionProfileAsync()

Operation getNetworkCameraQualityRetentionProfileAsync

public getNetworkCameraQualityRetentionProfileAsync(string $network_id, string $quality_retention_profile_id) : PromiseInterface

Retrieve a single quality retention profile

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()

Operation getNetworkCameraQualityRetentionProfileAsyncWithHttpInfo

public getNetworkCameraQualityRetentionProfileAsyncWithHttpInfo(string $network_id, string $quality_retention_profile_id) : PromiseInterface

Retrieve a single quality retention profile

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraQualityRetentionProfiles()

Operation getNetworkCameraQualityRetentionProfiles

public getNetworkCameraQualityRetentionProfiles(string $network_id) : object

List the quality retention profiles for this network

Parameters
$network_id : string

network_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getNetworkCameraQualityRetentionProfilesAsync()

Operation getNetworkCameraQualityRetentionProfilesAsync

public getNetworkCameraQualityRetentionProfilesAsync(string $network_id) : PromiseInterface

List the quality retention profiles for this network

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraQualityRetentionProfilesAsyncWithHttpInfo()

Operation getNetworkCameraQualityRetentionProfilesAsyncWithHttpInfo

public getNetworkCameraQualityRetentionProfilesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the quality retention profiles for this network

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraQualityRetentionProfilesWithHttpInfo()

Operation getNetworkCameraQualityRetentionProfilesWithHttpInfo

public getNetworkCameraQualityRetentionProfilesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the quality retention profiles for this network

Parameters
$network_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkCameraQualityRetentionProfileWithHttpInfo()

Operation getNetworkCameraQualityRetentionProfileWithHttpInfo

public getNetworkCameraQualityRetentionProfileWithHttpInfo(string $network_id, string $quality_retention_profile_id) : array<string|int, mixed>

Retrieve a single quality retention profile

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkCameraSchedules()

Operation getNetworkCameraSchedules

public getNetworkCameraSchedules(string $network_id) : object

Returns a list of all camera recording schedules.

Parameters
$network_id : string

network_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getNetworkCameraSchedulesAsync()

Operation getNetworkCameraSchedulesAsync

public getNetworkCameraSchedulesAsync(string $network_id) : PromiseInterface

Returns a list of all camera recording schedules.

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraSchedulesAsyncWithHttpInfo()

Operation getNetworkCameraSchedulesAsyncWithHttpInfo

public getNetworkCameraSchedulesAsyncWithHttpInfo(string $network_id) : PromiseInterface

Returns a list of all camera recording schedules.

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraSchedulesWithHttpInfo()

Operation getNetworkCameraSchedulesWithHttpInfo

public getNetworkCameraSchedulesWithHttpInfo(string $network_id) : array<string|int, mixed>

Returns a list of all camera recording schedules.

Parameters
$network_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkCameraWirelessProfile()

Operation getNetworkCameraWirelessProfile

public getNetworkCameraWirelessProfile(string $network_id, string $wireless_profile_id) : object

Retrieve a single camera wireless profile.

Parameters
$network_id : string

network_id (required)

$wireless_profile_id : string

wireless_profile_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getNetworkCameraWirelessProfileAsync()

Operation getNetworkCameraWirelessProfileAsync

public getNetworkCameraWirelessProfileAsync(string $network_id, string $wireless_profile_id) : PromiseInterface

Retrieve a single camera wireless profile.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraWirelessProfileAsyncWithHttpInfo()

Operation getNetworkCameraWirelessProfileAsyncWithHttpInfo

public getNetworkCameraWirelessProfileAsyncWithHttpInfo(string $network_id, string $wireless_profile_id) : PromiseInterface

Retrieve a single camera wireless profile.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraWirelessProfiles()

Operation getNetworkCameraWirelessProfiles

public getNetworkCameraWirelessProfiles(string $network_id) : object

List the camera wireless profiles for this network.

Parameters
$network_id : string

network_id (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

getNetworkCameraWirelessProfilesAsync()

Operation getNetworkCameraWirelessProfilesAsync

public getNetworkCameraWirelessProfilesAsync(string $network_id) : PromiseInterface

List the camera wireless profiles for this network.

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraWirelessProfilesAsyncWithHttpInfo()

Operation getNetworkCameraWirelessProfilesAsyncWithHttpInfo

public getNetworkCameraWirelessProfilesAsyncWithHttpInfo(string $network_id) : PromiseInterface

List the camera wireless profiles for this network.

Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

getNetworkCameraWirelessProfilesWithHttpInfo()

Operation getNetworkCameraWirelessProfilesWithHttpInfo

public getNetworkCameraWirelessProfilesWithHttpInfo(string $network_id) : array<string|int, mixed>

List the camera wireless profiles for this network.

Parameters
$network_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

getNetworkCameraWirelessProfileWithHttpInfo()

Operation getNetworkCameraWirelessProfileWithHttpInfo

public getNetworkCameraWirelessProfileWithHttpInfo(string $network_id, string $wireless_profile_id) : array<string|int, mixed>

Retrieve a single camera wireless profile.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateDeviceCameraQualityAndRetention()

Operation updateDeviceCameraQualityAndRetention

public updateDeviceCameraQualityAndRetention(string $serial[, UpdateDeviceCameraQualityAndRetention $update_device_camera_quality_and_retention = null ]) : object

Update quality and retention settings for the given camera

Parameters
$serial : string

serial (required)

$update_device_camera_quality_and_retention : UpdateDeviceCameraQualityAndRetention = null

update_device_camera_quality_and_retention (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

updateDeviceCameraQualityAndRetentionAsync()

Operation updateDeviceCameraQualityAndRetentionAsync

public updateDeviceCameraQualityAndRetentionAsync(string $serial[, UpdateDeviceCameraQualityAndRetention $update_device_camera_quality_and_retention = null ]) : PromiseInterface

Update quality and retention settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_quality_and_retention : UpdateDeviceCameraQualityAndRetention = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraQualityAndRetentionAsyncWithHttpInfo()

Operation updateDeviceCameraQualityAndRetentionAsyncWithHttpInfo

public updateDeviceCameraQualityAndRetentionAsyncWithHttpInfo(string $serial[, UpdateDeviceCameraQualityAndRetention $update_device_camera_quality_and_retention = null ]) : PromiseInterface

Update quality and retention settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_quality_and_retention : UpdateDeviceCameraQualityAndRetention = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraQualityAndRetentionWithHttpInfo()

Operation updateDeviceCameraQualityAndRetentionWithHttpInfo

public updateDeviceCameraQualityAndRetentionWithHttpInfo(string $serial[, UpdateDeviceCameraQualityAndRetention $update_device_camera_quality_and_retention = null ]) : array<string|int, mixed>

Update quality and retention settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_quality_and_retention : UpdateDeviceCameraQualityAndRetention = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateDeviceCameraSense()

Operation updateDeviceCameraSense

public updateDeviceCameraSense(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : object

Update sense settings for the given camera

Parameters
$serial : string

serial (required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

update_device_camera_sense (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

updateDeviceCameraSenseAsync()

Operation updateDeviceCameraSenseAsync

public updateDeviceCameraSenseAsync(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : PromiseInterface

Update sense settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraSenseAsyncWithHttpInfo()

Operation updateDeviceCameraSenseAsyncWithHttpInfo

public updateDeviceCameraSenseAsyncWithHttpInfo(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : PromiseInterface

Update sense settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraSenseWithHttpInfo()

Operation updateDeviceCameraSenseWithHttpInfo

public updateDeviceCameraSenseWithHttpInfo(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : array<string|int, mixed>

Update sense settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateDeviceCameraVideoSettings()

Operation updateDeviceCameraVideoSettings

public updateDeviceCameraVideoSettings(string $serial[, UpdateDeviceCameraVideoSettings $update_device_camera_video_settings = null ]) : object

Update video settings for the given camera

Parameters
$serial : string

serial (required)

$update_device_camera_video_settings : UpdateDeviceCameraVideoSettings = null

update_device_camera_video_settings (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

updateDeviceCameraVideoSettingsAsync()

Operation updateDeviceCameraVideoSettingsAsync

public updateDeviceCameraVideoSettingsAsync(string $serial[, UpdateDeviceCameraVideoSettings $update_device_camera_video_settings = null ]) : PromiseInterface

Update video settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_video_settings : UpdateDeviceCameraVideoSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraVideoSettingsAsyncWithHttpInfo()

Operation updateDeviceCameraVideoSettingsAsyncWithHttpInfo

public updateDeviceCameraVideoSettingsAsyncWithHttpInfo(string $serial[, UpdateDeviceCameraVideoSettings $update_device_camera_video_settings = null ]) : PromiseInterface

Update video settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_video_settings : UpdateDeviceCameraVideoSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraVideoSettingsWithHttpInfo()

Operation updateDeviceCameraVideoSettingsWithHttpInfo

public updateDeviceCameraVideoSettingsWithHttpInfo(string $serial[, UpdateDeviceCameraVideoSettings $update_device_camera_video_settings = null ]) : array<string|int, mixed>

Update video settings for the given camera

Parameters
$serial : string

(required)

$update_device_camera_video_settings : UpdateDeviceCameraVideoSettings = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateDeviceCameraWirelessProfiles()

Operation updateDeviceCameraWirelessProfiles

public updateDeviceCameraWirelessProfiles(string $serial, UpdateDeviceCameraWirelessProfiles $update_device_camera_wireless_profiles) : object

Assign wireless profiles to the given camera

Parameters
$serial : string

serial (required)

$update_device_camera_wireless_profiles : UpdateDeviceCameraWirelessProfiles

update_device_camera_wireless_profiles (required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

updateDeviceCameraWirelessProfilesAsync()

Operation updateDeviceCameraWirelessProfilesAsync

public updateDeviceCameraWirelessProfilesAsync(string $serial, UpdateDeviceCameraWirelessProfiles $update_device_camera_wireless_profiles) : PromiseInterface

Assign wireless profiles to the given camera

Parameters
$serial : string

(required)

$update_device_camera_wireless_profiles : UpdateDeviceCameraWirelessProfiles

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraWirelessProfilesAsyncWithHttpInfo()

Operation updateDeviceCameraWirelessProfilesAsyncWithHttpInfo

public updateDeviceCameraWirelessProfilesAsyncWithHttpInfo(string $serial, UpdateDeviceCameraWirelessProfiles $update_device_camera_wireless_profiles) : PromiseInterface

Assign wireless profiles to the given camera

Parameters
$serial : string

(required)

$update_device_camera_wireless_profiles : UpdateDeviceCameraWirelessProfiles

(required)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateDeviceCameraWirelessProfilesWithHttpInfo()

Operation updateDeviceCameraWirelessProfilesWithHttpInfo

public updateDeviceCameraWirelessProfilesWithHttpInfo(string $serial, UpdateDeviceCameraWirelessProfiles $update_device_camera_wireless_profiles) : array<string|int, mixed>

Assign wireless profiles to the given camera

Parameters
$serial : string

(required)

$update_device_camera_wireless_profiles : UpdateDeviceCameraWirelessProfiles

(required)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkCameraQualityRetentionProfile()

Operation updateNetworkCameraQualityRetentionProfile

public updateNetworkCameraQualityRetentionProfile(string $network_id, string $quality_retention_profile_id[, UpdateNetworkCameraQualityRetentionProfile $update_network_camera_quality_retention_profile = null ]) : object

Update an existing quality retention profile for this network.

Parameters
$network_id : string

network_id (required)

$quality_retention_profile_id : string

quality_retention_profile_id (required)

$update_network_camera_quality_retention_profile : UpdateNetworkCameraQualityRetentionProfile = null

update_network_camera_quality_retention_profile (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

updateNetworkCameraQualityRetentionProfileAsync()

Operation updateNetworkCameraQualityRetentionProfileAsync

public updateNetworkCameraQualityRetentionProfileAsync(string $network_id, string $quality_retention_profile_id[, UpdateNetworkCameraQualityRetentionProfile $update_network_camera_quality_retention_profile = null ]) : PromiseInterface

Update an existing quality retention profile for this network.

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

$update_network_camera_quality_retention_profile : UpdateNetworkCameraQualityRetentionProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateNetworkCameraQualityRetentionProfileAsyncWithHttpInfo()

Operation updateNetworkCameraQualityRetentionProfileAsyncWithHttpInfo

public updateNetworkCameraQualityRetentionProfileAsyncWithHttpInfo(string $network_id, string $quality_retention_profile_id[, UpdateNetworkCameraQualityRetentionProfile $update_network_camera_quality_retention_profile = null ]) : PromiseInterface

Update an existing quality retention profile for this network.

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

$update_network_camera_quality_retention_profile : UpdateNetworkCameraQualityRetentionProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateNetworkCameraQualityRetentionProfileWithHttpInfo()

Operation updateNetworkCameraQualityRetentionProfileWithHttpInfo

public updateNetworkCameraQualityRetentionProfileWithHttpInfo(string $network_id, string $quality_retention_profile_id[, UpdateNetworkCameraQualityRetentionProfile $update_network_camera_quality_retention_profile = null ]) : array<string|int, mixed>

Update an existing quality retention profile for this network.

Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

$update_network_camera_quality_retention_profile : UpdateNetworkCameraQualityRetentionProfile = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed> —

of object, HTTP status code, HTTP response headers (array of strings)

updateNetworkCameraWirelessProfile()

Operation updateNetworkCameraWirelessProfile

public updateNetworkCameraWirelessProfile(string $network_id, string $wireless_profile_id[, UpdateNetworkCameraWirelessProfile $update_network_camera_wireless_profile = null ]) : object

Update an existing camera wireless profile in this network.

Parameters
$network_id : string

network_id (required)

$wireless_profile_id : string

wireless_profile_id (required)

$update_network_camera_wireless_profile : UpdateNetworkCameraWirelessProfile = null

update_network_camera_wireless_profile (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object —

updateNetworkCameraWirelessProfileAsync()

Operation updateNetworkCameraWirelessProfileAsync

public updateNetworkCameraWirelessProfileAsync(string $network_id, string $wireless_profile_id[, UpdateNetworkCameraWirelessProfile $update_network_camera_wireless_profile = null ]) : PromiseInterface

Update an existing camera wireless profile in this network.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

$update_network_camera_wireless_profile : UpdateNetworkCameraWirelessProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateNetworkCameraWirelessProfileAsyncWithHttpInfo()

Operation updateNetworkCameraWirelessProfileAsyncWithHttpInfo

public updateNetworkCameraWirelessProfileAsyncWithHttpInfo(string $network_id, string $wireless_profile_id[, UpdateNetworkCameraWirelessProfile $update_network_camera_wireless_profile = null ]) : PromiseInterface

Update an existing camera wireless profile in this network.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

$update_network_camera_wireless_profile : UpdateNetworkCameraWirelessProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface —

updateNetworkCameraWirelessProfileWithHttpInfo()

Operation updateNetworkCameraWirelessProfileWithHttpInfo

public updateNetworkCameraWirelessProfileWithHttpInfo(string $network_id, string $wireless_profile_id[, UpdateNetworkCameraWirelessProfile $update_network_camera_wireless_profile = null ]) : array<string|int, mixed>

Update an existing camera wireless profile in this network.

Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

$update_network_camera_wireless_profile : UpdateNetworkCameraWirelessProfile = null

(optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
InvalidArgumentException
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
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
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
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed> —

of http client options

createNetworkCameraQualityRetentionProfileRequest()

Create request for operation 'createNetworkCameraQualityRetentionProfile'

protected createNetworkCameraQualityRetentionProfileRequest(string $network_id, CreateNetworkCameraQualityRetentionProfile $create_network_camera_quality_retention_profile) : Request
Parameters
$network_id : string

(required)

$create_network_camera_quality_retention_profile : CreateNetworkCameraQualityRetentionProfile

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

createNetworkCameraWirelessProfileRequest()

Create request for operation 'createNetworkCameraWirelessProfile'

protected createNetworkCameraWirelessProfileRequest(string $network_id, CreateNetworkCameraWirelessProfile $create_network_camera_wireless_profile) : Request
Parameters
$network_id : string

(required)

$create_network_camera_wireless_profile : CreateNetworkCameraWirelessProfile

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

deleteNetworkCameraQualityRetentionProfileRequest()

Create request for operation 'deleteNetworkCameraQualityRetentionProfile'

protected deleteNetworkCameraQualityRetentionProfileRequest(string $network_id, string $quality_retention_profile_id) : Request
Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

deleteNetworkCameraWirelessProfileRequest()

Create request for operation 'deleteNetworkCameraWirelessProfile'

protected deleteNetworkCameraWirelessProfileRequest(string $network_id, string $wireless_profile_id) : Request
Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

generateDeviceCameraSnapshotRequest()

Create request for operation 'generateDeviceCameraSnapshot'

protected generateDeviceCameraSnapshotRequest(string $serial[, GenerateDeviceCameraSnapshot $generate_device_camera_snapshot = null ]) : Request
Parameters
$serial : string

(required)

$generate_device_camera_snapshot : GenerateDeviceCameraSnapshot = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraAnalyticsLiveRequest()

Create request for operation 'getDeviceCameraAnalyticsLive'

protected getDeviceCameraAnalyticsLiveRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraAnalyticsOverviewRequest()

Create request for operation 'getDeviceCameraAnalyticsOverview'

protected getDeviceCameraAnalyticsOverviewRequest(string $serial[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, string $object_type = null ]) : Request
Parameters
$serial : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 7 days after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 7 days. The default is 1 hour. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraAnalyticsRecentRequest()

Create request for operation 'getDeviceCameraAnalyticsRecent'

protected getDeviceCameraAnalyticsRecentRequest(string $serial[, string $object_type = null ]) : Request
Parameters
$serial : string

(required)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraAnalyticsZoneHistoryRequest()

Create request for operation 'getDeviceCameraAnalyticsZoneHistory'

protected getDeviceCameraAnalyticsZoneHistoryRequest(string $serial, string $zone_id[, string $t0 = null ][, string $t1 = null ][, float $timespan = null ][, int $resolution = null ][, string $object_type = null ]) : Request
Parameters
$serial : string

(required)

$zone_id : string

(required)

$t0 : string = null

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

$t1 : string = null

The end of the timespan for the data. t1 can be a maximum of 14 hours after t0. (optional)

$timespan : float = null

The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 14 hours. The default is 1 hour. (optional)

$resolution : int = null

The time resolution in seconds for returned data. The valid resolutions are: 60. The default is 60. (optional)

$object_type : string = null

[optional] The object type for which analytics will be retrieved. The default object type is person. The available types are [person, vehicle]. (optional)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraAnalyticsZonesRequest()

Create request for operation 'getDeviceCameraAnalyticsZones'

protected getDeviceCameraAnalyticsZonesRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraQualityAndRetentionRequest()

Create request for operation 'getDeviceCameraQualityAndRetention'

protected getDeviceCameraQualityAndRetentionRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraSenseObjectDetectionModelsRequest()

Create request for operation 'getDeviceCameraSenseObjectDetectionModels'

protected getDeviceCameraSenseObjectDetectionModelsRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraSenseRequest()

Create request for operation 'getDeviceCameraSense'

protected getDeviceCameraSenseRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraVideoLinkRequest()

Create request for operation 'getDeviceCameraVideoLink'

protected getDeviceCameraVideoLinkRequest(string $serial[, DateTime $timestamp = null ]) : Request
Parameters
$serial : string

(required)

$timestamp : DateTime = null

[optional] The video link will start at this time. The timestamp should be a string in ISO8601 format. If no timestamp is specified, we will assume current time. (optional)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraVideoSettingsRequest()

Create request for operation 'getDeviceCameraVideoSettings'

protected getDeviceCameraVideoSettingsRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getDeviceCameraWirelessProfilesRequest()

Create request for operation 'getDeviceCameraWirelessProfiles'

protected getDeviceCameraWirelessProfilesRequest(string $serial) : Request
Parameters
$serial : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getNetworkCameraQualityRetentionProfileRequest()

Create request for operation 'getNetworkCameraQualityRetentionProfile'

protected getNetworkCameraQualityRetentionProfileRequest(string $network_id, string $quality_retention_profile_id) : Request
Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getNetworkCameraQualityRetentionProfilesRequest()

Create request for operation 'getNetworkCameraQualityRetentionProfiles'

protected getNetworkCameraQualityRetentionProfilesRequest(string $network_id) : Request
Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getNetworkCameraSchedulesRequest()

Create request for operation 'getNetworkCameraSchedules'

protected getNetworkCameraSchedulesRequest(string $network_id) : Request
Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getNetworkCameraWirelessProfileRequest()

Create request for operation 'getNetworkCameraWirelessProfile'

protected getNetworkCameraWirelessProfileRequest(string $network_id, string $wireless_profile_id) : Request
Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

getNetworkCameraWirelessProfilesRequest()

Create request for operation 'getNetworkCameraWirelessProfiles'

protected getNetworkCameraWirelessProfilesRequest(string $network_id) : Request
Parameters
$network_id : string

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

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
throws
InvalidArgumentException
Return values
Request —

updateDeviceCameraQualityAndRetentionRequest()

Create request for operation 'updateDeviceCameraQualityAndRetention'

protected updateDeviceCameraQualityAndRetentionRequest(string $serial[, UpdateDeviceCameraQualityAndRetention $update_device_camera_quality_and_retention = null ]) : Request
Parameters
$serial : string

(required)

$update_device_camera_quality_and_retention : UpdateDeviceCameraQualityAndRetention = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request —

updateDeviceCameraSenseRequest()

Create request for operation 'updateDeviceCameraSense'

protected updateDeviceCameraSenseRequest(string $serial[, UpdateDeviceCameraSense $update_device_camera_sense = null ]) : Request
Parameters
$serial : string

(required)

$update_device_camera_sense : UpdateDeviceCameraSense = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request —

updateDeviceCameraVideoSettingsRequest()

Create request for operation 'updateDeviceCameraVideoSettings'

protected updateDeviceCameraVideoSettingsRequest(string $serial[, UpdateDeviceCameraVideoSettings $update_device_camera_video_settings = null ]) : Request
Parameters
$serial : string

(required)

$update_device_camera_video_settings : UpdateDeviceCameraVideoSettings = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request —

updateDeviceCameraWirelessProfilesRequest()

Create request for operation 'updateDeviceCameraWirelessProfiles'

protected updateDeviceCameraWirelessProfilesRequest(string $serial, UpdateDeviceCameraWirelessProfiles $update_device_camera_wireless_profiles) : Request
Parameters
$serial : string

(required)

$update_device_camera_wireless_profiles : UpdateDeviceCameraWirelessProfiles

(required)

Tags
throws
InvalidArgumentException
Return values
Request —

updateNetworkCameraQualityRetentionProfileRequest()

Create request for operation 'updateNetworkCameraQualityRetentionProfile'

protected updateNetworkCameraQualityRetentionProfileRequest(string $network_id, string $quality_retention_profile_id[, UpdateNetworkCameraQualityRetentionProfile $update_network_camera_quality_retention_profile = null ]) : Request
Parameters
$network_id : string

(required)

$quality_retention_profile_id : string

(required)

$update_network_camera_quality_retention_profile : UpdateNetworkCameraQualityRetentionProfile = null

(optional)

Tags
throws
InvalidArgumentException
Return values
Request —

updateNetworkCameraWirelessProfileRequest()

Create request for operation 'updateNetworkCameraWirelessProfile'

protected updateNetworkCameraWirelessProfileRequest(string $network_id, string $wireless_profile_id[, UpdateNetworkCameraWirelessProfile $update_network_camera_wireless_profile = null ]) : Request
Parameters
$network_id : string

(required)

$wireless_profile_id : string

(required)

$update_network_camera_wireless_profile : UpdateNetworkCameraWirelessProfile = null

(optional)

Tags
throws
InvalidArgumentException
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)

Tags
throws
InvalidArgumentException
Return values
Request —

Search results