openapi: 3.0.3
info:
  title: WISK SOLUTIONS API
  description: |-
    description
  termsOfService: http://api.wisk.ai/terms/
  contact:
    email: apiteam@wisk.ai
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
externalDocs:
  description: Find out more about WISK SOLUTIONS API
  url: http://api.wisk.ai
servers:
  - url: https://api.wisk.ai
tags:
  - name: report_downloads
    description: Everything about downloading reports
    externalDocs:
      description: Find out more
      url: http://api.wisk.ai/docs
paths:
  /reports/id/{id}:
    get:
      tags:
        - report_downloads
      summary: Get an existing report by ID
      description: Get an existing report by ID
      operationId: getReportById
      parameters:
        - name: id
          in: path
          description: ID of report to return
          required: true
          schema:
            type: integer
      responses:
        200:
          description: Report exists and is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDownloads'
        400:
          description: Invalid ID supplied
      security:
        - bearerAuth: []
  /reports/id/{id}/downloaded:
    patch:
      tags:
        - report_downloads
      summary: Mark existing report as downloaded
      description: Mark existing report as downloaded
      operationId: markReportAsDownloaded
      parameters:
        - name: id
          in: path
          description: ID of report to return
          required: true
          schema:
            type: integer
      responses:
        200:
          description: Report is marked as downloaded
        400:
          description: Invalid ID supplied
      security:
        - bearerAuth: []
  /reports/all:
    get:
      tags:
        - report_downloads
      summary: Get all user reports
      description: Get all user reports
      operationId: getAllReports
      responses:
        200:
          description: All user reports are returned
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReportDownloads'
      security:
        - bearerAuth: []
  /reports/id/{id}/retry:
    get:
      tags:
        - report_downloads
      summary: Retry report generation by ID
      description: Retry report generation by ID
      operationId: retryReportGeneration
      parameters:
        - name: id
          in: path
          description: ID of report to return
          required: true
          schema:
            type: integer
      responses:
        200:
          description: Report generation is being retried
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportDownloads'
        400:
          description: Invalid ID supplied
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    ReportDownloads:
      type: object
      properties:
        id:
          type: integer
        content_hash:
          type: integer
        venue_id:
          type: integer
        user_id:
          type: integer
        url:
          type: string
        name:
          type: string
        file_type:
          type: string
          enum: [pdf]
        status:
          type: string
          enum: [ready, generating, invalid]
        report_category:
          type: string
          enum: [inventory, inventory_barcodes, consumption, variance, variance_overview, movements, bottles, recipe_book, items_by_location, transfer_requests_in_preparation, transfer_requests]
        is_valid:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        requested_at:
          type: string
          format: date-time
        downloaded_at:
          type: string
          format: date-time
        emailed_at:
          type: string
          format: date-time
      required:
        - id
        - content_hash
        - venue_id
        - user_id
        - name
        - file_type
        - status
        - report_category
        - is_valid
        - created_at