Interface IOrganizationsWirelessZigbee

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

I Organizations Wireless Zigbee

public interface IOrganizationsWirelessZigbee

Methods

CreateOrganizationWirelessZigbeeDisenrollmentAsync(string, OrganizationZigbeeDisenrollmentRequest, CancellationToken)

Enqueue a job to start disenrolling doorlocks on zigbee configured MRs

[Post("/organizations/{organizationId}/wireless/zigbee/disenrollments")]
Task<OrganizationZigbeeDisenrollment> CreateOrganizationWirelessZigbeeDisenrollmentAsync(string organizationId, OrganizationZigbeeDisenrollmentRequest organizationZigbeeDisenrollmentRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

organizationZigbeeDisenrollmentRequest OrganizationZigbeeDisenrollmentRequest

The request body

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationZigbeeDisenrollment>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWirelessZigbeeDisenrollmentAsync(string, string, CancellationToken)

Return a disenrollment job

[Get("/organizations/{organizationId}/wireless/zigbee/disenrollments/{disenrollmentId}")]
Task<OrganizationZigbeeDisenrollmentDetailed> GetOrganizationWirelessZigbeeDisenrollmentAsync(string organizationId, string disenrollmentId, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

disenrollmentId string

Disenrollment ID

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationZigbeeDisenrollmentDetailed>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWirelessZigbeeDoorLocksAsync(string, CancellationToken)

Return the list of doorlocks for a network

[Get("/organizations/{organizationId}/wireless/zigbee/doorLocks")]
Task<List<OrganizationZigbeeDoorLockDetailed>> GetOrganizationWirelessZigbeeDoorLocksAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

cancellationToken CancellationToken

The cancellation token

Returns

Task<List<OrganizationZigbeeDoorLockDetailed>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationZigbeeDevicesAsync(string, CancellationToken)

List the Zigbee MR Nodes for and organization or the supplied network(s)

[Get("/organizations/{organizationId}/wireless/zigbee/devices")]
Task<List<OrganizationZigbeeDevice>> GetOrganizationZigbeeDevicesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

cancellationToken CancellationToken

The cancellation token

Returns

Task<List<OrganizationZigbeeDevice>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationZigbeesByNetworkAsync(string, CancellationToken)

Return list of Zigbee configs

[Get("/organizations/{organizationId}/wireless/zigbee/byNetwork")]
Task<List<OrganizationZigbeeConfiguration>> GetOrganizationZigbeesByNetworkAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

cancellationToken CancellationToken

The cancellation token

Returns

Task<List<OrganizationZigbeeConfiguration>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationWirelessZigbeeDoorLockAsync(string, string, OrganizationZigbeeDoorLockUpdateRequest, CancellationToken)

Endpoint to bulk update door locks params

[Put("/organizations/{organizationId}/wireless/zigbee/doorLocks/{doorlockId}")]
Task<OrganizationZigbeeDoorLockDetailed> UpdateOrganizationWirelessZigbeeDoorLockAsync(string organizationId, string doorlockId, OrganizationZigbeeDoorLockUpdateRequest organizationZigbeeDoorLockUpdateRequest, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

doorlockId string

Door Lock ID

organizationZigbeeDoorLockUpdateRequest OrganizationZigbeeDoorLockUpdateRequest

The update request

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationZigbeeDoorLockDetailed>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationZigbeeDeviceAsync(string, string, OrganizationZigbeeDeviceUpdateRequest, CancellationToken)

Endpoint to update zigbee gateways

[Put("/organizations/{organizationId}/wireless/zigbee/devices/{id}")]
Task<OrganizationZigbeeDevice> UpdateOrganizationZigbeeDeviceAsync(string organizationId, string id, OrganizationZigbeeDeviceUpdateRequest organizationZigbeeDeviceUpdate, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID

id string

ID

organizationZigbeeDeviceUpdate OrganizationZigbeeDeviceUpdateRequest

The request body

cancellationToken CancellationToken

The cancellation token

Returns

Task<OrganizationZigbeeDevice>

Exceptions

ApiException

Thrown when fails to make API call