#!/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_firmware_upgrades_info
short_description: Information module for organizations _firmware _upgrades
description:
- Get all organizations _firmware _upgrades.
- Get firmware upgrade information for an organization.
version_added: '2.16.0'
extends_documentation_fragment:
  - cisco.meraki.module_info
author: Francisco Munoz (@fmunoz)
options:
  headers:
    description: Additional headers.
    type: dict
  organizationId:
    description:
    - OrganizationId path parameter. Organization ID.
    type: str
  status:
    description:
    - Status query parameter. The status of an upgrade.
    elements: str
    type: list
  productType:
    description:
    - ProductType query parameter. The product type in a given upgrade ID.
    elements: str
    type: list
requirements:
- meraki >= 2.4.9
- python >= 3.5
seealso:
- name: Cisco Meraki documentation for organizations getOrganizationFirmwareUpgrades
  description: Complete reference of the getOrganizationFirmwareUpgrades API.
  link: https://developer.cisco.com/meraki/api-v1/#!get-organization-firmware-upgrades
notes:
  - SDK Method used are
    organizations.Organizations.get_organization_firmware_upgrades,

  - Paths used are
    get /organizations/{organizationId}/firmware/upgrades,
"""

EXAMPLES = r"""
- name: Get all organizations _firmware _upgrades
  cisco.meraki.organizations_firmware_upgrades_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_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
    meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
    status: []
    productType: []
    organizationId: 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: list
  elements: dict
  sample: >
    [
      {
        "upgradeId": "string",
        "upgradeBatchId": "string",
        "network": {
          "id": "string",
          "name": "string"
        },
        "status": "string",
        "time": "string",
        "completedAt": "string",
        "productType": "string",
        "toVersion": {
          "id": "string",
          "shortName": "string",
          "releaseType": "string",
          "releaseDate": "string"
        },
        "fromVersion": {
          "id": "string",
          "shortName": "string",
          "releaseType": "string",
          "releaseDate": "string"
        }
      }
    ]
"""
