openapi: 3.2.0
info:
  title: Kelowna Production myCC - Reports API
  version: v1
tags:
- name: myCC - Reports
paths:
  /Accounts/{accountId}/Reports/Insights:
    get:
      tags:
      - myCC - Reports
      summary: Generates an Insights Report PDF
      parameters:
      - name: accountId
        in: path
        description: The ID of the myCC account
        required: true
        schema:
          type: integer
          format: int32
      - name: remoteUnitIds
        in: query
        description: "The ready mix units to include in the report.\n            OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073"
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: startDate
        in: query
        description: Include data only from this date onwards
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Include data only up until this date
        schema:
          type: string
          format: date
      - name: language
        in: query
        description: Language for the pdf
        schema:
          type: string
      - name: rmIds
        in: query
        description: IDs of ready mix units to include in the report.
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdReportsInsights
      x-operation-id-source: derived
  /Accounts/{accountId}/Reports/Environmental:
    get:
      tags:
      - myCC - Reports
      summary: Generates an Environmental Report PDF
      parameters:
      - name: accountId
        in: path
        description: The ID of the myCC account
        required: true
        schema:
          type: integer
          format: int32
      - name: startDate
        in: query
        description: Include data only from this date onwards
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Include data only up until this date
        schema:
          type: string
          format: date
      - name: Name
        in: query
        schema:
          type: string
      - name: Email
        in: query
        schema:
          type: string
      - name: Phone
        in: query
        schema:
          type: string
      - name: Website
        in: query
        schema:
          type: string
      - name: language
        in: query
        description: Language for the pdf
        schema:
          type: string
      responses:
        '200':
          description: OK
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdReportsEnvironmental
      x-operation-id-source: derived
  /Accounts/{accountId}/Reports/Estimate:
    get:
      tags:
      - myCC - Reports
      summary: Generates an Estimate Report PDF
      parameters:
      - name: accountId
        in: path
        description: The ID of the myCC account
        required: true
        schema:
          type: integer
          format: int32
      - name: reportId
        in: query
        description: The ID of the estimate
        schema:
          type: string
      - name: language
        in: query
        description: Language for the pdf
        schema:
          type: string
      responses:
        '200':
          description: OK
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdReportsEstimate
      x-operation-id-source: derived
  /Accounts/{accountId}/Reports/Production:
    get:
      tags:
      - myCC - Reports
      summary: Generates a Production Report PDF
      parameters:
      - name: accountId
        in: path
        description: The ID of the myCC account
        required: true
        schema:
          type: integer
          format: int32
      - name: remoteUnitIds
        in: query
        description: "The ready mix units to include in the report.\n            OBSOLETE: Use `rmIds` instead: https://carboncure.atlassian.net/browse/KEL-3073"
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: groups
        in: query
        description: The groups of ready mix units to include in the report
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: Include data only from this date onwards
        schema:
          type: string
          format: date
      - name: endDate
        in: query
        description: Include data only up until this date
        schema:
          type: string
          format: date
      - name: productionGraphType
        in: query
        description: Which metric should be displayed in the charts
        schema:
          $ref: '#/components/schemas/ProductionGraphType'
      - name: timeZoneId
        in: query
        description: The user's timezone (used to display the current date)
        schema:
          type: string
      - name: language
        in: query
        description: Language for the pdf
        schema:
          type: string
      - name: rmIds
        in: query
        description: IDs of ready mix units to include in the report.
        schema:
          type: array
          items:
            type: integer
            format: int32
      responses:
        '200':
          description: OK
      security:
      - {}
      - MyCCAuth:
        - applicationId
        - roles
      - {}
      operationId: getAccountsByAccountIdReportsProduction
      x-operation-id-source: derived
components:
  schemas:
    ProductionGraphType:
      enum:
      - ConcreteProduction
      - CO2Injections
      - CO2Avoided
      - CO2Injected
      type: string
  securitySchemes:
    OrcaAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    MyCCAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}
    M2MAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.carboncure.com/oauth2/authorize
          tokenUrl: https://auth.carboncure.com/oauth2/token
          scopes: {}