#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = r"""
module: devices_wireless_zigbee_enrollments_info
short_description: Information module for devices _wireless _zigbee _enrollments
description:
  - Information module for Devices Wireless Zigbee Enrollments Info.
  - Get devices _wireless _zigbee _enrollments by id.
  - Return an enrollment.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.meraki.module_info
author: Francisco Munoz (@fmunoz)
options:
  headers:
    description: Additional headers.
    type: dict
  serial:
    description:
      - Information module for Devices Wireless Zigbee Enrollments Info.
      - Serial path parameter.
    type: str
  enrollmentId:
    description:
      - Information module for Devices Wireless Zigbee Enrollments Info.
      - EnrollmentId path parameter. Enrollment ID.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for wireless getDeviceWirelessZigbeeEnrollment
    description: Complete reference of the getDeviceWirelessZigbeeEnrollment API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-device-wireless-zigbee-enrollment
notes:
  - SDK Method used are
    wireless.Wireless.get_device_wireless_zigbee_enrollment,
  - Paths used are
    get /devices/{serial}/wireless/zigbee/enrollments/{enrollmentId},
"""

EXAMPLES = r"""
- name: Get devices _wireless _zigbee _enrollments by id
  cisco.meraki.devices_wireless_zigbee_enrollments_info:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    serial: string
    enrollmentId: string
  register: result
"""
RETURN = r"""
meraki_response:
  description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
  returned: always
  type: dict
  sample: >
    {
      "enrollmentId": "string",
      "url": "string",
      "request": {
        "serial": "string"
      },
      "status": "string",
      "enrollmentStartedAt": "string",
      "doorLocks": [
        {
          "doorLockId": "string",
          "name": "string",
          "shortId": "string",
          "lqi": "string",
          "rssi": "string",
          "status": "string",
          "eui64": "string",
          "enrolledAt": "string",
          "lastSeenAt": "string",
          "network": {
            "id": "string",
            "name": "string"
          },
          "gateway": {
            "name": "string",
            "serial": "string"
          }
        }
      ]
    }
"""
