#!/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_floor_plans_auto_locate_statuses_info
short_description: Information module for organizations _floor _plans _auto _locate
  _statuses
description:
  - Information module for Organizations Floor Plans Auto Locate Statuses Info.
  - Get all organizations _floor _plans _auto _locate _statuses.
  - List the status of auto locate for each floorplan in your 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 Floor Plans Auto Locate Statuses Info.
      - OrganizationId path parameter. Organization ID.
    type: str
  perPage:
    description:
      - Information module for Organizations Floor Plans Auto Locate Statuses Info.
      - PerPage query parameter. The number of entries per page returned. Acceptable
        range is 3 - 10000. Default is 1000.
    type: int
  startingAfter:
    description:
      - Information module for Organizations Floor Plans Auto Locate Statuses 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 Floor Plans Auto Locate Statuses 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
  networkIds:
    description:
      - Information module for Organizations Floor Plans Auto Locate Statuses Info.
      - NetworkIds query parameter. Optional parameter to filter floorplans by one
        or more network IDs.
    elements: str
    type: list
  floorPlanIds:
    description:
      - Information module for Organizations Floor Plans Auto Locate Statuses Info.
      - FloorPlanIds query parameter. Optional parameter to filter floorplans by one
        or more floorplan IDs.
    elements: str
    type: list
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for organizations getOrganizationFloorPlansAutoLocateStatuses
    description: Complete reference of the getOrganizationFloorPlansAutoLocateStatuses
      API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-organization-floor-plans-auto-locate-statuses
notes:
  - SDK Method used are
    organizations.Organizations.get_organization_floor_plans_auto_locate_statuses,
  - Paths used are
    get /organizations/{organizationId}/floorPlans/autoLocate/statuses,
"""

EXAMPLES = r"""
- name: Get all organizations _floor _plans _auto _locate _statuses
  cisco.meraki.organizations_floor_plans_auto_locate_statuses_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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkIds: []
    floorPlanIds: []
    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: >
    [
      {
        "items": [
          {
            "network": {
              "id": "string"
            },
            "floorPlanId": "string",
            "name": "string",
            "counts": {
              "devices": {
                "total": 0
              }
            },
            "jobs": [
              {
                "id": "string",
                "status": "string",
                "scheduledAt": "string",
                "completed": {
                  "percentage": 0
                },
                "ranging": {
                  "status": "string",
                  "completed": {
                    "percentage": 0
                  }
                },
                "gnss": {
                  "status": "string",
                  "completed": {
                    "percentage": 0
                  }
                },
                "errors": [
                  {
                    "source": "string",
                    "type": "string"
                  }
                ]
              }
            ]
          }
        ],
        "meta": {
          "counts": {
            "items": {
              "total": 0,
              "remaining": 0
            }
          }
        }
      }
    ]
"""
