AlayaCare sequence inbox API

openapi: 3.0.0
info:
  version: 1.0.19-oas3
  title: AlayaCare Accounting Accounts sequence inbox API
  description: '**AlayaCare IDs:**

    The following terms are used to reference IDs that identify resources in AlayaCare:

    - id

    - visit_id

    - premium_id

    - visit_premium_id

    - employee_id

    - cost_centre_id

    - client_id


    **External IDs**

    The following terms are used to reference IDs that identify resources systems external to AlayaCare:

    - employee_external_id

    - client_external_id


    External IDs are required to be unique.

    No other assumptions are made regarding their format they are treated as strings.

    '
servers:
- url: https://example.alayacare.com/ext/api/v2/accounting
security:
- basic_auth: []
tags:
- name: sequence inbox
paths:
  /v1/inbox/sequences:
    get:
      tags:
      - sequence inbox
      description: '# Authorization

        Required role: `org_admin`


        # Description

        Get a paginated collection of sequences as a supply organization.

        '
      parameters:
      - in: query
        name: demand_persona_id
        schema:
          type: string
          format: uuid
        description: Filter sequences by demand organization ID.
        required: false
      - in: query
        name: sequence_id
        schema:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 100
        description: Filter by specific sequence IDs.
        required: false
      - in: query
        name: sort_by
        schema:
          type: string
          enum:
          - latest_message_created_at
          default: latest_message_created_at
      - $ref: '#/components/parameters/SortOrderParam'
      - $ref: '#/components/parameters/PageNumberParam'
      - $ref: '#/components/parameters/ItemsPerPageParam'
      responses:
        200:
          description: Successfully retrieved paginated sequences.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxSequencePageResponse'
      x-amazon-apigateway-integration:
        uri:
          Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OfferApiFunctionV2.Arn}:live/invocations
        httpMethod: POST
        passthroughBehavior: when_no_match
        type: aws_proxy
components:
  parameters:
    PageNumberParam:
      in: query
      name: page
      schema:
        $ref: '#/components/schemas/PageNumberCore'
    SortOrderParam:
      in: query
      name: sort_order
      schema:
        $ref: '#/components/schemas/SortOrderCore'
    ItemsPerPageParam:
      in: query
      name: items_per_page
      schema:
        $ref: '#/components/schemas/ItemsPerPageCore'
  schemas:
    SequenceLatestReferralResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
      required:
      - id
    DemographicLeanCore:
      type: object
      properties:
        first_name:
          type: string
          minLength: 1
        last_name:
          type: string
          minLength: 1
      required:
      - first_name
      - last_name
    SequenceOfferResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
      required:
      - id
    InboxSequencePageResponse:
      allOf:
      - $ref: '#/components/schemas/PageCore'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/InboxSequenceCollectionResponse'
        required:
        - items
    OrganizationLeanCore:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
      required:
      - id
      - name
    PageNumberCore:
      type: integer
      minimum: 1
      default: 1
    ItemsPerPageCore:
      type: integer
      minimum: 1
      default: 100
    InboxSequenceClientResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        demographics:
          $ref: '#/components/schemas/DemographicLeanCore'
    InboxSequenceCollectionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        demand:
          $ref: '#/components/schemas/OrganizationLeanCore'
        client:
          $ref: '#/components/schemas/InboxSequenceClientResponse'
        service:
          $ref: '#/components/schemas/InboxSequenceServiceResponse'
        latest_referral:
          $ref: '#/components/schemas/SequenceLatestReferralResponse'
        offer:
          $ref: '#/components/schemas/SequenceOfferResponse'
        latest_message_created_at:
          type: string
          format: date-time
      required:
      - id
      - created_at
      - demand
      - client
      - service
    SortOrderCore:
      type: string
      enum:
      - asc
      - desc
      default: desc
    PageCore:
      description: Root page schema for returning collections.
      type: object
      properties:
        page:
          $ref: '#/components/schemas/PageNumberCore'
        items_per_page:
          $ref: '#/components/schemas/ItemsPerPageCore'
        total_items:
          type: integer
          minimum: 0
        total_pages:
          type: integer
          minimum: 0
      required:
      - page
      - items_per_page
      - total_items
      - total_pages
    InboxSequenceServiceResponse:
      type: object
      properties:
        name:
          type: string
          minLength: 1
      required:
      - name
  securitySchemes:
    basic_auth:
      type: http
      description: Basic HTTP auth over https
      scheme: basic