#!/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: organizations_sensor_gateways_connections_latest_info
short_description: Information module for organizations _sensor _gateways _connections
  _latest
description:
  - Information module for Organizations Sensor Gateways Connections Latest Info.
  - Get all organizations _sensor _gateways _connections _latest.
  - Returns latest sensor-gateway connectivity data.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.meraki.module_info
  - cisco.meraki.module_info_pagination
author: Francisco Munoz (@fmunoz)
options:
  headers:
    description: Additional headers.
    type: dict
  organizationId:
    description:
      - Information module for Organizations Sensor Gateways Connections Latest Info.
      - OrganizationId path parameter. Organization ID.
    type: str
  sensorSerials:
    description:
      - Information module for Organizations Sensor Gateways Connections Latest Info.
      - SensorSerials query parameter. List of sensor serials to filter connectivity
        data by sensor.
    elements: str
    type: list
  perPage:
    description:
      - Information module for Organizations Sensor Gateways Connections Latest Info.
      - PerPage query parameter. The number of entries per page returned. Acceptable
        range is 3 - 1000. Default is 1000.
    type: int
  startingAfter:
    description:
      - Information module for Organizations Sensor Gateways Connections Latest Info.
      - >
        StartingAfter query parameter. A token used by the server to indicate the
        start of the page. Often this is a timestamp or an ID but it is not limited
        to those. This parameter should not be defined by client applications. The
        link for the first, last, prev, or next page in the HTTP Link header should
        define it.
    type: str
  endingBefore:
    description:
      - Information module for Organizations Sensor Gateways Connections Latest Info.
      - >
        EndingBefore query parameter. A token used by the server to indicate the end
        of the page. Often this is a timestamp or an ID but it is not limited to those.
        This parameter should not be defined by client applications. The link for
        the first, last, prev, or next page in the HTTP Link header should define
        it.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for sensor getOrganizationSensorGatewaysConnectionsLatest
    description: Complete reference of the getOrganizationSensorGatewaysConnectionsLatest
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-organization-sensor-gateways-connections-latest
notes:
  - SDK Method used are
    sensor.Sensor.get_organization_sensor_gateways_connections_latest,
  - Paths used are
    get /organizations/{organizationId}/sensor/gateways/connections/latest,
"""

EXAMPLES = r"""
- name: Get all organizations _sensor _gateways _connections _latest
  cisco.meraki.organizations_sensor_gateways_connections_latest_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 }}"
    sensorSerials: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  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: >
    {
      "items": [
        {
          "lastReportedAt": "string",
          "lastConnectedAt": "string",
          "rssi": 0,
          "network": {
            "name": "string",
            "id": "string"
          },
          "sensor": {
            "serial": "string",
            "name": "string",
            "mac": "string"
          },
          "gateway": {
            "serial": "string",
            "name": "string",
            "mac": "string"
          }
        }
      ],
      "meta": {
        "counts": {
          "items": {
            "total": 0,
            "remaining": 0
          }
        }
      }
    }
"""
