openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva Tiers API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: Tiers
paths:
  /v2/tiers:
    get:
      summary: List Tiers
      tags:
      - Tiers
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TierList'
      parameters:
      - in: query
        name: segment
        description: Filter by segment
        schema:
          type: string
          enum:
          - drilling
          - completion
          - intervention
      - in: query
        name: page
        description: Number of page
        schema:
          type: integer
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      - in: query
        name: sort
        description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: name,-updated_at'
        schema:
          type: string
          enum:
          - name
          - price
          - created_at
          - updated_at
      - in: query
        name: order
        description: A sorting direction
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      operationId: getV2Tiers
      x-operation-id-source: derived
    post:
      summary: Create a Tier
      tags:
      - Tiers
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Created Tier
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TierPayload'
        description: Tier Payload
        required: true
      operationId: postV2Tiers
      x-operation-id-source: derived
  /v2/tiers/{id}:
    get:
      summary: Show Tier
      tags:
      - Tiers
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tier'
      parameters:
      - in: path
        name: id
        description: Tier ID
        required: true
        schema:
          type: integer
          format: int64
      operationId: getV2TiersById
      x-operation-id-source: derived
    patch:
      summary: Update a Tier
      tags:
      - Tiers
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Updated Tier
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tier'
      parameters:
      - in: path
        name: id
        description: Tier ID
        required: true
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TierPayload'
        description: Tier Payload
        required: true
      operationId: patchV2TiersById
      x-operation-id-source: derived
    delete:
      summary: Delete a Tier
      tags:
      - Tiers
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          description: Tier deleted
      parameters:
      - in: path
        name: id
        description: Tier ID
        required: true
        schema:
          type: integer
      operationId: deleteV2TiersById
      x-operation-id-source: derived
components:
  schemas:
    Tier:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: integer
              format: int64
            name:
              type: string
            price:
              type: float
            features:
              type: object
            segment:
              type: string
              enum:
              - drilling
              - completion
              - intervention
            be_apps_count:
              type: integer
              format: int64
            fe_apps_count:
              type: integer
              format: int64
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
        relationships:
          type: object
          properties:
            apps:
              type: object
              properties:
                data:
                  type: array
                  properties:
                    id:
                      type: integer
                      format: int64
                    type:
                      type: string
      example:
        id: 12345
        type: tier
        attributes:
          id: 12345
          name: Best Tier
          price: 19.95
          segment: drilling
          features:
            alert_count: 10
            asset_count: 5
            user_count: 5
            api_access: true
            data_quality: true
            mobile_apps: true
            sso: true
            wellview_integration: true
          be_apps_count: 2
          fe_apps_count: 2
          created_at: '2010-01-01T00:00:00.000Z'
          updated_at: '2010-01-01T00:00:00.000Z'
        relationships:
          apps:
          - id: '1'
            type: app
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    TierPayload:
      properties:
        tier:
          type: object
          properties:
            name:
              type: string
            price:
              type: float
            segment:
              type: string
              enum:
              - drilling
              - completion
              - intervention
            features:
              type: object
            app_ids:
              type: array
              items:
                type: integer
      example:
        tier:
          name: Best Tier
          price: 19.95
          segment: drilling
          features:
            alert_count: 10
            asset_count: 5
            user_count: 5
            api_access: true
            data_quality: true
            mobile_apps: true
            sso: true
            wellview_integration: true
          app_ids:
          - 12345
          - 40345
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    TierList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Tier'
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header