openapi: 3.0.3
info:
  title: Puzzle Api Accounts Tasks API
  description: Puzzle Api
  version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Tasks
paths:
  /company/{id}/tasks:
    get:
      operationId: tasks
      summary: Get Tasks
      description: 'This endpoint is experimental and is subject to change


        Retrieves a list of tasks for the company. Tasks represent work items that need to be completed, such as categorization reviews, documentation requests, or messages.


        Required scope: read:company'
      tags:
      - Tasks
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: array
            items:
              type: string
      - name: assigneeIds
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            description: Partner-facing external identifier
          - type: array
            items:
              type: string
              minLength: 1
              description: Partner-facing external identifier
      - name: transactionIds
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            minLength: 1
            description: Partner-facing external identifier
          - type: array
            items:
              type: string
              minLength: 1
              description: Partner-facing external identifier
      - name: createdBy
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      - name: createdAfter
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          description: ISO 8601 timestamp
      - name: count
        in: query
        required: false
        schema:
          type: integer
      - name: after
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        companyId:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        type:
                          type: string
                          enum:
                          - CategoryReview
                          - Documentation
                          - Message
                        status:
                          type: string
                          enum:
                          - Open
                          - Completed
                          - Cancelled
                        transactionId:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                          nullable: true
                        createdBy:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                          nullable: true
                        modifiedBy:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                          nullable: true
                        assignees:
                          type: array
                          items:
                            type: string
                            minLength: 1
                            description: Partner-facing external identifier
                          nullable: true
                        text:
                          type: string
                          nullable: true
                      required:
                      - id
                      - companyId
                      - type
                      - status
                      - transactionId
                      - createdBy
                      - modifiedBy
                      - assignees
                      - text
                  pageInfo:
                    type: object
                    properties:
                      endCursor:
                        type: string
                        nullable: true
                      hasNextPage:
                        type: boolean
                      total:
                        type: integer
                        nullable: true
                    required:
                    - endCursor
                    - hasNextPage
                    - total
                required:
                - items
                - pageInfo
    post:
      operationId: createTask
      summary: Create Task
      description: 'This endpoint is experimental and is subject to change


        Click here for more information.


        Create a task for the given company.


        Required scope: write:task'
      tags:
      - Tasks
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - CategoryReview
                  - Documentation
                  - Message
                transactionId:
                  type: string
                  minLength: 1
                  description: Partner-facing external identifier
                assignees:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                text:
                  type: string
              required:
              - type
              - transactionId
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                  companyId:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                  type:
                    type: string
                    enum:
                    - CategoryReview
                    - Documentation
                    - Message
                  status:
                    type: string
                    enum:
                    - Open
                    - Completed
                    - Cancelled
                  transactionId:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                    nullable: true
                  createdBy:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                    nullable: true
                  modifiedBy:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                    nullable: true
                  assignees:
                    type: array
                    items:
                      type: string
                      minLength: 1
                      description: Partner-facing external identifier
                    nullable: true
                  text:
                    type: string
                    nullable: true
                  createdAt:
                    type: string
                    minLength: 1
                    description: ISO 8601 timestamp
                  updatedAt:
                    type: string
                    minLength: 1
                    description: ISO 8601 timestamp
                required:
                - id
                - companyId
                - type
                - status
                - transactionId
                - createdBy
                - modifiedBy
                - assignees
                - text
                - createdAt
                - updatedAt
  /company/{id}/tasks/{taskId}:
    patch:
      operationId: updateTask
      summary: Update Task
      description: 'This endpoint is experimental and is subject to change


        Click here for more information.


        Update a task for the given company.


        Required scope: write:task'
      tags:
      - Tasks
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      - name: taskId
        in: path
        required: true
        description: The task ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                  - Open
                  - Completed
                  - Cancelled
                assignees:
                  type: array
                  items:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                text:
                  type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                  companyId:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                  type:
                    type: string
                    enum:
                    - CategoryReview
                    - Documentation
                    - Message
                  status:
                    type: string
                    enum:
                    - Open
                    - Completed
                    - Cancelled
                  transactionId:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                    nullable: true
                  createdBy:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                    nullable: true
                  modifiedBy:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                    nullable: true
                  assignees:
                    type: array
                    items:
                      type: string
                      minLength: 1
                      description: Partner-facing external identifier
                    nullable: true
                  text:
                    type: string
                    nullable: true
                required:
                - id
                - companyId
                - type
                - status
                - transactionId
                - createdBy
                - modifiedBy
                - assignees
                - text