#!/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_wireless_devices_packet_loss_by_client_info
short_description: Information module for organizations _wireless _devices _packetloss
  _byclient
description:
  - Information module for Organizations Wireless Devices Packetloss Byclient Info.
  - Get all organizations _wireless _devices _packetloss _byclient.
  - Get average packet loss for the given timespan for all clients in the organization.
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 Wireless Devices Packetloss Byclient Info.
      - OrganizationId path parameter. Organization ID.
    type: str
  networkIds:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - NetworkIds query parameter. Filter results by network.
    elements: str
    type: list
  ssids:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - Ssids query parameter. Filter results by SSID number.
    elements: int
    type: list
  bands:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - Bands query parameter. Filter results by band. Valid bands are 2.4, 5, and
        6.
    elements: str
    type: list
  macs:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - Macs query parameter. Filter results by client mac address(es).
    elements: str
    type: list
  perPage:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient 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 Wireless Devices Packetloss Byclient 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 Wireless Devices Packetloss Byclient 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
  t0:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - T0 query parameter. The beginning of the timespan for the data. The maximum
        lookback period is 90 days from today.
    type: str
  t1:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - T1 query parameter. The end of the timespan for the data. T1 can be a maximum
        of 90 days after t0.
    type: str
  timespan:
    description:
      - Information module for Organizations Wireless Devices Packetloss Byclient Info.
      - >
        Timespan query parameter. 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 greater than or equal to 5 minutes and be less than or
        equal to 90 days. The default is 7 days.
    type: float
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for wireless getOrganizationWirelessDevicesPacketLossByClient
    description: Complete reference of the getOrganizationWirelessDevicesPacketLossByClient
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-organization-wireless-devices-packet-loss-by-client
notes:
  - SDK Method used are
    wireless.Wireless.get_organization_wireless_devices_packet_loss_by_client,
  - Paths used are
    get /organizations/{organizationId}/wireless/devices/packetLoss/byClient,
"""

EXAMPLES = r"""
- name: Get all organizations _wireless _devices _packetloss _byclient
  cisco.meraki.organizations_wireless_devices_packet_loss_by_client_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 }}"
    networkIds: []
    ssids: []
    bands: []
    macs: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    t0: string
    t1: string
    timespan: 0
    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: list
  elements: dict
  sample: >
    [
      {
        "downstream": {
          "total": 0,
          "lost": 0,
          "lossPercentage": 0
        },
        "upstream": {
          "total": 0,
          "lost": 0,
          "lossPercentage": 0
        },
        "client": {
          "id": "string",
          "mac": "string"
        },
        "network": {
          "id": "string",
          "name": "string"
        }
      }
    ]
"""
