openapi: 3.2.0
info:
  title: Kelowna Production Credit Files API
  version: v1
tags:
- name: CreditFiles
paths:
  /CreditFiles/UploadCementEPD:
    put:
      tags:
      - CreditFiles
      summary: Uploads an EPD for a particular cement
      parameters:
      - name: materialId
        in: query
        description: The ID of the cement material which the EPD applies to.
        schema:
          type: integer
          format: int32
      - name: publishDate
        in: query
        description: The publication date of the EPD / when its validity period starts.
        schema:
          type: string
          format: date
      - name: expirationDate
        in: query
        description: When the EPD expires / when its validity period ends.
        schema:
          type: string
          format: date
      - name: emissionsFactorTCO2PerTCement
        in: query
        description: "The emissions factor of the cement (measured in tonnes of CO2\n            per tonne of cement)."
        schema:
          type: number
          format: double
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: The EPD file.
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: OK
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: putCreditFilesUploadCementEPD
      x-operation-id-source: derived
  /CreditFiles/UploadNationalAverageEPD:
    put:
      tags:
      - CreditFiles
      summary: Uploads an industry average EPD for a particular country
      parameters:
      - name: country
        in: query
        description: The country which the EPD applies to.
        schema:
          type: string
      - name: cementType
        in: query
        description: The type of cement which the EPD applies to.
        schema:
          $ref: '#/components/schemas/MaterialType'
      - name: publishDate
        in: query
        description: The publication date of the EPD / when its validity period starts.
        schema:
          type: string
          format: date
      - name: expirationDate
        in: query
        description: When the EPD expires / when its validity period ends.
        schema:
          type: string
          format: date
      - name: emissionsFactorTCO2PerTCement
        in: query
        description: "The emissions factor of the cement (measured in tonnes of CO2\n            per tonne of cement)."
        schema:
          type: number
          format: double
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: The EPD file.
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: OK
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: putCreditFilesUploadNationalAverageEPD
      x-operation-id-source: derived
  /CreditFiles/UploadProducerAttestation:
    put:
      tags:
      - CreditFiles
      summary: Uploads a producer attestation file for a myCC account
      parameters:
      - name: accountId
        in: query
        description: The ID of the myCC account.
        schema:
          type: integer
          format: int32
      - name: attestationDate
        in: query
        description: The date when the producer made the attestation.
        schema:
          type: string
          format: date
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: The producer attestation file.
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: OK
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: putCreditFilesUploadProducerAttestation
      x-operation-id-source: derived
  /CreditFiles/ProducerAttestation/{accountId}:
    get:
      tags:
      - CreditFiles
      summary: Gets a producer attestation file
      parameters:
      - name: accountId
        in: path
        description: The ID of the myCC account to get the attestation for.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: getCreditFilesProducerAttestationByAccountId
      x-operation-id-source: derived
  /CreditFiles/UploadEgridSourceFile:
    put:
      tags:
      - CreditFiles
      summary: Uploads a source file for an egrid efficiency value
      parameters:
      - name: egridRegionId
        in: query
        description: The ID of the egrid region which the file applies to.
        schema:
          type: integer
          format: int32
      - name: publishDate
        in: query
        description: When the validity period for the file starts.
        schema:
          type: string
          format: date
      - name: expirationDate
        in: query
        description: When the validity period for the file ends.
        schema:
          type: string
          format: date
      - name: emissionsFactorTCO2ePerMwh
        in: query
        description: "The emissions factor of the grid (measured in tonnes of CO2 equivalent\n            per megawatt-hour)."
        schema:
          type: number
          format: double
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  description: The source file.
                  format: binary
            encoding:
              file:
                style: form
      responses:
        '200':
          description: OK
      security:
      - OrcaAuth:
        - applicationId
        - roles
      - {}
      - {}
      operationId: putCreditFilesUploadEgridSourceFile
      x-operation-id-source: derived
components:
  schemas:
    MaterialType:
      enum:
      - Cement
      - CementTypeI
      - CementTypeIS
      - CementTypeIP
      - CementTypeIL
      - CementTypeII
      - CementTypeI_II
      - CementTypeI_IIMH
      - CementTypeI_II_LA
      - CementTypeIII
      - CementTypeIV
      - CementTypeII_V
      - CementTypeN
      - CementTypeS
      - CementCemI
      - CementCemII
      - CementCemIII
      - CementCemIV
      - CementCemV
      - CementCemVI
      - CementBlendedHydraulic
      - CoarseAggregate
      - IntermediateAggregate
      - FineAggregate
      - Fiber
      - FiberTypeI
      - FiberTypeII
      - FiberTypeIII
      - FiberTypeIV
      - Water
      - CO2
      - SCM
      - Slag
      - SlagFerrous
      - SlagNonFerrous
      - SlagFerroalloy
      - FlyAsh
      - FlyAshC
      - FlyAshF
      - FlyAshN
      - SilicaFume
      - ReclaimedWater
      - Admixture
      - AirEntrainer
      - Retarder
      - SuperPlasticizer
      - WaterReducer
      - HighRangeWaterReducer
      - MidRangeWaterReducer
      - LowRangeWaterReducer
      - ViscosityModifier
      - HydrationStabilizer
      - CorrosionInhibitor
      - ShrinkageReducer
      - Accelerator
      - NonChlorideAccelerator
      - ChlorideAccelerator
      - StrengthEnhancer
      - AntiWashout
      - Waterproofer
      - Filler
      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: {}