openapi: 3.1.0
info:
  title: API Reference
  version: 1.0.0
paths:
  /accounts/current:
    get:
      operationId: get-current
      summary: Get the current account
      description: Get the current account
      tags:
      - subpackage_accounts
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_accounts:AccountResponse'
    patch:
      operationId: update-current
      summary: Update the current account
      description: Update the current account
      tags:
      - subpackage_accounts
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_accounts:AccountResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_accounts:AccountPatch'
  /actions:
    post:
      operationId: create
      summary: Create an action
      tags:
      - subpackage_actions
      parameters:
      - name: spaceId
        in: query
        description: The Space ID for which to create the Action.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_actions:APIActionResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_commons:APIActionConfig'
    get:
      operationId: get-all
      summary: Get all actions for the space
      tags:
      - subpackage_actions
      parameters:
      - name: spaceId
        in: query
        description: The Space ID for which to get the Actions.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_actions:APIActionsResponse'
  /actions/bulk:
    post:
      operationId: bulk-create
      summary: Create several actions
      tags:
      - subpackage_actions
      parameters:
      - name: spaceId
        in: query
        description: The Space ID for which to create the Actions.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_actions:APIActionsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_actions:APIActionConfigs'
  /actions/{actionId}:
    get:
      operationId: get
      summary: Get an action
      tags:
      - subpackage_actions
      parameters:
      - name: actionId
        in: path
        description: The id of the action to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ActionId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_actions:APIActionResponse'
    patch:
      operationId: update
      summary: Update an action
      tags:
      - subpackage_actions
      parameters:
      - name: actionId
        in: path
        description: The id of the action to patch
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ActionId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_actions:APIActionResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_commons:ActionUpdate'
    delete:
      operationId: delete
      summary: Delete an action
      tags:
      - subpackage_actions
      parameters:
      - name: actionId
        in: path
        description: The id of the action to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ActionId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /agent-exports:
    get:
      operationId: list
      summary: List agent exports
      tags:
      - subpackage_agent-exports
      parameters:
      - name: environmentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: agentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: pageSize
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageSize'
      - name: pageNumber
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageNumber'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agent-exports:ListAgentExportsResponse'
  /agent-exports/{agentExportId}:
    get:
      operationId: get
      summary: Get an agent export
      tags:
      - subpackage_agent-exports
      parameters:
      - name: agentExportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentExportId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agent-exports:GetAgentExportResponse'
    delete:
      operationId: delete
      summary: Delete an agent export
      tags:
      - subpackage_agent-exports
      parameters:
      - name: agentExportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentExportId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /agent-exports/{agentExportId}/download:
    get:
      operationId: download
      summary: Download an agent export
      tags:
      - subpackage_agent-exports
      parameters:
      - name: agentExportId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentExportId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /agents:
    get:
      operationId: list
      summary: List agents
      tags:
      - subpackage_agents
      parameters:
      - name: environmentId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: isSystem
        in: query
        required: false
        schema:
          type: boolean
      - name: search
        in: query
        required: false
        schema:
          type: string
      - name: pageSize
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageSize'
      - name: pageNumber
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageNumber'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:ListAgentsResponse'
    post:
      operationId: create
      summary: Create an agent
      tags:
      - subpackage_agents
      parameters:
      - name: environmentId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:AgentResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_agents:AgentConfig'
  /agents/{agentId}:
    get:
      operationId: get
      summary: Get an agent
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: environmentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:AgentResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    delete:
      operationId: delete
      summary: Delete an agent
      description: Deletes a single agent
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: environmentId
        in: query
        description: This environment variable is no longer needed or used
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/{agentId}/versions:
    get:
      operationId: list-versions
      summary: List agent versions for an agent
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:ListAgentVersionsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/{agentId}/versions/{agentVersionId}/revert:
    get:
      operationId: revert
      summary: Revert to a specific agent version
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: agentVersionId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentVersionId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:AgentVersionResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/{agentId}/roles:
    get:
      operationId: list-agent-roles
      summary: List Agent Roles
      description: Lists roles assigned to an agent.
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        description: The agent id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:ListActorRolesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: assign-agent-role
      summary: Assign Role to Agent
      description: Assigns a role to a agent.
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        description: The agent id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:AssignRoleResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_roles:AssignActorRoleRequest'
  /agents/{agentId}/roles/{actorRoleId}:
    delete:
      operationId: delete-agent-role
      summary: Remove Role from Agent
      description: Removes a role from an agent.
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        description: The agent id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: actorRoleId
        in: path
        description: The actor role id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ActorRoleId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/{agentId}/logs:
    get:
      operationId: get-agent-logs
      summary: Get logs for an agent
      tags:
      - subpackage_agents
      parameters:
      - name: agentId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: environmentId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:GetAgentLogsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/log/{eventId}:
    get:
      operationId: get-agent-log
      summary: Get an agent log
      tags:
      - subpackage_agents
      parameters:
      - name: eventId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EventId'
      - name: environmentId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:GetDetailedAgentLogResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/logs:
    get:
      operationId: get-environment-agent-logs
      summary: Get all agent logs in your environment
      tags:
      - subpackage_agents
      parameters:
      - name: environmentId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: spaceId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: success
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SuccessQueryParameter'
      - name: pageSize
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageSize'
      - name: pageNumber
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageNumber'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:GetDetailedAgentLogsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /agents/executions:
    get:
      operationId: get-environment-agent-executions
      summary: Get all executions in your environment
      tags:
      - subpackage_agents
      parameters:
      - name: environmentId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: agentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:AgentId'
      - name: spaceId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: success
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SuccessQueryParameter'
      - name: pageSize
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageSize'
      - name: pageNumber
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageNumber'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_agents:GetExecutionsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /apps:
    get:
      operationId: list
      summary: List apps
      description: Returns apps in an account
      tags:
      - subpackage_apps
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:AppsResponse'
    post:
      operationId: create
      summary: Create an app
      description: Creates an app
      tags:
      - subpackage_apps
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:AppResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_apps:AppCreate'
  /apps/{appId}:
    get:
      operationId: get
      summary: Get an app
      description: Returns an app
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:AppResponse'
    patch:
      operationId: update
      summary: Update an app
      description: Updates an app
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:AppResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_apps:AppPatch'
    delete:
      operationId: delete
      summary: Delete an app
      description: Deletes an app
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of app to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:SuccessResponse'
  /apps/{appId}/constraints:
    get:
      operationId: get-constraints
      summary: Get constraints
      description: Returns constraints for an app
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: includeBuiltins
        in: query
        description: Whether to include built-in constraints
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:ConstraintsResponse'
    post:
      operationId: create-constraint
      summary: Create constraint
      description: Creates a new constraint for an app
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:ConstraintResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_apps:ConstraintCreate'
  /apps/{appId}/constraints/{constraintId}:
    get:
      operationId: get-constraint-by-id
      summary: Get constraint by ID
      description: Returns a specific constraint
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: constraintId
        in: path
        description: ID of the constraint
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ConstraintId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:ConstraintResponse'
    patch:
      operationId: update-constraint
      summary: Update constraint
      description: Updates a specific constraint
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: constraintId
        in: path
        description: ID of the constraint
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ConstraintId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:ConstraintResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_apps:ConstraintUpdate'
    delete:
      operationId: delete-constraint
      summary: Delete constraint
      description: Deletes a specific constraint
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: constraintId
        in: path
        description: ID of the constraint
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ConstraintId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:SuccessResponse'
  /apps/{appId}/constraints/{constraintId}/versions:
    get:
      operationId: get-constraint-versions
      summary: Get constraint versions
      description: Returns the versions of a specific constraint
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: constraintId
        in: path
        description: ID of the constraint
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ConstraintId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:ConstraintVersionsResponse'
  /apps/{appId}/constraints/{constraintId}/versions/{version}:
    get:
      operationId: get-constraint-version
      summary: Get constraint version
      description: Returns a specified version of a specific constraint
      tags:
      - subpackage_apps
      parameters:
      - name: appId
        in: path
        description: ID of the app
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: constraintId
        in: path
        description: ID of the constraint
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ConstraintId'
      - name: version
        in: path
        description: Version of the constraint
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_apps:ConstraintVersionResponse'
  //prompts:
    get:
      operationId: list
      summary: List prompts
      description: Returns prompts created by user
      tags:
      - subpackage_assistant
      parameters:
      - name: promptType
        in: query
        description: Type of prompt (default AI_ASSIST)
        required: false
        schema:
          $ref: '#/components/schemas/type_assistant:PromptTypeQueryEnum'
      - name: pageSize
        in: query
        description: Number of prompts to return in a page (default 7)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of prompts to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_assistant:PromptsResponse'
    post:
      operationId: create
      summary: Create a prompt
      description: Creates a prompt
      tags:
      - subpackage_assistant
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_assistant:PromptResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_assistant:PromptCreate'
  //prompts/{promptId}:
    get:
      operationId: get
      summary: Get a prompt
      description: Returns a prompt
      tags:
      - subpackage_assistant
      parameters:
      - name: promptId
        in: path
        description: ID of prompts
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:PromptId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_assistant:PromptResponse'
    patch:
      operationId: update
      summary: Update a prompt
      description: Updates a prompt
      tags:
      - subpackage_assistant
      parameters:
      - name: promptId
        in: path
        description: ID of prompts
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:PromptId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_assistant:PromptResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_assistant:PromptPatch'
    delete:
      operationId: delete
      summary: Delete a prompts
      description: Deletes a prompts
      tags:
      - subpackage_assistant
      parameters:
      - name: promptId
        in: path
        description: ID of prompts
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:PromptId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /auth/publishable-key:
    get:
      operationId: get-publishable-key
      summary: Obtain the publishable key for a specific environment
      tags:
      - subpackage_auth
      parameters:
      - name: environmentId
        in: query
        description: ID of environment to search
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_auth:PublishableKeyResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /auth/sftp-credentials:
    get:
      operationId: get-sftp-credentials
      summary: Get SFTP credentials for Space
      tags:
      - subpackage_auth
      parameters:
      - name: spaceId
        in: query
        description: ID of space to get credentials for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_auth:SftpCredentials'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /canvas-areas:
    get:
      operationId: list
      summary: List canvas areas
      description: Returns a list of canvas areas filtered by canvas, space, or environment
      tags:
      - subpackage_canvas-areas
      parameters:
      - name: canvasId
        in: query
        description: ID of the canvas to filter areas by
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CanvasId'
      - name: parentId
        in: query
        description: ID of the parent canvas area to filter by
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CanvasAreaId'
      - name: spaceId
        in: query
        description: ID of the space to filter areas by
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: environmentId
        in: query
        description: ID of the environment to filter areas by
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: pageSize
        in: query
        description: Number of areas to return in a page (default 20)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of areas to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_canvas-areas:ListCanvasAreasResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a canvas area
      description: Creates a new canvas area
      tags:
      - subpackage_canvas-areas
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_canvas-areas:CanvasAreaResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                canvasId:
                  $ref: '#/components/schemas/type_commons:CanvasId'
                type:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaType'
                position:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaPosition'
                visibility:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaVisibility'
                layout:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaLayout'
                overlay:
                  description: Any type
                config:
                  description: Any type
                metadata:
                  description: Any type
                parentId:
                  $ref: '#/components/schemas/type_commons:CanvasAreaId'
              required:
              - canvasId
              - type
              - position
  /canvas-areas/{canvasAreaId}:
    get:
      operationId: get
      summary: Get a canvas area
      description: Returns a specific canvas area by ID
      tags:
      - subpackage_canvas-areas
      parameters:
      - name: canvasAreaId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:CanvasAreaId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_canvas-areas:CanvasAreaResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a canvas area
      description: Updates an existing canvas area
      tags:
      - subpackage_canvas-areas
      parameters:
      - name: canvasAreaId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:CanvasAreaId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_canvas-areas:CanvasAreaResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaType'
                position:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaPosition'
                visibility:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaVisibility'
                layout:
                  $ref: '#/components/schemas/type_canvas-areas:CanvasAreaLayout'
                overlay:
                  description: Any type
                config:
                  description: Any type
                metadata:
                  description: Any type
                parentId:
                  $ref: '#/components/schemas/type_commons:CanvasAreaId'
                canvasId:
                  $ref: '#/components/schemas/type_commons:CanvasId'
    delete:
      operationId: delete
      summary: Delete a canvas area
      description: Deletes a specific canvas area
      tags:
      - subpackage_canvas-areas
      parameters:
      - name: canvasAreaId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:CanvasAreaId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /commits/{commitId}:
    get:
      operationId: get
      summary: Get a commit version
      description: Returns the details of a commit version
      tags:
      - subpackage_commits
      parameters:
      - name: commitId
        in: path
        description: ID of the commit version to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commits:CommitResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /commits/{commitId}/complete:
    post:
      operationId: complete
      summary: Complete a commit version
      description: Completes a commit version. This marks the commit as complete and
        acknowledges that the changes have been applied to the sheet.
      tags:
      - subpackage_commits
      parameters:
      - name: commitId
        in: path
        description: ID of the commit version to complete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /commits/{commitId}/replay:
    post:
      operationId: replay
      summary: Replay a commit version
      description: Replays a commit:created event.
      tags:
      - subpackage_commits
      parameters:
      - name: commitId
        in: path
        description: ID of the commit version to re-emit a commit:created event for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /data-clips:
    post:
      operationId: create
      summary: Create
      description: Creates a new DataClip.
      tags:
      - subpackage_data-clips
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips:DataClip'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips:CreateDataClipRequest'
    get:
      operationId: list
      summary: List
      tags:
      - subpackage_data-clips
      parameters:
      - name: spaceId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: sheetId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips:ListDataClipResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /data-clips/{dataClipId}:
    patch:
      operationId: update
      summary: Update
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips:DataClipResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips:UpdateDataClipRequest'
    delete:
      operationId: delete
      summary: Delete
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
    get:
      operationId: get
      summary: Get
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips:DataClipResponse'
  /data-clips/{dataClipId}/add-records:
    post:
      operationId: add-records-to-clip
      summary: Add Records To Clip
      description: Adds records to an existing DataClip.
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:RecordsResponseData'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips:AddRecordsToClipRequest'
  /data-clips/{dataClipId}/resolutions:
    get:
      operationId: get-resolutions
      summary: Get Resolutions
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: includeRecords
        in: query
        description: Include records in the response. Default is true
        required: false
        schema:
          type: boolean
      - name: includeSummary
        in: query
        description: Include summary in the response. Default is false
        required: false
        schema:
          type: boolean
      - name: filterColumn
        in: query
        description: The column to filter by.
        required: false
        schema:
          type: string
      - name: filterConflicts
        in: query
        description: Whether to filter only conflicts. Default is false
        required: false
        schema:
          type: boolean
      - name: pageSize
        in: query
        description: Number of resolutions to return in a page. Default is 1000
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Page number of resolutions to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:DiffRecordsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-resolution
      summary: Update Resolution
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-clips:UpdateResolutionRequest'
  /data-clips/{dataClipId}/resolutions/index:
    get:
      operationId: get-resolution-index
      summary: Get Resolution Index
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: filterColumn
        in: query
        description: The column to filter by.
        required: false
        schema:
          type: string
      - name: filterConflicts
        in: query
        description: Whether to filter only conflicts. Default is false
        required: true
        schema:
          type: string
      - name: id
        in: query
        description: The record ID to get the index of.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-clips:GetResolutionIndexResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /data-clips/{dataClipId}/refresh-resolutions:
    patch:
      operationId: refresh-resolutions
      summary: Refresh Resolutions
      tags:
      - subpackage_data-clips
      parameters:
      - name: dataClipId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataClipId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /data-retention-policies:
    get:
      operationId: list
      summary: List data retention policies
      description: Returns all data retention policies on an account matching a filter
        for environmentId
      tags:
      - subpackage_data-retention-policies
      parameters:
      - name: environmentId
        in: query
        description: The associated Environment ID of the policy.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-retention-policies:ListDataRetentionPoliciesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a data retention policy
      description: Add a new data retention policy to the space
      tags:
      - subpackage_data-retention-policies
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyConfig'
  /data-retention-policies/{id}:
    get:
      operationId: get
      summary: Get a data retention policy
      description: Returns a single data retention policy
      tags:
      - subpackage_data-retention-policies
      parameters:
      - name: id
        in: path
        description: ID of data retention policy to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataRetentionPolicyId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a data retention policy
      description: Updates a single data retention policy
      tags:
      - subpackage_data-retention-policies
      parameters:
      - name: id
        in: path
        description: ID of data retention policy to update
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataRetentionPolicyId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyConfig'
    delete:
      operationId: delete
      summary: Delete a data retention policy
      description: Deletes a single data retention policy
      tags:
      - subpackage_data-retention-policies
      parameters:
      - name: id
        in: path
        description: ID of data retention policy to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DataRetentionPolicyId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}/documents:
    get:
      operationId: list
      summary: List documents
      description: Returns all documents for a space
      tags:
      - subpackage_documents
      parameters:
      - name: spaceId
        in: path
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_documents:ListDocumentsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a document
      description: Add a new document to the space
      tags:
      - subpackage_documents
      parameters:
      - name: spaceId
        in: path
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_documents:DocumentResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_documents:DocumentConfig'
  /spaces/{spaceId}/documents/{documentId}:
    get:
      operationId: get
      summary: Get a document
      description: Returns a single document
      tags:
      - subpackage_documents
      parameters:
      - name: spaceId
        in: path
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: documentId
        in: path
        description: ID of document to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DocumentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_documents:DocumentResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a document
      description: updates a single document, for only the body and title
      tags:
      - subpackage_documents
      parameters:
      - name: spaceId
        in: path
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: documentId
        in: path
        description: ID of document to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DocumentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_documents:DocumentResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_documents:DocumentConfig'
    delete:
      operationId: delete
      summary: Delete a document
      description: Deletes a single document
      tags:
      - subpackage_documents
      parameters:
      - name: spaceId
        in: path
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: documentId
        in: path
        description: ID of document to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:DocumentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /entitlements:
    get:
      operationId: list
      summary: List entitlements
      description: Returns all entitlements matching a filter for resourceId
      tags:
      - subpackage_entitlements
      parameters:
      - name: resourceId
        in: query
        description: The associated Resource ID for the entitlements.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_entitlements:ListEntitlementsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /environments:
    get:
      operationId: list
      summary: List environments
      description: Get all environments
      tags:
      - subpackage_environments
      parameters:
      - name: pageSize
        in: query
        description: Number of environments to return in a page (default 10)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of environments to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:ListEnvironmentsResponse'
    post:
      operationId: create
      summary: Create an environment
      description: Create a new environment
      tags:
      - subpackage_environments
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:EnvironmentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_environments:EnvironmentConfigCreate'
  /environments/subscription-token:
    get:
      operationId: get-environment-event-token
      summary: Get environment subscription credentials
      description: Get a token which can be used to subscribe to events for this environment
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: query
        description: ID of environment to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:EventTokenResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /environments/{environmentId}:
    get:
      operationId: get
      summary: Get an environment
      description: Returns a single environment
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment to return. To fetch the current environment,
          pass `current`
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:EnvironmentResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update an environment
      description: Updates a single environment, to change the name for example
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment to update
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:Environment'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_environments:EnvironmentConfigUpdate'
    delete:
      operationId: delete
      summary: Delete an environment
      description: Deletes a single environment
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment to delete
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /environments/{environmentId}/guides:
    get:
      operationId: list-guides
      summary: List guides
      description: Returns guides in an account
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:GuideListResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create-guide
      summary: Create a guide
      description: Creates a guide
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:GuideDetailResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_environments:GuideCreateRequest'
  /environments/{environmentId}/guides/{guideId}:
    get:
      operationId: get-guide
      summary: Get a guide
      description: Returns a guide
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: guideId
        in: path
        description: ID of guide
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuideId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:GuideDetailResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-guide
      summary: Update a guide
      description: Updates a guide
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: guideId
        in: path
        description: ID of guide
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuideId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:GuideDetailResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_environments:GuideUpdateRequest'
    delete:
      operationId: delete-guide
      summary: Delete a guide
      description: Deletes a guide
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: guideId
        in: path
        description: ID of guide to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuideId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:GuideDeleteResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /environments/{environmentId}/guides/{guideId}/versions/{version}:
    get:
      operationId: get-guide-version
      summary: Get guide version
      description: Returns a specified version of a specific guide
      tags:
      - subpackage_environments
      parameters:
      - name: environmentId
        in: path
        description: ID of the environment
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: guideId
        in: path
        description: ID of the guide
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuideId'
      - name: version
        in: path
        description: Version of the guide
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_environments:GuideVersionResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /events:
    get:
      operationId: list
      summary: List events
      description: Event topics that the Flatfile Platform emits.
      tags:
      - subpackage_events
      parameters:
      - name: environmentId
        in: query
        description: Filter by environment
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: spaceId
        in: query
        description: Filter by space
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: domain
        in: query
        description: Filter by event domain
        required: false
        schema:
          type: string
      - name: topic
        in: query
        description: Filter by event topic
        required: false
        schema:
          type: string
      - name: since
        in: query
        description: Filter by event timestamp
        required: false
        schema:
          type: string
          format: date-time
      - name: pageSize
        in: query
        description: Number of results to return in a page (default 10)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of results to return
        required: false
        schema:
          type: integer
      - name: includeAcknowledged
        in: query
        description: Include acknowledged events
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_events:ListAllEventsResponse'
    post:
      operationId: create
      summary: Create an event
      tags:
      - subpackage_events
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_events:EventResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_events:CreateEventConfig'
  /events/{eventId}:
    get:
      operationId: get
      summary: Get an event
      tags:
      - subpackage_events
      parameters:
      - name: eventId
        in: path
        description: The event id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EventId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_events:EventResponse'
  /events/{eventId}/ack:
    post:
      operationId: ack
      summary: Acknowledge an event
      tags:
      - subpackage_events
      parameters:
      - name: eventId
        in: path
        description: The event id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:EventId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /subscription:
    get:
      operationId: get-event-token
      summary: Get subscription credentials
      description: Get a token which can be used to subscribe to events for this space
      tags:
      - subpackage_events
      parameters:
      - name: scope
        in: query
        description: The resource ID of the event stream (space or environment id)
        required: false
        schema:
          type: string
      - name: spaceId
        in: query
        description: The space ID of the event stream
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:EventTokenResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /files:
    get:
      operationId: list
      summary: List files
      tags:
      - subpackage_files
      parameters:
      - name: spaceId
        in: query
        required: false
        schema:
          type: string
      - name: pageSize
        in: query
        description: Number of files to return in a page (default 20)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of files to return
        required: false
        schema:
          type: integer
      - name: mode
        in: query
        description: The storage mode of file to fetch, defaults to "import"
        required: false
        schema:
          $ref: '#/components/schemas/type_files:Mode'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_files:ListFilesResponse'
    post:
      operationId: upload
      summary: Upload a file
      tags:
      - subpackage_files
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_files:FileResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                spaceId:
                  $ref: '#/components/schemas/type_commons:SpaceId'
                environmentId:
                  $ref: '#/components/schemas/type_commons:EnvironmentId'
                mode:
                  $ref: '#/components/schemas/type_files:Mode'
                  description: The storage mode of file to insert, defaults to "import"
                file:
                  type: string
                  format: binary
                  description: A binary payload containing the file contents
                actions:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_commons:Action'
                  description: The actions attached to the file
                origin:
                  $ref: '#/components/schemas/type_files:FileOrigin'
                  description: The origin of the file, ie filesystem
              required:
              - spaceId
              - environmentId
              - file
  /files/{fileId}:
    get:
      operationId: get
      summary: Get a file
      tags:
      - subpackage_files
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_files:FileResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    delete:
      operationId: delete
      summary: Delete a file
      tags:
      - subpackage_files
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a file
      description: Update a file, to change the workbook id for example
      tags:
      - subpackage_files
      parameters:
      - name: fileId
        in: path
        description: ID of file to update
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_files:FileResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                workbookId:
                  $ref: '#/components/schemas/type_commons:WorkbookId'
                name:
                  type: string
                  description: The name of the file
                mode:
                  $ref: '#/components/schemas/type_files:Mode'
                  description: The storage mode of file to update
                status:
                  $ref: '#/components/schemas/type_files:ModelFileStatusEnum'
                actions:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_commons:Action'
                  description: The actions attached to the file
  /files/{fileId}/download:
    get:
      operationId: download
      summary: Download a file
      tags:
      - subpackage_files
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:FileId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /files/{fileId}/clone:
    post:
      operationId: clone
      summary: Clone a file
      tags:
      - subpackage_files
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:FileId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_files:FileResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                prefix:
                  type: string
                  description: The prefix for the cloned file (defaults to original
                    name with "Copy of " prefix)
  /files/detect-header:
    post:
      operationId: detect-header
      summary: Detect header
      tags:
      - subpackage_files
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_files:DetectHeaderResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                options:
                  $ref: '#/components/schemas/type_files:HeaderDetectionOptions'
                data:
                  type: array
                  items:
                    type: array
                    items:
                      type: string
              required:
              - options
              - data
  /v1/workbooks/{workbookId}/flags:
    post:
      operationId: create
      summary: Create
      description: Creates a new flag for the workbook
      tags:
      - subpackage_flags
      parameters:
      - name: workbookId
        in: path
        description: The workbook ID to manage flags for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_flags:FlagResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_flags:CreateFlagRequest'
    get:
      operationId: list
      summary: List
      description: Gets all flags for the workbook
      tags:
      - subpackage_flags
      parameters:
      - name: workbookId
        in: path
        description: The workbook ID to manage flags for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/type_flags:FlagResponse'
  /v1/workbooks/{workbookId}/flags/{slug}:
    get:
      operationId: get
      summary: Get
      description: Gets a specific flag by its slug
      tags:
      - subpackage_flags
      parameters:
      - name: workbookId
        in: path
        description: The workbook ID to manage flags for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: slug
        in: path
        description: The flag slug to retrieve
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_flags:FlagResponse'
    patch:
      operationId: update
      summary: Update
      description: Updates an existing flag
      tags:
      - subpackage_flags
      parameters:
      - name: workbookId
        in: path
        description: The workbook ID to manage flags for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: slug
        in: path
        description: The flag slug to update
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_flags:FlagResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_flags:UpdateFlagRequest'
    delete:
      operationId: delete
      summary: Delete
      description: Deletes a flag
      tags:
      - subpackage_flags
      parameters:
      - name: workbookId
        in: path
        description: The workbook ID to manage flags for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: slug
        in: path
        description: The flag slug to delete
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /v1/workbooks/{workbookId}/flags/bulk-mutate:
    post:
      operationId: bulk-mutate
      summary: Bulk Mutate
      description: Performs bulk flag operations on records
      tags:
      - subpackage_flags
      parameters:
      - name: workbookId
        in: path
        description: The workbook ID to manage flags for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_flags:BulkMutateFlagsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_flags:BulkMutateFlagsRequest'
  /guests:
    get:
      operationId: list
      summary: List guests
      description: Returns all guests
      tags:
      - subpackage_guests
      parameters:
      - name: spaceId
        in: query
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: email
        in: query
        description: Email of guest to return
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_guests:ListGuestsResponse'
    post:
      operationId: create
      summary: Create a guest
      description: Guests are only there to upload, edit, and download files and perform
        their tasks in a specific Space.
      tags:
      - subpackage_guests
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_guests:CreateGuestResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/type_guests:GuestConfig'
  /guests/{guestId}:
    get:
      operationId: get
      summary: Get a guest
      description: Returns a single guest
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: ID of guest to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_guests:GuestResponse'
    delete:
      operationId: delete
      summary: Delete a guest
      description: Deletes a single guest or removes guest access from a specific
        space
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: ID of guest to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: spaceId
        in: query
        description: ID of space to remove guest access from. If not provided, guest
          will be completely deleted.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
    patch:
      operationId: update
      summary: Update a guest
      description: Updates a single guest, for example to change name or email
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: ID of guest to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_guests:GuestResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_guests:GuestConfigUpdate'
  /guests/{guestId}/token:
    get:
      operationId: get-guest-token
      summary: Get guest token
      description: Returns a single guest token
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: ID of guest to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: spaceId
        in: query
        description: ID of space to return
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_guests:GuestTokenResponse'
  /guests/{guestId}/roles:
    get:
      operationId: list-guest-roles
      summary: List Guest Roles
      description: Lists roles assigned to a guest.
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: The guest id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:ListActorRolesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: assign-guest-role
      summary: Assign Role to Guest
      description: Assigns a role to a guest.
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: The guest id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:AssignRoleResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_roles:AssignActorRoleRequest'
  /guests/{guestId}/roles/{actorRoleId}:
    delete:
      operationId: delete-guest-role
      summary: Remove Role from Guest
      description: Removes a role from a guest.
      tags:
      - subpackage_guests
      parameters:
      - name: guestId
        in: path
        description: The guest id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuestId'
      - name: actorRoleId
        in: path
        description: The actor role id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ActorRoleId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /invitations:
    post:
      operationId: invite
      summary: Invite guests
      description: "Guests can be created as a named guest on the Space or there\u2019\
        s a global link that will let anonymous guests into the space."
      tags:
      - subpackage_guests
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/type_guests:Invite'
  /jobs:
    get:
      operationId: list
      summary: List jobs
      tags:
      - subpackage_jobs
      parameters:
      - name: environmentId
        in: query
        description: When provided, only jobs for the given environment will be returned
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: spaceId
        in: query
        description: When provided, only jobs for the given space will be returned
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: workbookId
        in: query
        description: When provided, only jobs for the given workbook will be returned
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: fileId
        in: query
        description: When provided, only jobs for the given file will be returned
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FileId'
      - name: parentId
        in: query
        description: When provided, only jobs that are parts of the given job will
          be returned
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: pageSize
        in: query
        description: Number of jobs to return in a page (default 20)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of jobs to return
        required: false
        schema:
          type: integer
      - name: sortDirection
        in: query
        description: Sort direction - asc (ascending) or desc (descending)
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: excludeChildJobs
        in: query
        description: When true, only top-level jobs will be returned unless a parentId
          is specified
        required: false
        schema:
          type: boolean
      - name: source
        in: query
        description: When provided, only jobs with the given source will be returned
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:ListJobsResponse'
    post:
      operationId: create
      summary: Create a job
      tags:
      - subpackage_jobs
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobConfig'
  /jobs/{jobId}:
    get:
      operationId: get
      summary: Get a job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: The id of the job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
    patch:
      operationId: update
      summary: Update a job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: The id of the job to patch
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobUpdate'
    delete:
      operationId: delete
      summary: Delete a job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: The id of the job to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /jobs/{jobId}/execute:
    post:
      operationId: execute
      summary: Execute a job
      description: Execute a job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /jobs/{jobId}/plan:
    get:
      operationId: get-execution-plan
      summary: Get a job's execution plan
      description: Returns a single job's execution plan
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobPlanResponse'
    put:
      operationId: update-execution-plan
      summary: Replace a job's plan
      description: Update a job's entire execution plan
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobPlanResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobExecutionPlanRequest'
    patch:
      operationId: update-execution-plan-fields
      summary: Update a job's plan
      description: Update one or more individual fields on a job's execution plan
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobPlanResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobExecutionPlanConfigRequest'
  /jobs/{jobId}/ack:
    post:
      operationId: ack
      summary: Acknowledge a job
      description: Acknowledge a job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobAckDetails'
  /jobs/{jobId}/outcome/ack:
    post:
      operationId: ack-outcome
      summary: Acknowledge a job outcome
      description: Acknowledge a job outcome and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
  /jobs/{jobId}/complete:
    post:
      operationId: complete
      summary: Complete a job
      description: Complete a job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobCompleteDetails'
  /jobs/{jobId}/fail:
    post:
      operationId: fail
      summary: Fail a job
      description: Fail a job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobCompleteDetails'
  /jobs/{jobId}/cancel:
    post:
      operationId: cancel
      summary: Cancel a job
      description: Cancel a job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobCancelDetails'
  /jobs/{jobId}/retry:
    post:
      operationId: retry
      summary: Retry a failed job
      description: Retry a failt job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
  /jobs/preview-mutation:
    post:
      operationId: preview-mutation
      summary: Preview a mutation
      description: Preview the results of a mutation
      tags:
      - subpackage_jobs
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:DiffRecordsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:MutateJobConfig'
  /jobs/{jobId}/split:
    post:
      operationId: split
      summary: Split a job
      description: Split a job and return the job
      tags:
      - subpackage_jobs
      parameters:
      - name: jobId
        in: path
        description: ID of job to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_jobs:JobResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_jobs:JobSplitDetails'
  /mapping:
    post:
      operationId: create-mapping-program
      summary: Create a mapping between two schemas
      description: Creates a list of mapping rules based on two provided schemas
      tags:
      - subpackage_mapping
      parameters:
      - name: environmentId
        in: query
        description: The ID of the environment
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:ProgramResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_mapping:ProgramConfig'
    delete:
      operationId: delete-all-history-for-user
      summary: Delete all history for the authenticated user
      description: Deletes all history for the authenticated user
      tags:
      - subpackage_mapping
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                environmentId:
                  $ref: '#/components/schemas/type_commons:EnvironmentId'
    get:
      operationId: list-mapping-programs
      summary: List mapping programs
      description: List all mapping programs
      tags:
      - subpackage_mapping
      parameters:
      - name: pageSize
        in: query
        description: Number of programs to return in a page (default 10)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of records to return
        required: false
        schema:
          type: integer
      - name: createdBy
        in: query
        description: Filter by creator
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: createdAfter
        in: query
        description: Filter by creation time
        required: false
        schema:
          type: string
          format: date-time
      - name: createdBefore
        in: query
        description: Filter by creation time
        required: false
        schema:
          type: string
          format: date-time
      - name: environmentId
        in: query
        description: The ID of the environment
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: jobId
        in: query
        description: A job ID to find mapping programs for
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:JobId'
      - name: familyId
        in: query
        description: Filter by family
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FamilyId'
      - name: namespace
        in: query
        description: Filter by namespace
        required: false
        schema:
          type: string
      - name: sourceKeys
        in: query
        description: Filter by source keys
        required: false
        schema:
          type: string
      - name: destinationKeys
        in: query
        description: Filter by destination keys
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:ProgramsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /mapping/{programId}:
    get:
      operationId: get-mapping-program
      summary: Get a mapping program
      description: Get a mapping program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:ProgramResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-mapping-program
      summary: Update a mapping program
      description: Updates a mapping program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:ProgramResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_mapping:ProgramConfig'
    delete:
      operationId: delete-mapping-program
      summary: Delete a mapping program
      description: Deletes a mapping program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /mapping/{programId}/rules:
    post:
      operationId: create-rules
      summary: Add mapping rules to a program
      description: Add mapping rules to a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:MappingRulesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_mapping:CreateMappingRulesRequest'
    delete:
      operationId: delete-multiple-rules
      summary: Delete multiple mapping rules
      description: Deletes multiple mapping rules from a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ruleIds:
                  type: array
                  items:
                    $ref: '#/components/schemas/type_commons:MappingId'
                  description: Array of rule IDs to be deleted
              required:
              - ruleIds
    get:
      operationId: list-rules
      summary: List mapping rules
      description: List all mapping rules in a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:MappingRulesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-rules
      summary: Update a list of mapping rules
      description: Updates a list of mapping rules in a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:MappingRulesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_mapping:UpdateMappingRulesRequest'
  /mapping/{programId}/rules/{mappingId}:
    get:
      operationId: get-rule
      summary: Get a mapping rule
      description: Get a mapping rule from a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: mappingId
        in: path
        description: ID of mapping rule
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:MappingId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:MappingRuleResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-rule
      summary: Update a mapping rule
      description: Updates a mapping rule in a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: mappingId
        in: path
        description: ID of mapping rule
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:MappingId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_mapping:MappingRuleResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_mapping:MappingRuleConfig'
    delete:
      operationId: delete-rule
      summary: Delete a mapping rule
      description: Deletes a mapping rule from a program
      tags:
      - subpackage_mapping
      parameters:
      - name: programId
        in: path
        description: ID of the program
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ProgramId'
      - name: mappingId
        in: path
        description: ID of mapping rule
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:MappingId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/records:
    get:
      operationId: get
      summary: Get records
      description: Returns records from a sheet in a workbook
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: versionId
        in: query
        description: Deprecated, use `commitId` instead.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:VersionId'
      - name: commitId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sinceVersionId
        in: query
        description: Deprecated, use `sinceCommitId` instead.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:VersionId'
      - name: sinceCommitId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sortField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortField'
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: filter
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: Name of field by which to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: ids
        in: query
        description: The Record Ids param (ids) is a list of record ids that can be
          passed to several record endpoints allowing the user to identify specific
          records to INCLUDE in the query, or specific records to EXCLUDE, depending
          on whether or not filters are being applied. When passing a query param
          that filters the record dataset, such as 'searchValue', or a 'filter' of
          'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from
          the filtered results. For basic queries that do not filter the dataset,
          passing record ids in the 'ids' param will limit the dataset to INCLUDE
          just those specific records. Maximum of 100 allowed.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:RecordId'
      - name: pageSize
        in: query
        description: Number of records to return in a page (default 10,000)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of records to return (Note - numbers
          start at 1)
        required: false
        schema:
          type: integer
      - name: includeCounts
        in: query
        description: '**DEPRECATED** Use GET /sheets/:sheetId/counts'
        required: false
        schema:
          type: boolean
      - name: includeLength
        in: query
        description: The length of the record result set, returned as counts.total
        required: false
        schema:
          type: boolean
      - name: includeLinks
        in: query
        description: If true, linked records will be included in the results. Defaults
          to false.
        required: false
        schema:
          type: boolean
      - name: includeMessages
        in: query
        description: Include error messages, defaults to false.
        required: false
        schema:
          type: boolean
      - name: fields
        in: query
        description: A list of field keys to include in the response. If not provided,
          all fields will be included.
        required: false
        schema:
          type: string
      - name: for
        in: query
        description: if "for" is provided, the query parameters will be pulled from
          the event payload
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EventId'
      - name: q
        in: query
        description: An FFQL query used to filter the result set
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:GetRecordsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    put:
      operationId: update
      summary: Update records
      description: Updates existing records in a workbook sheet
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_versions:VersionResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_records:Records'
    post:
      operationId: insert
      summary: Insert records
      description: Adds records to a workbook sheet
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:RecordsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/type_records:RecordData'
    delete:
      operationId: delete
      summary: Delete records
      description: Deletes records from a workbook sheet
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: ids
        in: query
        description: A list of record IDs to delete. Maximum of 100 allowed.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RecordId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/records/indices:
    get:
      operationId: indices
      summary: Get record Indices
      description: Returns indices of records from a sheet in a workbook
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: commitId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sinceCommitId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sortField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortField'
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: filter
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: Name of field by which to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: ids
        in: query
        description: List of record IDs to include in the query. Limit 100.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RecordId'
      - name: q
        in: query
        description: An FFQL query used to filter the result set
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:GetRecordIndicesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/find-replace:
    put:
      operationId: find-and-replace
      summary: 'Finds and replaces field values matching search criteria

        '
      description: Searches for all values that match the 'find' value (globally or
        for a specific field via 'fieldKey') and replaces them with the 'replace'
        value. Wrap 'find' value in double quotes for exact match (""). Returns a
        commitId for the updated records
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: filter
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: Name of field by which to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: ids
        in: query
        description: The Record Ids param (ids) is a list of record ids that can be
          passed to several record endpoints allowing the user to identify specific
          records to INCLUDE in the query, or specific records to EXCLUDE, depending
          on whether or not filters are being applied. When passing a query param
          that filters the record dataset, such as 'searchValue', or a 'filter' of
          'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from
          the filtered results. For basic queries that do not filter the dataset,
          passing record ids in the 'ids' param will limit the dataset to INCLUDE
          just those specific records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:RecordId'
      - name: q
        in: query
        description: An FFQL query used to filter the result set
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_versions:VersionResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                find:
                  $ref: '#/components/schemas/type_records:CellValueUnion'
                  description: A value to find for a given field in a sheet. For exact
                    matches, wrap the value in double quotes ("Bob")
                replace:
                  $ref: '#/components/schemas/type_records:CellValueUnion'
                  description: The value to replace found values with
                fieldKey:
                  type: string
                  description: A unique key used to identify a field in a sheet
              required:
              - fieldKey
  /sheets/{sheetId}/records/bulk-update:
    patch:
      operationId: bulk-update
      summary: 'Bulk update records with field values

        '
      description: Updates multiple records at once with the same field values based
        on filter criteria. This is similar to a SQL UPDATE statement where you can
        update specific fields for all records matching certain conditions.
      tags:
      - subpackage_records
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: filter
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: Name of field by which to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: sortField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortField'
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: ids
        in: query
        description: The Record Ids param (ids) is a list of record ids that can be
          passed to several record endpoints allowing the user to identify specific
          records to INCLUDE in the query, or specific records to EXCLUDE, depending
          on whether or not filters are being applied. When passing a query param
          that filters the record dataset, such as 'searchValue', or a 'filter' of
          'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from
          the filtered results. For basic queries that do not filter the dataset,
          passing record ids in the 'ids' param will limit the dataset to INCLUDE
          just those specific records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:RecordId'
      - name: q
        in: query
        description: An FFQL query used to filter the result set
        required: false
        schema:
          type: string
      - name: silent
        in: query
        description: Whether to suppress events for this bulk update
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_versions:VersionResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fieldUpdates:
                  type: object
                  additionalProperties:
                    $ref: '#/components/schemas/type_records:CellValue'
                  description: A map of field keys to cell values that will be applied
                    to all matching records
              required:
              - fieldUpdates
  /roles:
    get:
      operationId: list
      summary: List roles
      description: List all roles for an account
      tags:
      - subpackage_roles
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:ListRolesResponse'
  /routines:
    get:
      operationId: list
      summary: List routines
      description: Returns a list of routines
      tags:
      - subpackage_routines
      parameters:
      - name: runbookId
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_routines:RoutinesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a routine
      description: Creates a new routine
      tags:
      - subpackage_routines
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_routines:RoutineResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_routines:CreateRoutineRequest'
  /routines/{routineId}:
    get:
      operationId: get
      summary: Get a routine
      description: Returns a routine
      tags:
      - subpackage_routines
      parameters:
      - name: routineId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RoutineId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_routines:RoutineResponse'
    patch:
      operationId: update
      summary: Update a routine
      description: Updates a routine
      tags:
      - subpackage_routines
      parameters:
      - name: routineId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RoutineId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_routines:RoutineResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_routines:UpdateRoutineRequest'
    delete:
      operationId: delete
      summary: Delete a routine
      description: Deletes a routine
      tags:
      - subpackage_routines
      parameters:
      - name: routineId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RoutineId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /runbooks:
    get:
      operationId: list
      summary: List runbooks
      description: Returns a list of runbooks
      tags:
      - subpackage_runbooks
      parameters:
      - name: appId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: environmentId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: spaceId
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks:RunbooksResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a runbook
      description: Creates a new runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks:RunbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_runbooks:CreateRunbookRequest'
  /runbooks/{runbookId}:
    get:
      operationId: get
      summary: Get a runbook
      description: Returns a runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: runbookId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks:RunbookResponse'
    patch:
      operationId: update
      summary: Update a runbook
      description: Updates a runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: runbookId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_runbooks:RunbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_runbooks:UpdateRunbookRequest'
    delete:
      operationId: delete
      summary: Delete a runbook
      description: Deletes a runbook
      tags:
      - subpackage_runbooks
      parameters:
      - name: runbookId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:RunbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /secrets:
    get:
      operationId: list
      summary: List secrets
      description: Fetch all secrets for a given environmentId and optionally apply
        space overrides
      tags:
      - subpackage_secrets
      parameters:
      - name: environmentId
        in: query
        description: The Environment of the secret.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: spaceId
        in: query
        description: The Space of the secret.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: actorId
        in: query
        description: The Actor of the secret.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:ActorIdUnion'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_secrets:SecretsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: upsert
      summary: Upsert a Secret
      description: Insert or Update a Secret by name for environment or space
      tags:
      - subpackage_secrets
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_secrets:SecretsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_secrets:WriteSecret'
  /secrets/{secretId}:
    delete:
      operationId: delete
      summary: Delete a secret by it's Id
      description: Deletes a specific Secret from the Environment or Space as is the
        case
      tags:
      - subpackage_secrets
      parameters:
      - name: secretId
        in: path
        description: The ID of the secret.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SecretId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_secrets:SecretsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets:
    get:
      operationId: list
      summary: List sheets
      description: Returns sheets in a workbook
      tags:
      - subpackage_sheets
      parameters:
      - name: workbookId
        in: query
        description: ID of workbook
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:ListSheetsResponse'
  /sheets/{sheetId}:
    get:
      operationId: get
      summary: Get a sheet
      description: Returns a sheet in a workbook
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:SheetResponse'
    delete:
      operationId: delete
      summary: Delete a sheet
      description: Deletes a specific sheet from a workbook
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-sheet
      summary: Update a sheet
      description: Updates Sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:SheetResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_sheets:SheetUpdateRequest'
  /sheets/{sheetId}/duplicate:
    post:
      operationId: duplicate-sheet
      summary: Duplicate a sheet
      description: Creates a copy of a sheet including all its data within the same
        workbook
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet to duplicate
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:SheetResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Custom name for the duplicated sheet. Defaults to "Copy
                    of [original name]"
                slug:
                  type: string
                  description: Custom slug for the duplicated sheet. Defaults to "[original
                    slug]-copy-[timestamp]"
  /sheets/{sheetId}/validate:
    post:
      operationId: validate
      summary: Validate a sheet
      description: Trigger data hooks and validation to run on a sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/download:
    get:
      operationId: get-records-as-csv
      summary: Download records as a CSV file
      description: Returns records from a sheet in a workbook as a csv file
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: versionId
        in: query
        description: Deprecated, use `sinceCommitId` instead.
        required: false
        schema:
          type: string
      - name: commitId
        in: query
        description: Returns records that were changed in that version  in that version
          and only those records.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sinceVersionId
        in: query
        description: Deprecated, use `sinceCommitId` instead.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:VersionId'
      - name: sinceCommitId
        in: query
        description: Returns records that were changed in that version in addition
          to any records from versions after that version.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sortField
        in: query
        description: The field to sort the data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortField'
      - name: sortDirection
        in: query
        description: Sort direction - asc (ascending) or desc (descending)
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: filter
        in: query
        description: Options to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: The field to filter the data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        description: The value to search for data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        description: The field to search for data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: ids
        in: query
        description: The Record Ids param (ids) is a list of record ids that can be
          passed to several record endpoints allowing the user to identify specific
          records to INCLUDE in the query, or specific records to EXCLUDE, depending
          on whether or not filters are being applied. When passing a query param
          that filters the record dataset, such as 'searchValue', or a 'filter' of
          'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records from
          the filtered results. For basic queries that do not filter the dataset,
          passing record ids in the 'ids' param will limit the dataset to INCLUDE
          just those specific records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:RecordId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
  /sheets/{sheetId}/counts:
    get:
      operationId: get-record-counts
      summary: Get record counts
      description: Returns counts of records from a sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: versionId
        in: query
        description: Returns records that were changed in that version and only those
          records.
        required: false
        schema:
          type: string
      - name: sinceVersionId
        in: query
        description: Deprecated, use `sinceCommitId` instead.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:VersionId'
      - name: commitId
        in: query
        description: Returns records that were changed in that version in addition
          to any records from versions after that version.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sinceCommitId
        in: query
        description: Listing a commit ID here will return all records since the specified
          commit.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: filter
        in: query
        description: Options to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: The field to filter the data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        description: The value to search for data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        description: The field to search for data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: byField
        in: query
        description: If true, the counts for each field will also be returned
        required: false
        schema:
          type: boolean
      - name: q
        in: query
        description: An FFQL query used to filter the result set to be counted
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:RecordCountsResponse'
  /sheets/{sheetId}/calculations:
    get:
      operationId: get-calculations
      summary: List calculations
      description: Returns all calculations for a sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: versionId
        in: query
        description: Returns records that were changed in that version and only those
          records.
        required: false
        schema:
          type: string
      - name: sinceVersionId
        in: query
        description: Deprecated, use `sinceCommitId` instead.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:VersionId'
      - name: commitId
        in: query
        description: Returns records that were changed in that version in addition
          to any records from versions after that version.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: sinceCommitId
        in: query
        description: Listing a commit ID here will return all records since the specified
          commit.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:CommitId'
      - name: filter
        in: query
        description: Options to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: The field to filter the data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: searchValue
        in: query
        description: The value to search for data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: searchField
        in: query
        description: The field to search for data on.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchField'
      - name: byField
        in: query
        description: If true, the counts for each field will also be returned
        required: false
        schema:
          type: boolean
      - name: q
        in: query
        description: An FFQL query used to filter the result set to be counted
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:ListCalculationsResponse'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/commits:
    get:
      operationId: get-sheet-commits
      summary: Get commit versions for a sheet
      description: Returns the commit versions for a sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: completed
        in: query
        description: If true, only return commits that have been completed. If false,
          only return commits that have not been completed. If not provided, return
          all commits.
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commits:ListCommitsResponse'
  /sheets/{sheetId}/lock:
    post:
      operationId: lock-sheet
      summary: Lock a sheet
      description: Locks a sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/unlock:
    post:
      operationId: unlock-sheet
      summary: Unlock a sheet
      description: Removes a lock from a sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /sheets/{sheetId}/cells:
    get:
      operationId: get-cell-values
      summary: Get record cells by field
      description: Returns record cell values grouped by all fields in the sheet
      tags:
      - subpackage_sheets
      parameters:
      - name: sheetId
        in: path
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: fieldKey
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_sheets:FieldKey'
      - name: sortField
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortField'
      - name: sortDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: filter
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:Filter'
      - name: filterField
        in: query
        description: Name of field by which to filter records
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:FilterField'
      - name: pageSize
        in: query
        description: Number of records to return in a page (default 1000 if pageNumber
          included)
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageSize'
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of records to return
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:PageNumber'
      - name: distinct
        in: query
        description: Must be set to true
        required: true
        schema:
          $ref: '#/components/schemas/type_sheets:Distinct'
      - name: includeCounts
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/type_sheets:IncludeCounts'
      - name: searchValue
        in: query
        description: A value to find for a given field in a sheet. Wrap the value
          in "" for exact match
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SearchValue'
      - name: q
        in: query
        description: An FFQL query used to filter the records to be queried
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_sheets:CellsResponse'
  /snapshots:
    post:
      operationId: create-snapshot
      summary: Create a snapshot
      description: Creates a snapshot of a sheet
      tags:
      - subpackage_snapshots
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_snapshots:SnapshotResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sheetId:
                  $ref: '#/components/schemas/type_commons:SheetId'
                  description: ID of sheet
                label:
                  type: string
                  description: Label for the snapshot
                threadId:
                  type: string
                  description: ID of thread to associate with the snapshot
              required:
              - sheetId
    get:
      operationId: list-snapshots
      summary: List snapshots
      description: List all snapshots of a sheet
      tags:
      - subpackage_snapshots
      parameters:
      - name: sheetId
        in: query
        description: ID of sheet
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: threadId
        in: query
        description: ID of thread to filter snapshots by
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_snapshots:SnapshotsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /snapshots/{snapshotId}:
    get:
      operationId: get-snapshot
      summary: Get a snapshot
      description: Gets a snapshot of a sheet
      tags:
      - subpackage_snapshots
      parameters:
      - name: snapshotId
        in: path
        description: ID of snapshot
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SnapshotId'
      - name: includeSummary
        in: query
        description: Whether to include a summary in the snapshot response
        required: true
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_snapshots:SnapshotResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    delete:
      operationId: delete-snapshot
      summary: Delete a snapshot
      description: Deletes a snapshot of a sheet
      tags:
      - subpackage_snapshots
      parameters:
      - name: snapshotId
        in: path
        description: ID of snapshot
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SnapshotId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /snapshots/{snapshotId}/restore:
    post:
      operationId: restore-snapshot
      summary: Restore a snapshot
      description: Restores a snapshot of a sheet
      tags:
      - subpackage_snapshots
      parameters:
      - name: snapshotId
        in: path
        description: ID of snapshot
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SnapshotId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_snapshots:SnapshotResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_snapshots:RestoreOptions'
  /snapshots/{snapshotId}/records:
    get:
      operationId: get-snapshot-records
      summary: Get records from a snapshot
      description: Gets records from a snapshot of a sheet
      tags:
      - subpackage_snapshots
      parameters:
      - name: snapshotId
        in: path
        description: ID of snapshot
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SnapshotId'
      - name: pageSize
        in: query
        description: Number of records to return in a page
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of records to return
        required: false
        schema:
          type: integer
      - name: changeType
        in: query
        description: Filter records by change type
        required: false
        schema:
          $ref: '#/components/schemas/type_snapshots:ChangeType'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_records:DiffRecordsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces:
    get:
      operationId: list
      summary: List spaces
      description: Returns all spaces for an account or environment
      tags:
      - subpackage_spaces
      parameters:
      - name: environmentId
        in: query
        description: The ID of the environment.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      - name: pageSize
        in: query
        description: Number of spaces to return in a page (default 10)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of records to return
        required: false
        schema:
          type: integer
      - name: app
        in: query
        description: Filter by appId
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: search
        in: query
        description: Search query for spaces
        required: false
        schema:
          type: string
      - name: namespace
        in: query
        description: Search by namespace
        required: false
        schema:
          type: string
      - name: archived
        in: query
        description: Flag to include archived spaces
        required: false
        schema:
          type: boolean
      - name: sortField
        in: query
        description: Field to sort spaces by; requires `sortDirection` if provided.
        required: false
        schema:
          $ref: '#/components/schemas/type_spaces:GetSpacesSortField'
      - name: sortDirection
        in: query
        description: Direction of sorting; requires `sortField` if provided.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: isCollaborative
        in: query
        description: Flag for collaborative (project) spaces
        required: false
        schema:
          type: boolean
      - name: appId
        in: query
        description: (Deprecated!) Use `app` query parameter
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:AppId'
      - name: isAppTemplate
        in: query
        description: Flag for app templates
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:ListSpacesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a space
      description: Creates a new space based on an existing Space Config
      tags:
      - subpackage_spaces
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:SpaceResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_spaces:SpaceConfig'
    delete:
      operationId: bulk-delete
      summary: Delete spaces
      description: Delete multiple spaces by id
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceIds
        in: query
        description: List of ids for the spaces to be deleted
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}:
    get:
      operationId: get
      summary: Get a space
      description: Returns a single space
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:SpaceResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    delete:
      operationId: delete
      summary: Delete a space
      description: Delete a space
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a space
      description: Update a space, to change the name for example
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to update
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:SpaceResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_spaces:SpaceConfig'
  /spaces/{spaceId}/archive:
    post:
      operationId: archive-space
      summary: Archives a space
      description: Sets archivedAt timestamp on a space
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to archive
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}/unarchive:
    post:
      operationId: unarchive-space
      summary: Unarchives a space
      description: Sets archivedAt timestamp on a space to null
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to unarchive
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}/guidance:
    post:
      operationId: create-guidance
      summary: Create a new guidance
      description: Creates a new guidance
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of the space
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:GuidanceResource'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_spaces:GuidanceApiCreateData'
    get:
      operationId: list-guidance
      summary: List guidances
      description: Lists guidances
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of the space
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: includeGuide
        in: query
        description: Include the guide with the guidance, default is false
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:GuidanceListResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}/guidance/{guidanceId}:
    get:
      operationId: get-guidance
      summary: Get a guidance
      description: Retrieves a guidance by its id
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of the space
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: guidanceId
        in: path
        description: ID of the guidance
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuidanceId'
      - name: includeGuide
        in: query
        description: Include the guide with the guidance, default is false
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:GuidanceResource'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update-guidance
      summary: Update a guidance
      description: Updates a guidance with the given id
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of the space
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: guidanceId
        in: path
        description: ID of the guidance
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuidanceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:GuidanceResource'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_spaces:GuidanceApiUpdateData'
    delete:
      operationId: delete-guidance
      summary: Delete a guidance
      description: Deletes a guidance by its id
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of the space
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: guidanceId
        in: path
        description: ID of the guidance
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:GuidanceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}/drafts:
    post:
      operationId: create-draft
      summary: Create a draft of a space
      description: Creates a draft of a space
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to create draft of
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:SpaceDraftResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    get:
      operationId: list-space-drafts
      summary: List drafts for a space
      description: Lists drafts for a space
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to list drafts for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:SpaceDraftListResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /spaces/{spaceId}/drafts/{draftSpaceId}/merge:
    get:
      operationId: get-space-draft
      summary: Get a draft
      description: Gets a draft by the space id and draft space id
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to get draft for
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: draftSpaceId
        in: path
        description: ID of draft space to get
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperationsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: merge-draft
      summary: Merge a draft
      description: Merges a draft into a space
      tags:
      - subpackage_spaces
      parameters:
      - name: spaceId
        in: path
        description: ID of space to merge draft into
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: draftSpaceId
        in: path
        description: ID of draft space to merge
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /users:
    get:
      operationId: list
      summary: List users
      description: Gets a list of users
      tags:
      - subpackage_users
      parameters:
      - name: email
        in: query
        description: Email of guest to return
        required: false
        schema:
          type: string
      - name: search
        in: query
        description: String to search for users by name and email
        required: false
        schema:
          type: string
      - name: sortField
        in: query
        description: Field to sort users by
        required: false
        schema:
          $ref: '#/components/schemas/type_users:ListUsersSortField'
      - name: sortDirection
        in: query
        description: Direction of sorting
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SortDirection'
      - name: pageSize
        in: query
        description: Number of users to return in a page (default 20)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of users to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users:ListUsersResponse'
  /users/invite:
    post:
      operationId: create-and-invite
      summary: Create and Invite User
      description: Creates and invites a new user to your account.
      tags:
      - subpackage_users
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users:UserWithRolesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_users:UserCreateAndInviteRequest'
  /users/{userId}/resend-invite:
    post:
      operationId: resend-invite
      summary: Resend User Invite
      description: Resends an invite to a user for your account.
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /users/{userId}:
    patch:
      operationId: update
      summary: Update a user
      description: Updates a user
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users:UserResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                dashboard:
                  type: integer
    get:
      operationId: get
      summary: Get a user
      description: Gets a user
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_users:UserResponse'
    delete:
      operationId: delete
      summary: Delete a user
      description: Deletes a user
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /users/{userId}/roles:
    get:
      operationId: list-user-roles
      summary: List User Roles
      description: Lists roles assigned to a user.
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:ListActorRolesResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: assign-user-role
      summary: Assign Role to User
      description: Assigns a role to a user.
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_roles:AssignRoleResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_roles:AssignActorRoleRequest'
  /users/{userId}/roles/{actorRoleId}:
    delete:
      operationId: delete-user-role
      summary: Remove Role from User
      description: Removes a role from a user.
      tags:
      - subpackage_users
      parameters:
      - name: userId
        in: path
        description: The user id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:UserId'
      - name: actorRoleId
        in: path
        description: The actor role id
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ActorRoleId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
  /versions:
    post:
      operationId: create-id
      summary: Create Id
      tags:
      - subpackage_versions
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_versions:VersionResponse'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sheetId:
                  $ref: '#/components/schemas/type_commons:SheetId'
                  description: The ID of the Sheet.
                parentVersionId:
                  $ref: '#/components/schemas/type_commons:VersionId'
                  description: Deprecated, creating or updating a group of records
                    together will automatically generate a commitId to group those
                    record changes together.
  /views:
    get:
      operationId: list
      summary: List views by Sheet
      description: Returns all views for the sheet
      tags:
      - subpackage_views
      parameters:
      - name: sheetId
        in: query
        description: The associated sheet ID of the view.
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:SheetId'
      - name: pageSize
        in: query
        description: Number of prompts to return in a page (default 10)
        required: false
        schema:
          type: integer
      - name: pageNumber
        in: query
        description: Based on pageSize, which page of prompts to return
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_views:ListViewsResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a view
      description: Add a new view to the space
      tags:
      - subpackage_views
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_views:ViewResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_views:ViewCreate'
  /views/{viewId}:
    get:
      operationId: get
      summary: Get a view
      description: Returns a single view
      tags:
      - subpackage_views
      parameters:
      - name: viewId
        in: path
        description: ID of view to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ViewId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_views:ViewResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a view
      description: Updates a single view
      tags:
      - subpackage_views
      parameters:
      - name: viewId
        in: path
        description: ID of view to update
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ViewId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_views:ViewResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_views:ViewUpdate'
    delete:
      operationId: delete
      summary: Delete a view
      description: Deletes a single view
      tags:
      - subpackage_views
      parameters:
      - name: viewId
        in: path
        description: ID of view to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:ViewId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
  /workbooks:
    get:
      operationId: list
      summary: List workbooks
      description: Returns all workbooks matching a filter for an account or space
      tags:
      - subpackage_workbooks
      parameters:
      - name: spaceId
        in: query
        description: The associated Space ID of the Workbook.
        required: false
        schema:
          $ref: '#/components/schemas/type_commons:SpaceId'
      - name: name
        in: query
        description: Filter by name. Precede with - to negate the filter
        required: false
        schema:
          type: string
      - name: namespace
        in: query
        description: Filter by namespace. Precede with - to negate the filter
        required: false
        schema:
          type: string
      - name: label
        in: query
        description: Filter by label. Precede with - to negate the filter
        required: false
        schema:
          type: string
      - name: treatment
        in: query
        description: Filter by treatment.
        required: false
        schema:
          type: string
      - name: includeSheets
        in: query
        description: Include sheets for the workbook (default true)
        required: false
        schema:
          type: boolean
      - name: includeCounts
        in: query
        description: Include counts for the workbook. **DEPRECATED** Counts will return
          0s. Use GET /sheets/:sheetId/counts
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_workbooks:ListWorkbooksResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    post:
      operationId: create
      summary: Create a workbook
      description: Creates a workbook and adds it to a space
      tags:
      - subpackage_workbooks
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_workbooks:WorkbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_workbooks:CreateWorkbookConfig'
  /workbooks/{workbookId}:
    get:
      operationId: get
      summary: Get a workbook
      description: Returns a single workbook
      tags:
      - subpackage_workbooks
      parameters:
      - name: workbookId
        in: path
        description: ID of workbook to return
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_workbooks:WorkbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    delete:
      operationId: delete
      summary: Delete a workbook
      description: Deletes a workbook and all of its record data permanently
      tags:
      - subpackage_workbooks
      parameters:
      - name: workbookId
        in: path
        description: ID of workbook to delete
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Success'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
    patch:
      operationId: update
      summary: Update a workbook
      description: "Updates a workbook\n<Note>\n  Adding a sheet to a workbook does\
        \ not require the config object to be provided, however updating an existing\
        \ sheet does.\n</Note>"
      tags:
      - subpackage_workbooks
      parameters:
      - name: workbookId
        in: path
        description: ID of workbook to update
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_workbooks:WorkbookResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commons:Errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/type_workbooks:WorkbookUpdate'
  /workbooks/{workbookId}/commits:
    get:
      operationId: get-workbook-commits
      summary: Get commits for a workbook
      description: Returns the commits for a workbook
      tags:
      - subpackage_workbooks
      parameters:
      - name: workbookId
        in: path
        description: ID of workbook
        required: true
        schema:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      - name: completed
        in: query
        description: If true, only return commits that have been completed. If false,
          only return commits that have not been completed. If not provided, return
          all commits.
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      - name: X-Disable-Hooks
        in: header
        required: true
        schema:
          type: string
          enum:
          - 'true'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/type_commits:ListCommitsResponse'
servers:
- url: https://api.x.flatfile.com/v1
components:
  schemas:
    type_commons:AccountId:
      type: string
      description: Account ID
      title: AccountId
    type_commons:AppId:
      type: string
      description: App ID
      title: AppId
    type_accounts:Account:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:AccountId'
        name:
          type: string
        primaryDomain:
          type: string
        subdomain:
          type: string
        vanityDomainDashboard:
          type: string
        vanityDomainSpaces:
          type: string
        embeddedDomainWhitelist:
          type: array
          items:
            type: string
        customFromEmail:
          type: string
        stripeCustomerId:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        defaultAppId:
          $ref: '#/components/schemas/type_commons:AppId'
        dashboard:
          type: integer
      required:
      - id
      - name
      - metadata
      - createdAt
      - updatedAt
      description: An account
      title: Account
    type_accounts:AccountResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_accounts:Account'
      required:
      - data
      title: AccountResponse
    type_accounts:AccountPatch:
      type: object
      properties:
        name:
          type: string
        defaultAppId:
          $ref: '#/components/schemas/type_commons:AppId'
      description: Properties used to update an account
      title: AccountPatch
    type_commons:SpaceId:
      type: string
      description: Space ID
      title: SpaceId
    type_commons:ActionMode:
      type: string
      enum:
      - foreground
      - background
      - toolbarBlocking
      description: Foreground actions will prevent interacting with the resource until
        complete
      title: ActionMode
    type_commons:ActionMessageType:
      type: string
      enum:
      - error
      - info
      title: ActionMessageType
    type_commons:ActionMessage:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_commons:ActionMessageType'
        content:
          type: string
      required:
      - type
      - content
      title: ActionMessage
    type_commons:ActionSchedule:
      type: string
      enum:
      - weekly
      - daily
      - hourly
      title: ActionSchedule
    type_commons:InputFormType:
      type: string
      enum:
      - simple
      title: InputFormType
    type_commons:InputEnumPropertyOption:
      type: object
      properties:
        label:
          type: string
          description: A visual label for this option, defaults to value if not provided
        description:
          type: string
          description: A short description for this option
        color:
          type: string
          description: An optional color to assign this option
        icon:
          type: string
          description: A reference pointer to a previously registered icon
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: An arbitrary JSON object to be associated with this option
            and made available to hooks
        value:
          description: The value or ID of this option. This value will be sent in
            egress. The type is a string | integer | boolean.
      required:
      - value
      title: InputEnumPropertyOption
    type_commons:InputConfig:
      type: object
      properties:
        options:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:InputEnumPropertyOption'
      required:
      - options
      title: InputConfig
    type_commons:InputConstraintType:
      type: string
      enum:
      - required
      title: InputConstraintType
    type_commons:InputConstraint:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_commons:InputConstraintType'
      required:
      - type
      title: InputConstraint
    type_commons:InputField:
      type: object
      properties:
        key:
          type: string
          description: Unique key for a Field.
        label:
          type: string
          description: Visible name of a Field.
        description:
          type: string
          description: Brief description below the name of the Field.
        type:
          type: string
          description: Field Types inform the user interface how to sort and display
            data.
        defaultValue:
          description: Default value for a Field.
        config:
          $ref: '#/components/schemas/type_commons:InputConfig'
          description: Additional configuration for enum Fields.
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:InputConstraint'
          description: Indicate additional validations that will be applied to the
            Field.
      required:
      - key
      - label
      - type
      title: InputField
    type_commons:InputForm:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_commons:InputFormType'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:InputField'
      required:
      - type
      - fields
      title: InputForm
    type_commons:ActionConstraint:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - hasAllValid
            description: 'Discriminator value: hasAllValid'
          ignoreSelection:
            type: boolean
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - hasSelection
            description: 'Discriminator value: hasSelection'
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - hasData
            description: 'Discriminator value: hasData'
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - hasColumnEnabled
            description: 'Discriminator value: hasColumnEnabled'
        required:
        - type
      discriminator:
        propertyName: type
      title: ActionConstraint
    type_commons:ActionMount:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - sheet
            description: 'Discriminator value: sheet'
          slugs:
            type: array
            items:
              type: string
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - workbook
            description: 'Discriminator value: workbook'
          slugs:
            type: array
            items:
              type: string
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - field
            description: 'Discriminator value: field'
          keys:
            type: array
            items:
              type: string
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - document
            description: 'Discriminator value: document'
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - file
            description: 'Discriminator value: file'
        required:
        - type
      discriminator:
        propertyName: type
      title: ActionMount
    type_commons:Guide:
      type: object
      properties:
        content:
          type: string
          description: Markdown guidance for this action
      required:
      - content
      title: Guide
    type_commons:Guardrail:
      type: object
      properties:
        content:
          type: string
          description: Markdown guardrail for this action
      required:
      - content
      title: Guardrail
    type_commons:ActionId:
      type: string
      description: Action ID
      title: ActionId
    type_commons:APIActionConfig:
      type: object
      properties:
        slug:
          type: string
          description: '**This is deprecated. Use `operation` instead.**'
        operation:
          type: string
          description: This will become the job operation that is triggered
        mode:
          $ref: '#/components/schemas/type_commons:ActionMode'
          description: Foreground and toolbarBlocking action mode will prevent interacting
            with the resource until complete
        tooltip:
          type: string
          description: A tooltip that appears when hovering the action button
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionMessage'
        type:
          type: string
          description: '**This is deprecated.**'
        description:
          type: string
          description: The text that appears in the dialog after the action is clicked.
        schedule:
          $ref: '#/components/schemas/type_commons:ActionSchedule'
          description: Determines if the action should happen on a regular cadence.
        primary:
          type: boolean
          description: A primary action will be more visibly present, whether in Sheet
            or Workbook.
        confirm:
          type: boolean
          description: Whether to show a modal to confirm the action
        icon:
          type: string
          description: Icon will work on primary actions. It will only accept an already
            existing Flatfile design system icon.
        requireAllValid:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        requireSelection:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        inputForm:
          $ref: '#/components/schemas/type_commons:InputForm'
          description: Adds an input form for this action after it is clicked.
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionConstraint'
          description: A limitation or restriction on the action.
        mount:
          $ref: '#/components/schemas/type_commons:ActionMount'
        guide:
          $ref: '#/components/schemas/type_commons:Guide'
        guardrail:
          $ref: '#/components/schemas/type_commons:Guardrail'
        createdFrom:
          $ref: '#/components/schemas/type_commons:ActionId'
          description: The action that this action was cloned from
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time this action was propagated to a workbook
        deletedAt:
          type: string
          format: date-time
          description: The time this action was deleted
        invalidConditionalMessaging:
          type: boolean
          description: When enabled, shows dynamic confirmation messages based on
            record validation status instead of the static description
        validRecordsMessage:
          type: string
          description: Custom message to show when all records are valid (only used
            when invalidConditionalMessaging is true)
        invalidRecordsMessage:
          type: string
          description: Custom message to show when there are invalid records (only
            used when invalidConditionalMessaging is true)
        label:
          type: string
          description: The text on the Button itself
        targetId:
          type: string
      required:
      - label
      - targetId
      title: APIActionConfig
    type_commons:APIAction:
      type: object
      properties:
        slug:
          type: string
          description: '**This is deprecated. Use `operation` instead.**'
        operation:
          type: string
          description: This will become the job operation that is triggered
        mode:
          $ref: '#/components/schemas/type_commons:ActionMode'
          description: Foreground and toolbarBlocking action mode will prevent interacting
            with the resource until complete
        tooltip:
          type: string
          description: A tooltip that appears when hovering the action button
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionMessage'
        type:
          type: string
          description: '**This is deprecated.**'
        description:
          type: string
          description: The text that appears in the dialog after the action is clicked.
        schedule:
          $ref: '#/components/schemas/type_commons:ActionSchedule'
          description: Determines if the action should happen on a regular cadence.
        primary:
          type: boolean
          description: A primary action will be more visibly present, whether in Sheet
            or Workbook.
        confirm:
          type: boolean
          description: Whether to show a modal to confirm the action
        icon:
          type: string
          description: Icon will work on primary actions. It will only accept an already
            existing Flatfile design system icon.
        requireAllValid:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        requireSelection:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        inputForm:
          $ref: '#/components/schemas/type_commons:InputForm'
          description: Adds an input form for this action after it is clicked.
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionConstraint'
          description: A limitation or restriction on the action.
        mount:
          $ref: '#/components/schemas/type_commons:ActionMount'
        guide:
          $ref: '#/components/schemas/type_commons:Guide'
        guardrail:
          $ref: '#/components/schemas/type_commons:Guardrail'
        createdFrom:
          $ref: '#/components/schemas/type_commons:ActionId'
          description: The action that this action was cloned from
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time this action was propagated to a workbook
        deletedAt:
          type: string
          format: date-time
          description: The time this action was deleted
        invalidConditionalMessaging:
          type: boolean
          description: When enabled, shows dynamic confirmation messages based on
            record validation status instead of the static description
        validRecordsMessage:
          type: string
          description: Custom message to show when all records are valid (only used
            when invalidConditionalMessaging is true)
        invalidRecordsMessage:
          type: string
          description: Custom message to show when there are invalid records (only
            used when invalidConditionalMessaging is true)
        label:
          type: string
          description: The text on the Button itself
        id:
          $ref: '#/components/schemas/type_commons:ActionId'
        targetId:
          type: string
        updatedAt:
          type: string
          format: date-time
        createdAt:
          type: string
          format: date-time
      required:
      - label
      - id
      - targetId
      - updatedAt
      - createdAt
      title: APIAction
    type_actions:APIActionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_commons:APIAction'
      required:
      - data
      title: APIActionResponse
    type_actions:APIActionConfigs:
      type: array
      items:
        $ref: '#/components/schemas/type_commons:APIActionConfig'
      title: APIActionConfigs
    type_actions:APIActionsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:APIAction'
      required:
      - data
      title: APIActionsResponse
    type_commons:ActionUpdate:
      type: object
      properties:
        slug:
          type: string
          description: '**This is deprecated. Use `operation` instead.**'
        operation:
          type: string
          description: This will become the job operation that is triggered
        mode:
          $ref: '#/components/schemas/type_commons:ActionMode'
          description: Foreground and toolbarBlocking action mode will prevent interacting
            with the resource until complete
        tooltip:
          type: string
          description: A tooltip that appears when hovering the action button
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionMessage'
        type:
          type: string
          description: '**This is deprecated.**'
        description:
          type: string
          description: The text that appears in the dialog after the action is clicked.
        schedule:
          $ref: '#/components/schemas/type_commons:ActionSchedule'
          description: Determines if the action should happen on a regular cadence.
        primary:
          type: boolean
          description: A primary action will be more visibly present, whether in Sheet
            or Workbook.
        confirm:
          type: boolean
          description: Whether to show a modal to confirm the action
        icon:
          type: string
          description: Icon will work on primary actions. It will only accept an already
            existing Flatfile design system icon.
        requireAllValid:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        requireSelection:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        inputForm:
          $ref: '#/components/schemas/type_commons:InputForm'
          description: Adds an input form for this action after it is clicked.
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionConstraint'
          description: A limitation or restriction on the action.
        mount:
          $ref: '#/components/schemas/type_commons:ActionMount'
        guide:
          $ref: '#/components/schemas/type_commons:Guide'
        guardrail:
          $ref: '#/components/schemas/type_commons:Guardrail'
        createdFrom:
          $ref: '#/components/schemas/type_commons:ActionId'
          description: The action that this action was cloned from
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time this action was propagated to a workbook
        deletedAt:
          type: string
          format: date-time
          description: The time this action was deleted
        invalidConditionalMessaging:
          type: boolean
          description: When enabled, shows dynamic confirmation messages based on
            record validation status instead of the static description
        validRecordsMessage:
          type: string
          description: Custom message to show when all records are valid (only used
            when invalidConditionalMessaging is true)
        invalidRecordsMessage:
          type: string
          description: Custom message to show when there are invalid records (only
            used when invalidConditionalMessaging is true)
        label:
          type: string
      title: ActionUpdate
    type_commons:SuccessData:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
      title: SuccessData
    type_commons:Success:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_commons:SuccessData'
      description: Informs whether or not a request was successful
      title: Success
    type_commons:EnvironmentId:
      type: string
      description: Environment ID
      title: EnvironmentId
    type_commons:AgentId:
      type: string
      description: Agent ID
      title: AgentId
    type_commons:PageSize:
      type: integer
      description: Number of logs to return in a page (default 20)
      title: PageSize
    type_commons:PageNumber:
      type: integer
      description: Based on pageSize, which page of records to return
      title: PageNumber
    type_commons:AgentExportId:
      type: string
      description: Agent Export ID
      title: AgentExportId
    type_agent-exports:AgentExportType:
      type: string
      enum:
      - AUTOBUILD_INLINED
      - SYSTEM_COMBINED
      - SOURCE
      description: The different export type formats available.
      title: AgentExportType
    type_agent-exports:AgentExport:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:AgentExportId'
        agentId:
          $ref: '#/components/schemas/type_commons:AgentId'
        exportType:
          $ref: '#/components/schemas/type_agent-exports:AgentExportType'
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
      required:
      - id
      - agentId
      - exportType
      - accountId
      - environmentId
      - createdAt
      - updatedAt
      title: AgentExport
    type_commons:Pagination:
      type: object
      properties:
        currentPage:
          type: integer
          description: current page of results
        pageCount:
          type: integer
          description: total number of pages of results
        totalCount:
          type: integer
          description: total available results
      required:
      - currentPage
      - pageCount
      - totalCount
      description: pagination info
      title: Pagination
    type_agent-exports:ListAgentExportsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agent-exports:AgentExport'
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
      required:
      - data
      - pagination
      title: ListAgentExportsResponse
    type_agent-exports:GetAgentExportResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_agent-exports:AgentExport'
      required:
      - data
      title: GetAgentExportResponse
    type_events:EventTopic:
      type: string
      enum:
      - agent:created
      - agent:updated
      - agent:deleted
      - space:created
      - space:updated
      - space:deleted
      - space:archived
      - space:unarchived
      - space:expired
      - space:guestAdded
      - space:guestRemoved
      - document:created
      - document:updated
      - document:deleted
      - workbook:created
      - workbook:updated
      - workbook:deleted
      - workbook:expired
      - workbook:thawed
      - flag:created
      - flag:updated
      - flag:deleted
      - sheet:created
      - sheet:updated
      - sheet:deleted
      - sheet:counts-updated
      - sheet:calculation-updated
      - snapshot:created
      - records:created
      - records:updated
      - records:deleted
      - file:created
      - file:updated
      - file:deleted
      - file:expired
      - job:created
      - job:updated
      - job:deleted
      - job:completed
      - job:ready
      - job:scheduled
      - job:outcome-acknowledged
      - job:parts-completed
      - job:failed
      - program:created
      - program:updated
      - program:recomputing
      - program:recomputed
      - commit:created
      - commit:updated
      - commit:completed
      - layer:created
      - secret:created
      - secret:updated
      - secret:deleted
      - cron:5-minutes
      - cron:hourly
      - cron:daily
      - cron:weekly
      - environment:created
      - environment:updated
      - environment:deleted
      - environment:autobuild-created
      - action:created
      - action:updated
      - action:deleted
      - data-clip:created
      - data-clip:updated
      - data-clip:deleted
      - data-clip:collaborator-updated
      - data-clip:resolutions-created
      - data-clip:resolutions-updated
      - data-clip:resolutions-refreshed
      - canvas:created
      - canvas:updated
      - canvas:deleted
      - canvas-area:created
      - canvas-area:updated
      - canvas-area:deleted
      - thread:created
      - thread:updated
      - thread:deleted
      description: The topic of the event
      title: EventTopic
    type_agents:Compiler:
      type: string
      enum:
      - js
      description: The compiler of the agent
      title: Compiler
    type_agents:AgentTemplateEnum:
      type: string
      enum:
      - constraints
      - autobuild
      - autocast
      - webhook-egress
      - action-listener
      - automap
      description: The template of the agent
      title: AgentTemplateEnum
    type_agents:AutomapOptions:
      type: object
      properties:
        accuracy:
          type: string
        defaultTargetSheet:
          type: string
        matchFilename:
          type: string
      required:
      - accuracy
      - defaultTargetSheet
      - matchFilename
      title: AutomapOptions
    type_agents:TemplateOptions:
      oneOf:
      - type: object
        properties:
          template:
            type: string
            enum:
            - constraints
            description: 'Discriminator value: constraints'
          namespace:
            type: string
        required:
        - template
      - type: object
        properties:
          template:
            type: string
            enum:
            - autobuild
            description: 'Discriminator value: autobuild'
          namespace:
            type: string
          autobuildId:
            type: string
        required:
        - template
        - autobuildId
      - type: object
        properties:
          template:
            type: string
            enum:
            - autocast
            description: 'Discriminator value: autocast'
          namespace:
            type: string
          sheetSlug:
            type: string
          fieldFilters:
            type: array
            items:
              type: string
          options:
            type: object
            additionalProperties:
              description: Any type
        required:
        - template
        - sheetSlug
      - type: object
        properties:
          template:
            type: string
            enum:
            - webhook-egress
            description: 'Discriminator value: webhook-egress'
          namespace:
            type: string
          jobName:
            type: string
          url:
            type: string
        required:
        - template
        - jobName
        - url
      - type: object
        properties:
          template:
            type: string
            enum:
            - action-listener
            description: 'Discriminator value: action-listener'
          namespace:
            type: string
          jobName:
            type: string
          actionFunction:
            type: string
        required:
        - template
        - jobName
        - actionFunction
      - type: object
        properties:
          template:
            type: string
            enum:
            - automap
            description: 'Discriminator value: automap'
          namespace:
            type: string
          options:
            $ref: '#/components/schemas/type_agents:AutomapOptions'
        required:
        - template
        - options
      discriminator:
        propertyName: template
      description: The options for a templated agent.
      title: TemplateOptions
    type_agents:Agent:
      type: object
      properties:
        topics:
          type: array
          items:
            $ref: '#/components/schemas/type_events:EventTopic'
          description: The topics the agent should listen for
        compiler:
          $ref: '#/components/schemas/type_agents:Compiler'
          description: The compiler of the agent
        source:
          type: string
          description: The source of the agent
        sourceMap:
          type: string
          description: The source map of the agent
        slug:
          type: string
          description: The slug of the agent
        options:
          type: object
          additionalProperties:
            description: Any type
          description: This field is deprecated and will be removed in the future.
            Use the `template` and `templateOptions` fields instead.
        template:
          $ref: '#/components/schemas/type_agents:AgentTemplateEnum'
          description: The template of the agent; Template options are required for
            templated agents.
        templateOptions:
          $ref: '#/components/schemas/type_agents:TemplateOptions'
          description: The options for a templated agent. Must be provided if `template`
            is provided.
        isSystem:
          type: boolean
          description: Whether the agent is a system agent. This should be false for
            all agents created by users.
        namespace:
          type: string
          description: The namespace this agent should be limited to. Right now, this
            is information only and not used to actually filter agents that run, so
            you must still specify the namespace filter in the agent code.
        packageVersions:
          type: object
          additionalProperties:
            type: string
          description: Package versions information for the agent
        commitInfo:
          type: object
          additionalProperties:
            description: Any type
          description: Commit information for the agent
        id:
          $ref: '#/components/schemas/type_commons:AgentId'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        createdFrom:
          $ref: '#/components/schemas/type_commons:AgentId'
          description: The agent id of the template that was used to create this agent
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time the agent template configuration was propagated
            to this agent
      required:
      - id
      - createdAt
      - updatedAt
      - accountId
      - environmentId
      title: Agent
    type_agents:ListAgentsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agents:Agent'
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
      title: ListAgentsResponse
    type_agents:AgentConfig:
      type: object
      properties:
        topics:
          type: array
          items:
            $ref: '#/components/schemas/type_events:EventTopic'
          description: The topics the agent should listen for
        compiler:
          $ref: '#/components/schemas/type_agents:Compiler'
          description: The compiler of the agent
        source:
          type: string
          description: The source of the agent
        sourceMap:
          type: string
          description: The source map of the agent
        slug:
          type: string
          description: The slug of the agent
        options:
          type: object
          additionalProperties:
            description: Any type
          description: This field is deprecated and will be removed in the future.
            Use the `template` and `templateOptions` fields instead.
        template:
          $ref: '#/components/schemas/type_agents:AgentTemplateEnum'
          description: The template of the agent; Template options are required for
            templated agents.
        templateOptions:
          $ref: '#/components/schemas/type_agents:TemplateOptions'
          description: The options for a templated agent. Must be provided if `template`
            is provided.
        isSystem:
          type: boolean
          description: Whether the agent is a system agent. This should be false for
            all agents created by users.
        namespace:
          type: string
          description: The namespace this agent should be limited to. Right now, this
            is information only and not used to actually filter agents that run, so
            you must still specify the namespace filter in the agent code.
        packageVersions:
          type: object
          additionalProperties:
            type: string
          description: Package versions information for the agent
        commitInfo:
          type: object
          additionalProperties:
            description: Any type
          description: Commit information for the agent
      description: Properties used to create a new agent
      title: AgentConfig
    type_agents:AgentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_agents:Agent'
      title: AgentResponse
    type_commons:Error:
      type: object
      properties:
        key:
          type: string
        message:
          type: string
      required:
      - message
      title: Error
    type_commons:Errors:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Error'
      required:
      - errors
      title: Errors
    type_commons:AgentVersionId:
      type: string
      description: Agent version ID
      title: AgentVersionId
    type_agents:AgentVersion:
      type: object
      properties:
        topics:
          type: array
          items:
            $ref: '#/components/schemas/type_events:EventTopic'
          description: The topics the agent should listen for
        compiler:
          $ref: '#/components/schemas/type_agents:Compiler'
          description: The compiler of the agent
        source:
          type: string
          description: The source of the agent
        sourceMap:
          type: string
          description: The source map of the agent
        slug:
          type: string
          description: The slug of the agent
        options:
          type: object
          additionalProperties:
            description: Any type
          description: This field is deprecated and will be removed in the future.
            Use the `template` and `templateOptions` fields instead.
        template:
          $ref: '#/components/schemas/type_agents:AgentTemplateEnum'
          description: The template of the agent; Template options are required for
            templated agents.
        templateOptions:
          $ref: '#/components/schemas/type_agents:TemplateOptions'
          description: The options for a templated agent. Must be provided if `template`
            is provided.
        isSystem:
          type: boolean
          description: Whether the agent is a system agent. This should be false for
            all agents created by users.
        namespace:
          type: string
          description: The namespace this agent should be limited to. Right now, this
            is information only and not used to actually filter agents that run, so
            you must still specify the namespace filter in the agent code.
        packageVersions:
          type: object
          additionalProperties:
            type: string
          description: Package versions information for the agent
        commitInfo:
          type: object
          additionalProperties:
            description: Any type
          description: Commit information for the agent
        id:
          $ref: '#/components/schemas/type_commons:AgentVersionId'
        version:
          type: integer
        origin:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        agent_id:
          $ref: '#/components/schemas/type_commons:AgentId'
      required:
      - id
      - version
      - origin
      - createdAt
      - updatedAt
      - agent_id
      title: AgentVersion
    type_agents:ListAgentVersionsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agents:AgentVersion'
      title: ListAgentVersionsResponse
    type_agents:AgentVersionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_agents:AgentVersion'
      title: AgentVersionResponse
    type_commons:ActorRoleId:
      type: string
      description: Actor Role ID
      title: ActorRoleId
    type_commons:RoleId:
      type: string
      description: Role ID
      title: RoleId
    type_commons:UserId:
      type: string
      description: User ID
      title: UserId
    type_commons:GuestId:
      type: string
      description: Guest ID
      title: GuestId
    type_commons:ActorIdUnion:
      oneOf:
      - $ref: '#/components/schemas/type_commons:UserId'
      - $ref: '#/components/schemas/type_commons:AgentId'
      - $ref: '#/components/schemas/type_commons:GuestId'
      title: ActorIdUnion
    type_roles:ResourceIdUnion:
      oneOf:
      - $ref: '#/components/schemas/type_commons:AccountId'
      - $ref: '#/components/schemas/type_commons:EnvironmentId'
      - $ref: '#/components/schemas/type_commons:SpaceId'
      title: ResourceIdUnion
    type_roles:ActorRoleResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:ActorRoleId'
        roleId:
          $ref: '#/components/schemas/type_commons:RoleId'
        actorId:
          $ref: '#/components/schemas/type_commons:ActorIdUnion'
        resourceId:
          $ref: '#/components/schemas/type_roles:ResourceIdUnion'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - roleId
      - actorId
      - resourceId
      - createdAt
      - updatedAt
      title: ActorRoleResponse
    type_roles:ListActorRolesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_roles:ActorRoleResponse'
      required:
      - data
      title: ListActorRolesResponse
    type_roles:AssignActorRoleRequest:
      type: object
      properties:
        roleId:
          $ref: '#/components/schemas/type_commons:RoleId'
        resourceId:
          $ref: '#/components/schemas/type_roles:ResourceIdUnion'
      required:
      - roleId
      - resourceId
      title: AssignActorRoleRequest
    type_roles:AssignRoleResponseData:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:ActorRoleId'
        roleId:
          $ref: '#/components/schemas/type_commons:RoleId'
        actorId:
          $ref: '#/components/schemas/type_commons:ActorIdUnion'
        resourceId:
          $ref: '#/components/schemas/type_roles:ResourceIdUnion'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - roleId
      - actorId
      - resourceId
      - createdAt
      - updatedAt
      title: AssignRoleResponseData
    type_roles:AssignRoleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_roles:AssignRoleResponseData'
      required:
      - data
      title: AssignRoleResponse
    type_commons:AgentLogId:
      type: string
      description: Agent Log ID
      title: AgentLogId
    type_commons:EventId:
      type: string
      description: Event ID
      title: EventId
    type_agents:AgentLog:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:AgentLogId'
        agentId:
          $ref: '#/components/schemas/type_commons:AgentId'
        eventId:
          $ref: '#/components/schemas/type_commons:EventId'
        success:
          type: boolean
          description: Whether the agent execution was successful
        createdAt:
          type: string
        completedAt:
          type: string
        log:
          type: string
          description: The log of the agent execution
        queueLag:
          type: integer
          description: The time difference between when the event was created and
            when the agent started processing it
        namespaces:
          type: array
          items:
            type: string
          description: The namespaces associated with the event
        context:
          type: object
          additionalProperties:
            description: Any type
          description: The context of the agent execution
        topic:
          type: string
          description: The topic of the agent execution
        duration:
          type: integer
          description: The duration of the agent execution in milliseconds
        memoryUsage:
          type: integer
          description: The memory usage of the agent execution in bytes
        requestTime:
          type: integer
          description: The amount of time the agent spent making HTTP requests in
            milliseconds
        requestCount:
          type: integer
          description: The number of HTTP requests made by the agent
        bytesReceived:
          type: integer
          description: The total amount of data received by the agent during execution
            in bytes
        bytesSent:
          type: integer
          description: The total amount of data sent by the agent during execution
            in bytes
      required:
      - id
      - agentId
      - eventId
      - success
      - createdAt
      - completedAt
      description: A log of an agent execution
      title: AgentLog
    type_agents:GetAgentLogsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agents:AgentLog'
      title: GetAgentLogsResponse
    type_agents:DetailedAgentLog:
      type: object
      properties:
        eventId:
          $ref: '#/components/schemas/type_commons:EventId'
        success:
          type: boolean
          description: Whether the agent execution was successful
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
        duration:
          type: integer
          description: The duration of the agent execution
        topic:
          type: string
          description: The topics of the agent execution
        context:
          type: object
          additionalProperties:
            description: Any type
          description: The context of the agent execution
        log:
          type: string
          description: The log of the agent execution
      required:
      - eventId
      - success
      - createdAt
      - completedAt
      - duration
      - topic
      - context
      description: A log of an agent execution
      title: DetailedAgentLog
    type_agents:GetDetailedAgentLogResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_agents:DetailedAgentLog'
      required:
      - data
      title: GetDetailedAgentLogResponse
    type_commons:SuccessQueryParameter:
      type: boolean
      description: Boolean
      title: SuccessQueryParameter
    type_agents:GetDetailedAgentLogsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agents:DetailedAgentLog'
      required:
      - data
      title: GetDetailedAgentLogsResponse
    type_agents:Execution:
      type: object
      properties:
        eventId:
          $ref: '#/components/schemas/type_commons:EventId'
        success:
          type: boolean
          description: Whether the agent execution was successful
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The space ID associated with this execution
        createdAt:
          type: string
          format: date-time
        completedAt:
          type: string
          format: date-time
        duration:
          type: integer
          description: The duration of the agent execution
        requestTime:
          type: integer
          description: The amount of time the agent spent making http requests
        requestCount:
          type: integer
          description: The number of requests made by the agent
        memoryUsage:
          type: integer
          description: The memory usage of the agent
        topic:
          type: string
          description: The topics of the agent execution
      required:
      - eventId
      - success
      - createdAt
      - completedAt
      - duration
      - topic
      description: An execution of an agent
      title: Execution
    type_agents:GetExecutionsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_agents:Execution'
      required:
      - data
      title: GetExecutionsResponse
    type_apps:AppType:
      type: string
      enum:
      - PORTAL
      - PROJECTS
      - MAPPING
      - WORKBOOKS
      - CUSTOM
      title: AppType
    type_apps:App:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:AppId'
        name:
          type: string
        namespace:
          type: string
        type:
          $ref: '#/components/schemas/type_apps:AppType'
        entity:
          type: string
        entityPlural:
          type: string
        icon:
          type: string
        metadata:
          description: Any type
        environmentFilters:
          description: Any type
        blueprint:
          description: Any type
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
        activatedAt:
          type: string
          format: date-time
      required:
      - id
      - name
      - namespace
      - type
      - entity
      - entityPlural
      - metadata
      - environmentFilters
      - createdAt
      - updatedAt
      description: An app
      title: App
    type_apps:AppsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_apps:App'
      required:
      - data
      title: AppsResponse
    type_apps:AppResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_apps:App'
      required:
      - data
      title: AppResponse
    type_apps:AppPatch:
      type: object
      properties:
        name:
          type: string
        namespace:
          type: string
        entity:
          type: string
        entityPlural:
          type: string
        icon:
          type: string
        metadata:
          description: Any type
        environmentFilters:
          description: Any type
        blueprint:
          description: Any type
        activatedAt:
          type: string
          format: date-time
      description: Update an app
      title: AppPatch
    type_apps:AppCreate:
      type: object
      properties:
        name:
          type: string
        namespace:
          type: string
        type:
          $ref: '#/components/schemas/type_apps:AppType'
        entity:
          type: string
        entityPlural:
          type: string
        icon:
          type: string
        metadata:
          description: Any type
        environmentFilters:
          description: Any type
        blueprint:
          description: Any type
      required:
      - name
      - namespace
      - type
      description: Create an app
      title: AppCreate
    type_apps:SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
      title: SuccessResponse
    type_commons:ConstraintId:
      type: string
      description: Constraint ID
      title: ConstraintId
    type_apps:ConstraintResource:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:ConstraintId'
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
        validator:
          type: string
        description:
          type: string
        function:
          type: string
        options:
          description: Any type
        label:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - appId
      - validator
      - createdAt
      - updatedAt
      title: ConstraintResource
    type_apps:ConstraintsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_apps:ConstraintResource'
      required:
      - data
      title: ConstraintsResponse
    type_apps:ConstraintCreate:
      type: object
      properties:
        description:
          type: string
        function:
          type: string
        options:
          description: Any type
        label:
          type: string
        validator:
          type: string
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
      title: ConstraintCreate
    type_apps:ConstraintResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_apps:ConstraintResource'
      required:
      - data
      title: ConstraintResponse
    type_apps:ConstraintVersionResource:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:ConstraintId'
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
        validator:
          type: string
        description:
          type: string
        function:
          type: string
        options:
          description: Any type
        label:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        version:
          type: integer
        prompt:
          type: string
      required:
      - id
      - appId
      - validator
      - createdAt
      - updatedAt
      - version
      title: ConstraintVersionResource
    type_apps:ConstraintVersionsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_apps:ConstraintVersionResource'
      required:
      - data
      title: ConstraintVersionsResponse
    type_apps:ConstraintVersionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_apps:ConstraintVersionResource'
      required:
      - data
      title: ConstraintVersionResponse
    type_apps:ConstraintUpdate:
      type: object
      properties:
        description:
          type: string
        function:
          type: string
        options:
          description: Any type
        label:
          type: string
      title: ConstraintUpdate
    type_assistant:PromptTypeQueryEnum:
      type: string
      enum:
      - ALL
      - AI_ASSIST
      - CONSTRAINT_GENERATION
      title: PromptTypeQueryEnum
    type_commons:PromptId:
      type: string
      description: Prompt ID
      title: PromptId
    type_assistant:PromptTypeEnum:
      type: string
      enum:
      - AI_ASSIST
      - CONSTRAINT_GENERATION
      title: PromptTypeEnum
    type_assistant:Prompt:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:PromptId'
        createdById:
          type: string
          description: ID of the user/guest who created the prompt
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        promptType:
          $ref: '#/components/schemas/type_assistant:PromptTypeEnum'
          description: Type of prompt
        prompt:
          type: string
          description: Text for prompts for AI Assist
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
      required:
      - id
      - createdById
      - accountId
      - promptType
      - prompt
      - createdAt
      - updatedAt
      title: Prompt
    type_assistant:PromptsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_assistant:Prompt'
      required:
      - data
      title: PromptsResponse
    type_assistant:PromptResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_assistant:Prompt'
      required:
      - data
      title: PromptResponse
    type_assistant:PromptPatch:
      type: object
      properties:
        prompt:
          type: string
      required:
      - prompt
      description: Update a prompts
      title: PromptPatch
    type_assistant:PromptCreate:
      type: object
      properties:
        promptType:
          $ref: '#/components/schemas/type_assistant:PromptTypeEnum'
          description: Type of prompt; Defaults to AI_ASSIST
        prompt:
          type: string
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
      required:
      - prompt
      - environmentId
      - spaceId
      description: Create a prompts
      title: PromptCreate
    type_auth:ApiKeyId:
      type: string
      description: Api Key ID
      title: ApiKeyId
    type_auth:RawKey:
      type: string
      description: Raw Api Key
      title: RawKey
    type_auth:ApiKeyType:
      type: string
      enum:
      - PUBLISHABLE
      - SECRET
      title: ApiKeyType
    type_auth:ApiKeyOperation:
      type: object
      properties:
        path:
          type: string
        method:
          type: string
      required:
      - path
      - method
      title: ApiKeyOperation
    type_auth:ApiKey:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_auth:ApiKeyId'
        rawKey:
          $ref: '#/components/schemas/type_auth:RawKey'
        type:
          $ref: '#/components/schemas/type_auth:ApiKeyType'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        operations:
          type: array
          items:
            $ref: '#/components/schemas/type_auth:ApiKeyOperation'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
        secret:
          type: string
      required:
      - id
      - type
      - operations
      - createdAt
      description: API Key used for authenticating against our APIs
      title: ApiKey
    type_auth:PublishableKeyResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_auth:ApiKey'
      required:
      - data
      title: PublishableKeyResponse
    type_auth:SftpCredentials:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        host:
          type: string
        port:
          type: string
      required:
      - username
      - password
      - host
      - port
      description: Credentials being used to login to SFTP with host and port
      title: SftpCredentials
    type_commons:CanvasId:
      type: string
      description: Canvas ID
      title: CanvasId
    type_commons:CanvasAreaId:
      type: string
      description: Canvas Area ID
      title: CanvasAreaId
    type_canvas-areas:CanvasAreaLayout:
      type: string
      enum:
      - split
      - drawer
      - modal
      title: CanvasAreaLayout
    type_canvas-areas:CanvasAreaType:
      type: string
      enum:
      - mapping
      - header
      - agent
      - form
      - sheet
      - sheets
      - workbook
      - document
      - file
      - iframe
      title: CanvasAreaType
    type_canvas-areas:CanvasAreaPosition:
      type: string
      enum:
      - top
      - left
      - right
      - middle
      - bottom
      title: CanvasAreaPosition
    type_canvas-areas:CanvasAreaVisibility:
      type: string
      enum:
      - visible
      - hidden
      - optional
      - skeleton
      title: CanvasAreaVisibility
    type_canvas-areas:CanvasArea:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:CanvasAreaId'
        canvasId:
          $ref: '#/components/schemas/type_commons:CanvasId'
          description: ID of the canvas this area belongs to
        parentId:
          $ref: '#/components/schemas/type_commons:CanvasAreaId'
          description: ID of the parent canvas area, if this is a nested area
        config:
          description: Additional configuration data for the canvas area
        metadata:
          description: Metadata associated with the canvas area
        layout:
          $ref: '#/components/schemas/type_canvas-areas:CanvasAreaLayout'
          description: Layout configuration for the canvas area
        overlay:
          description: Overlay configuration for the canvas area
        type:
          $ref: '#/components/schemas/type_canvas-areas:CanvasAreaType'
          description: Type of the canvas area
        position:
          $ref: '#/components/schemas/type_canvas-areas:CanvasAreaPosition'
          description: Position of the canvas area within the canvas
        visibility:
          $ref: '#/components/schemas/type_canvas-areas:CanvasAreaVisibility'
          description: Visibility of the canvas area
        createdAt:
          type: string
          format: date-time
          description: When the canvas area was created
        updatedAt:
          type: string
          format: date-time
          description: When the canvas area was last updated
        deletedAt:
          type: string
          format: date-time
          description: When the canvas area was deleted, if applicable
      required:
      - id
      - canvasId
      - config
      - metadata
      - layout
      - overlay
      - type
      - position
      - visibility
      - createdAt
      - updatedAt
      description: A canvas area represents a section within a canvas for organizing
        content
      title: CanvasArea
    type_canvas-areas:ListCanvasAreasResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_canvas-areas:CanvasArea'
      required:
      - data
      title: ListCanvasAreasResponse
    type_canvas-areas:CanvasAreaResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_canvas-areas:CanvasArea'
      required:
      - data
      title: CanvasAreaResponse
    type_commons:CommitId:
      type: string
      description: Commit ID
      title: CommitId
    type_commons:SheetId:
      type: string
      description: Sheet ID
      title: SheetId
    type_commits:Commit:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:CommitId'
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        createdBy:
          type: string
          description: The actor (user or system) who created the commit
        completedBy:
          type: string
          description: The actor (user or system) who completed the commit
        createdAt:
          type: string
          format: date-time
          description: The time the commit was created
        completedAt:
          type: string
          format: date-time
          description: The time the commit was acknowledged
      required:
      - id
      - sheetId
      - createdBy
      - createdAt
      description: A commit version
      title: Commit
    type_commits:CommitResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_commits:Commit'
      required:
      - data
      title: CommitResponse
    type_data-clips:SharedLinkAccess:
      type: string
      enum:
      - public
      - restricted
      title: SharedLinkAccess
    type_data-clips:CreateDataClipRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the DataClip.
        description:
          type: string
          description: A description of the DataClip.
        sourceSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the source sheet.
        collaborators:
          type: array
          items:
            type: string
          description: The list of collaborators.
        sharedLinkAccess:
          $ref: '#/components/schemas/type_data-clips:SharedLinkAccess'
          description: The type of shared link to generate for the DataClip.
      required:
      - name
      - sourceSheetId
      title: CreateDataClipRequest
    type_commons:DataClipId:
      type: string
      description: Data Clip ID
      title: DataClipId
    type_data-clips:DataClip:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:DataClipId'
        name:
          type: string
          description: The name of the DataClip.
        description:
          type: string
          description: A description of the DataClip.
        sourceSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the source sheet.
        clipSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the sheet that is clipped from source sheet.
        workbookId:
          type: string
          description: The ID of the workbook.
        status:
          type: string
          description: The status of the DataClip.
        createdBy:
          type: string
          description: The user who created the DataClip.
        mergedAt:
          type: string
          format: date-time
          description: The date when the DataClip was merged.
        deletedAt:
          type: string
          format: date-time
          description: The date when the DataClip was deleted.
        updatedAt:
          type: string
          format: date-time
          description: The date when the DataClip was updated.
        createdAt:
          type: string
          format: date-time
          description: The date when the DataClip was created.
        guestLinkUrl:
          type: string
          description: A URL for guests to access the DataClip.
        accessToken:
          type: string
          description: A signed token associated with the guest link.
        sharedLinkAccess:
          type: string
          description: Indicates the shared link access level, public or restricted
      required:
      - id
      - name
      - sourceSheetId
      - clipSheetId
      - workbookId
      - status
      - createdBy
      - updatedAt
      - createdAt
      title: DataClip
    type_data-clips:UpdateDataClipRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the DataClip.
        description:
          type: string
          description: A description of the DataClip.
        status:
          type: string
          description: The status of the DataClip.
        collaborators:
          type: array
          items:
            type: string
          description: The list of collaborators.
        sharedLinkAccess:
          $ref: '#/components/schemas/type_data-clips:SharedLinkAccess'
          description: The type of shared link to generate for the DataClip.
      required:
      - name
      title: UpdateDataClipRequest
    type_data-clips:DataClipResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_data-clips:DataClip'
          description: The list of DataClips.
      required:
      - data
      title: DataClipResponse
    type_commons:RecordId:
      type: string
      description: Record ID
      title: RecordId
    type_data-clips:AddRecordsToClipRequest:
      type: object
      properties:
        recordIds:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:RecordId'
      required:
      - recordIds
      title: AddRecordsToClipRequest
    type_records:ValidationType:
      type: string
      enum:
      - error
      - warn
      - info
      title: ValidationType
    type_records:ValidationSource:
      type: string
      enum:
      - required-constraint
      - unique-constraint
      - custom-logic
      - unlinked
      - invalid-option
      - is-artifact
      title: ValidationSource
    type_commons:JSONPathString:
      type: string
      description: A JSONPath string - https://www.rfc-editor.org/rfc/rfc9535
      title: JSONPathString
    type_records:ValidationMessage:
      type: object
      properties:
        field:
          type: string
        type:
          $ref: '#/components/schemas/type_records:ValidationType'
        source:
          $ref: '#/components/schemas/type_records:ValidationSource'
        message:
          type: string
        path:
          $ref: '#/components/schemas/type_commons:JSONPathString'
          description: This JSONPath is based on the root of mapped cell object.
      description: Record data validation messages
      title: ValidationMessage
    type_records:CellValueUnion:
      oneOf:
      - type: string
      - type: integer
      - type: integer
        format: int64
      - type: number
        format: double
      - type: boolean
      - type: string
        format: date
      - type: string
        format: date-time
      - type: array
        items:
          type: string
      title: CellValueUnion
    type_commons:VersionId:
      type: string
      description: Version ID
      title: VersionId
    type_records:CellConfig:
      type: object
      properties:
        readonly:
          type: boolean
      description: CellConfig
      title: CellConfig
    type_records:RecordConfig:
      type: object
      properties:
        readonly:
          type: boolean
        fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/type_records:CellConfig'
        markedForDeletion:
          type: boolean
      description: Configuration of a record or specific fields in the record
      title: RecordConfig
    type_records:CellValue:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records:CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
      title: CellValue
    type_records:RecordData:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_records:CellValue'
      description: A single row of data in a Sheet
      title: RecordData
    type_records:Record:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:RecordId'
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
        valid:
          type: boolean
          description: Auto-generated value based on whether the record contains a
            field with an error message. Cannot be set via the API.
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
          description: This record level `messages` property is deprecated and no
            longer stored or used. Use the `messages` property on the individual cell
            values instead. This property will be removed in a future release.
        metadata:
          type: object
          additionalProperties:
            description: Any type
        config:
          $ref: '#/components/schemas/type_records:RecordConfig'
        values:
          $ref: '#/components/schemas/type_records:RecordData'
      required:
      - id
      - values
      description: A single row of data in a Sheet
      title: Record
    type_records:Records:
      type: array
      items:
        $ref: '#/components/schemas/type_records:Record'
      description: List of Record objects
      title: Records
    type_records:CellValueWithLinks:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records:CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
        links:
          $ref: '#/components/schemas/type_records:Records'
      title: CellValueWithLinks
    type_records:RecordDataWithLinks:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_records:CellValueWithLinks'
      description: A single row of data in a Sheet, including links to related rows
      title: RecordDataWithLinks
    type_records:RecordWithLinks:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:RecordId'
        values:
          $ref: '#/components/schemas/type_records:RecordDataWithLinks'
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
        config:
          $ref: '#/components/schemas/type_records:RecordConfig'
      required:
      - id
      - values
      description: A single row of data in a Sheet, including links to related rows
      title: RecordWithLinks
    type_records:RecordsWithLinks:
      type: array
      items:
        $ref: '#/components/schemas/type_records:RecordWithLinks'
      description: List of Record objects, including links to related rows
      title: RecordsWithLinks
    type_records:FieldRecordCounts:
      type: object
      properties:
        total:
          type: integer
        valid:
          type: integer
        error:
          type: integer
        empty:
          type: integer
      required:
      - total
      - valid
      - error
      - empty
      title: FieldRecordCounts
    type_records:RecordCounts:
      type: object
      properties:
        total:
          type: integer
        valid:
          type: integer
        error:
          type: integer
        errorsByField:
          type: object
          additionalProperties:
            type: integer
        byField:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/type_records:FieldRecordCounts'
          description: Counts for valid, error, and total records grouped by field
            key
      required:
      - total
      - valid
      - error
      title: RecordCounts
    type_records:RecordsResponseData:
      type: object
      properties:
        success:
          type: boolean
        records:
          $ref: '#/components/schemas/type_records:RecordsWithLinks'
        counts:
          $ref: '#/components/schemas/type_records:RecordCounts'
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
      required:
      - success
      title: RecordsResponseData
    type_data-clips:ListDataClipResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips:DataClipResponse'
      required:
      - data
      title: ListDataClipResponse
    type_records:DiffValue:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records:CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
        snapshotValue:
          $ref: '#/components/schemas/type_records:CellValueUnion'
        clipValue:
          $ref: '#/components/schemas/type_records:CellValueUnion'
        warning:
          type: boolean
        warnings:
          type: array
          items:
            type: string
      title: DiffValue
    type_records:DiffData:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_records:DiffValue'
      title: DiffData
    type_data-clips:ResolveType:
      type: string
      enum:
      - conflict
      - resolve
      title: ResolveType
    type_data-clips:ResolveTo:
      type: string
      enum:
      - clip
      - main
      - snapshot
      title: ResolveTo
    type_data-clips:RemovedFromMainResolution:
      type: string
      enum:
      - ignore
      - restore
      title: RemovedFromMainResolution
    type_data-clips:Resolve:
      type: object
      properties:
        field:
          type: string
        type:
          $ref: '#/components/schemas/type_data-clips:ResolveType'
        resolveTo:
          $ref: '#/components/schemas/type_data-clips:ResolveTo'
        clip_value_reference:
          type: string
        main_value_reference:
          type: string
        removedFromMainResolution:
          $ref: '#/components/schemas/type_data-clips:RemovedFromMainResolution'
      description: Conflict resolutions for a record
      title: Resolve
    type_records:DiffRecord:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:RecordId'
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
        valid:
          type: boolean
          description: Auto-generated value based on whether the record contains a
            field with an error message. Cannot be set via the API.
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
          description: This record level `messages` property is deprecated and no
            longer stored or used. Use the `messages` property on the individual cell
            values instead. This property will be removed in a future release.
        metadata:
          type: object
          additionalProperties:
            description: Any type
        config:
          $ref: '#/components/schemas/type_records:RecordConfig'
        values:
          $ref: '#/components/schemas/type_records:DiffData'
        resolves:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips:Resolve'
      required:
      - id
      - values
      title: DiffRecord
    type_records:DiffRecords:
      type: array
      items:
        $ref: '#/components/schemas/type_records:DiffRecord'
      description: List of DiffRecord objects
      title: DiffRecords
    type_records:DiffRecordsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_records:DiffRecords'
      required:
      - data
      title: DiffRecordsResponse
    type_data-clips:GetResolutionIndexResponse:
      type: object
      properties:
        index:
          type: integer
          description: Zero-based index of the record in the filtered list
      required:
      - index
      title: GetResolutionIndexResponse
    type_data-clips:ResolvedRecords:
      type: object
      properties:
        recordId:
          $ref: '#/components/schemas/type_commons:RecordId'
          description: The record ID to update
        resolves:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips:Resolve'
          description: The resolutions for the record
      required:
      - recordId
      - resolves
      title: ResolvedRecords
    type_data-clips:UpdateResolutionRequest:
      type: object
      properties:
        resolvedRecords:
          type: array
          items:
            $ref: '#/components/schemas/type_data-clips:ResolvedRecords'
          description: Array of record-specific resolutions to update
      required:
      - resolvedRecords
      title: UpdateResolutionRequest
    type_data-retention-policies:DataRetentionPolicyEnum:
      type: string
      enum:
      - lastActivity
      - sinceCreated
      description: The type of data retention policy on an environment
      title: DataRetentionPolicyEnum
    type_commons:DataRetentionPolicyId:
      type: string
      description: Data Retention Policy ID
      title: DataRetentionPolicyId
    type_data-retention-policies:DataRetentionPolicy:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyEnum'
        period:
          type: integer
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        id:
          $ref: '#/components/schemas/type_commons:DataRetentionPolicyId'
        createdAt:
          type: string
          format: date-time
          description: Date the policy was created
        updatedAt:
          type: string
          format: date-time
          description: Date the policy was last updated
      required:
      - type
      - period
      - environmentId
      - id
      - createdAt
      - updatedAt
      description: A data retention policy belonging to an environment
      title: DataRetentionPolicy
    type_data-retention-policies:ListDataRetentionPoliciesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicy'
      required:
      - data
      title: ListDataRetentionPoliciesResponse
    type_data-retention-policies:DataRetentionPolicyConfig:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicyEnum'
        period:
          type: integer
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
      required:
      - type
      - period
      - environmentId
      title: DataRetentionPolicyConfig
    type_data-retention-policies:DataRetentionPolicyResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_data-retention-policies:DataRetentionPolicy'
      required:
      - data
      title: DataRetentionPolicyResponse
    type_commons:Action:
      type: object
      properties:
        slug:
          type: string
          description: '**This is deprecated. Use `operation` instead.**'
        operation:
          type: string
          description: This will become the job operation that is triggered
        mode:
          $ref: '#/components/schemas/type_commons:ActionMode'
          description: Foreground and toolbarBlocking action mode will prevent interacting
            with the resource until complete
        tooltip:
          type: string
          description: A tooltip that appears when hovering the action button
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionMessage'
        type:
          type: string
          description: '**This is deprecated.**'
        description:
          type: string
          description: The text that appears in the dialog after the action is clicked.
        schedule:
          $ref: '#/components/schemas/type_commons:ActionSchedule'
          description: Determines if the action should happen on a regular cadence.
        primary:
          type: boolean
          description: A primary action will be more visibly present, whether in Sheet
            or Workbook.
        confirm:
          type: boolean
          description: Whether to show a modal to confirm the action
        icon:
          type: string
          description: Icon will work on primary actions. It will only accept an already
            existing Flatfile design system icon.
        requireAllValid:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        requireSelection:
          type: boolean
          description: '**This is deprecated. Use `constraints` instead.**'
        inputForm:
          $ref: '#/components/schemas/type_commons:InputForm'
          description: Adds an input form for this action after it is clicked.
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:ActionConstraint'
          description: A limitation or restriction on the action.
        mount:
          $ref: '#/components/schemas/type_commons:ActionMount'
        guide:
          $ref: '#/components/schemas/type_commons:Guide'
        guardrail:
          $ref: '#/components/schemas/type_commons:Guardrail'
        createdFrom:
          $ref: '#/components/schemas/type_commons:ActionId'
          description: The action that this action was cloned from
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time this action was propagated to a workbook
        deletedAt:
          type: string
          format: date-time
          description: The time this action was deleted
        invalidConditionalMessaging:
          type: boolean
          description: When enabled, shows dynamic confirmation messages based on
            record validation status instead of the static description
        validRecordsMessage:
          type: string
          description: Custom message to show when all records are valid (only used
            when invalidConditionalMessaging is true)
        invalidRecordsMessage:
          type: string
          description: Custom message to show when there are invalid records (only
            used when invalidConditionalMessaging is true)
        label:
          type: string
          description: The text on the Button itself
      required:
      - label
      title: Action
    type_commons:DocumentId:
      type: string
      description: Document ID
      title: DocumentId
    type_documents:Document:
      type: object
      properties:
        title:
          type: string
        body:
          type: string
        treatments:
          type: array
          items:
            type: string
          description: Certain treatments will cause your Document to look or behave
            differently.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
        id:
          $ref: '#/components/schemas/type_commons:DocumentId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        createdAt:
          type: string
          format: date-time
          description: Date the document was created
        updatedAt:
          type: string
          format: date-time
          description: Date the document was last updated
        createdFrom:
          $ref: '#/components/schemas/type_commons:DocumentId'
          description: The document id of the template that was used to create this
            document
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time the document template configuration was propagated
            to this document
      required:
      - title
      - body
      - id
      - createdAt
      - updatedAt
      description: A document (markdown components) belong to a space
      title: Document
    type_documents:ListDocumentsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_documents:Document'
      required:
      - data
      title: ListDocumentsResponse
    type_documents:DocumentConfig:
      type: object
      properties:
        title:
          type: string
        body:
          type: string
        treatments:
          type: array
          items:
            type: string
          description: Certain treatments will cause your Document to look or behave
            differently.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
      required:
      - title
      - body
      title: DocumentConfig
    type_documents:DocumentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_documents:Document'
      required:
      - data
      title: DocumentResponse
    type_entitlements:Entitlement:
      type: object
      properties:
        key:
          type: string
          description: Short name for the entitlement
        metadata:
          description: Contains conditions or limits for an entitlement
      required:
      - key
      - metadata
      description: An entitlement belonging to a resource
      title: Entitlement
    type_entitlements:ListEntitlementsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_entitlements:Entitlement'
      required:
      - data
      title: ListEntitlementsResponse
    type_environments:GuestAuthenticationEnum:
      type: string
      enum:
      - shared_link
      - magic_link
      description: The type of authentication to use for guests
      title: GuestAuthenticationEnum
    type_environments:Environment:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        name:
          type: string
          description: The name of the environment
        isProd:
          type: boolean
          description: Whether or not the environment is a production environment
        guestAuthentication:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuestAuthenticationEnum'
        features:
          type: object
          additionalProperties:
            description: Any type
        metadata:
          type: object
          additionalProperties:
            description: Any type
        translationsPath:
          type: string
        namespaces:
          type: array
          items:
            type: string
        languageOverride:
          type: string
      required:
      - id
      - accountId
      - name
      - isProd
      - guestAuthentication
      - features
      - metadata
      title: Environment
    type_environments:ListEnvironmentsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:Environment'
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
      required:
      - data
      title: ListEnvironmentsResponse
    type_environments:EnvironmentConfigCreate:
      type: object
      properties:
        name:
          type: string
          description: The name of the environment
        isProd:
          type: boolean
          description: Whether or not the environment is a production environment
        guestAuthentication:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuestAuthenticationEnum'
        metadata:
          type: object
          additionalProperties:
            description: Any type
        translationsPath:
          type: string
        namespaces:
          type: array
          items:
            type: string
        languageOverride:
          type: string
      required:
      - name
      - isProd
      description: Properties used to create a new environment
      title: EnvironmentConfigCreate
    type_environments:EnvironmentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_environments:Environment'
      required:
      - data
      title: EnvironmentResponse
    type_spaces:EventToken:
      type: object
      properties:
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
          description: The ID of the Account.
        subscribeKey:
          type: string
          description: The id of the event bus to subscribe to
        ttl:
          type: integer
          description: Time to live in minutes
        token:
          type: string
          description: This should be your API key.
      description: Properties used to allow users to connect to the event bus
      title: EventToken
    type_spaces:EventTokenResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_spaces:EventToken'
      required:
      - data
      title: EventTokenResponse
    type_environments:EnvironmentConfigUpdate:
      type: object
      properties:
        name:
          type: string
          description: The name of the environment
        isProd:
          type: boolean
          description: Whether or not the environment is a production environment
        guestAuthentication:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuestAuthenticationEnum'
        metadata:
          type: object
          additionalProperties:
            description: Any type
        translationsPath:
          type: string
        namespaces:
          type: array
          items:
            type: string
        languageOverride:
          type: string
      description: Properties used to update an environment
      title: EnvironmentConfigUpdate
    type_commons:GuideId:
      type: string
      description: Guide ID
      title: GuideId
    type_environments:GuideVersionResource:
      type: object
      properties:
        id:
          type: string
        version:
          type: integer
        content:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - version
      - content
      - createdAt
      - updatedAt
      description: A version of a guide
      title: GuideVersionResource
    type_environments:GuideResource:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:GuideId'
        description:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        slug:
          type: string
        title:
          type: string
        versions:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuideVersionResource'
        blocks:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - slug
      - title
      - versions
      - blocks
      - createdAt
      - updatedAt
      description: A guide
      title: GuideResource
    type_environments:GuideListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuideResource'
      required:
      - data
      title: GuideListResponse
    type_environments:GuideDetailResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_environments:GuideResource'
      required:
      - data
      title: GuideDetailResponse
    type_environments:GuideUpdateRequest:
      type: object
      properties:
        description:
          type: string
        title:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        slug:
          type: string
        versions:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuideVersionResource'
        blocks:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        environmentId:
          type: string
      description: Update a guide
      title: GuideUpdateRequest
    type_environments:GuideCreateRequest:
      type: object
      properties:
        description:
          type: string
        title:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        slug:
          type: string
        blocks:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        environmentId:
          type: string
      required:
      - description
      - title
      - slug
      - blocks
      - environmentId
      description: Create a guide
      title: GuideCreateRequest
    type_environments:GuideDeleteResponseData:
      type: object
      properties:
        success:
          type: boolean
      required:
      - success
      title: GuideDeleteResponseData
    type_environments:GuideDeleteResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_environments:GuideDeleteResponseData'
      required:
      - data
      title: GuideDeleteResponse
    type_environments:GuideVersionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_environments:GuideVersionResource'
      required:
      - data
      title: GuideVersionResponse
    type_events:Domain:
      type: string
      enum:
      - file
      - space
      - workbook
      - flag
      - job
      - document
      - sheet
      - program
      - secret
      - cron
      - environment
      - data-clip
      - canvas
      - canvas-area
      - thread
      description: The domain of the event
      title: Domain
    type_events:EventContextSlugs:
      type: object
      properties:
        space:
          type: string
          description: The slug of the space
        workbook:
          type: string
          description: The slug of the workbook
        sheet:
          type: string
          description: The slug of the sheet
      title: EventContextSlugs
    type_events:ActionName:
      type: string
      description: Name of an action
      title: ActionName
    type_commons:WorkbookId:
      type: string
      description: Workbook ID
      title: WorkbookId
    type_events:SheetSlug:
      type: string
      description: Sheet Slug
      title: SheetSlug
    type_commons:SnapshotId:
      type: string
      description: Snapshot ID
      title: SnapshotId
    type_commons:JobId:
      type: string
      description: Pipeline Job ID
      title: JobId
    type_commons:ProgramId:
      type: string
      description: Mapping Program ID
      title: ProgramId
    type_commons:FileId:
      type: string
      description: File ID
      title: FileId
    type_commons:ThreadId:
      type: string
      description: Thread ID
      title: ThreadId
    type_events:Context:
      type: object
      properties:
        namespaces:
          type: array
          items:
            type: string
          description: The namespaces of the event
        slugs:
          $ref: '#/components/schemas/type_events:EventContextSlugs'
          description: The slugs of related resources
        actionName:
          $ref: '#/components/schemas/type_events:ActionName'
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        sheetSlug:
          $ref: '#/components/schemas/type_events:SheetSlug'
        snapshotId:
          $ref: '#/components/schemas/type_commons:SnapshotId'
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
        jobId:
          $ref: '#/components/schemas/type_commons:JobId'
        programId:
          $ref: '#/components/schemas/type_commons:ProgramId'
        fileId:
          $ref: '#/components/schemas/type_commons:FileId'
        documentId:
          $ref: '#/components/schemas/type_commons:DocumentId'
        precedingEventId:
          $ref: '#/components/schemas/type_commons:EventId'
        actorId:
          type: string
          description: Can be a UserId, GuestId, or AgentId
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
        actionId:
          $ref: '#/components/schemas/type_commons:ActionId'
        dataClipId:
          $ref: '#/components/schemas/type_commons:DataClipId'
        threadId:
          $ref: '#/components/schemas/type_commons:ThreadId'
        filters:
          type: object
          additionalProperties:
            type: string
        entityId:
          type: string
      required:
      - accountId
      - environmentId
      description: The context of the event
      title: Context
    type_events:Progress:
      type: object
      properties:
        current:
          type: integer
          description: The current progress of the event
        total:
          type: integer
          description: The total number of events in this group
        percent:
          type: integer
          description: The percent complete of the event group
      description: The progress of the event within a collection of iterable events
      title: Progress
    type_events:EventAttributes:
      type: object
      properties:
        targetUpdatedAt:
          type: string
          format: date-time
          description: Date the related entity was last updated
        progress:
          $ref: '#/components/schemas/type_events:Progress'
          description: The progress of the event within a collection of iterable events
      description: The attributes of the event
      title: EventAttributes
    type_events:Origin:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
      description: The origin resource of the event
      title: Origin
    type_events:Event:
      oneOf:
      - type: object
        properties:
          topic:
            type: string
            enum:
            - agent:created
            description: 'Discriminator value: agent:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - agent:updated
            description: 'Discriminator value: agent:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - agent:deleted
            description: 'Discriminator value: agent:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:created
            description: 'Discriminator value: space:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:updated
            description: 'Discriminator value: space:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:deleted
            description: 'Discriminator value: space:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:archived
            description: 'Discriminator value: space:archived'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:expired
            description: 'Discriminator value: space:expired'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:guestAdded
            description: 'Discriminator value: space:guestAdded'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - space:guestRemoved
            description: 'Discriminator value: space:guestRemoved'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - document:created
            description: 'Discriminator value: document:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - document:updated
            description: 'Discriminator value: document:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - document:deleted
            description: 'Discriminator value: document:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - workbook:created
            description: 'Discriminator value: workbook:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - workbook:updated
            description: 'Discriminator value: workbook:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - workbook:deleted
            description: 'Discriminator value: workbook:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - workbook:expired
            description: 'Discriminator value: workbook:expired'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - workbook:thawed
            description: 'Discriminator value: workbook:thawed'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - flag:created
            description: 'Discriminator value: flag:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - flag:updated
            description: 'Discriminator value: flag:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - flag:deleted
            description: 'Discriminator value: flag:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - sheet:created
            description: 'Discriminator value: sheet:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - sheet:updated
            description: 'Discriminator value: sheet:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - sheet:deleted
            description: 'Discriminator value: sheet:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - sheet:counts-updated
            description: 'Discriminator value: sheet:counts-updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - sheet:calculation-updated
            description: 'Discriminator value: sheet:calculation-updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - snapshot:created
            description: 'Discriminator value: snapshot:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - records:created
            description: 'Discriminator value: records:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - records:updated
            description: 'Discriminator value: records:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - records:deleted
            description: 'Discriminator value: records:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - file:created
            description: 'Discriminator value: file:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - file:updated
            description: 'Discriminator value: file:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - file:deleted
            description: 'Discriminator value: file:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - file:expired
            description: 'Discriminator value: file:expired'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:created
            description: 'Discriminator value: job:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:updated
            description: 'Discriminator value: job:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:deleted
            description: 'Discriminator value: job:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:failed
            description: 'Discriminator value: job:failed'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:completed
            description: 'Discriminator value: job:completed'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:ready
            description: 'Discriminator value: job:ready'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:scheduled
            description: 'Discriminator value: job:scheduled'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:outcome-acknowledged
            description: 'Discriminator value: job:outcome-acknowledged'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - job:parts-completed
            description: 'Discriminator value: job:parts-completed'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - program:created
            description: 'Discriminator value: program:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - program:updated
            description: 'Discriminator value: program:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - commit:created
            description: 'Discriminator value: commit:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - commit:updated
            description: 'Discriminator value: commit:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - commit:completed
            description: 'Discriminator value: commit:completed'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - secret:created
            description: 'Discriminator value: secret:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - secret:updated
            description: 'Discriminator value: secret:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - secret:deleted
            description: 'Discriminator value: secret:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - layer:created
            description: 'Discriminator value: layer:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - environment:created
            description: 'Discriminator value: environment:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - environment:updated
            description: 'Discriminator value: environment:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - environment:deleted
            description: 'Discriminator value: environment:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - environment:autobuild-created
            description: 'Discriminator value: environment:autobuild-created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - action:created
            description: 'Discriminator value: action:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - action:updated
            description: 'Discriminator value: action:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - action:deleted
            description: 'Discriminator value: action:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:created
            description: 'Discriminator value: data-clip:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:updated
            description: 'Discriminator value: data-clip:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:deleted
            description: 'Discriminator value: data-clip:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:collaborator-updated
            description: 'Discriminator value: data-clip:collaborator-updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:resolutions-created
            description: 'Discriminator value: data-clip:resolutions-created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:resolutions-updated
            description: 'Discriminator value: data-clip:resolutions-updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - data-clip:resolutions-refreshed
            description: 'Discriminator value: data-clip:resolutions-refreshed'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - canvas:created
            description: 'Discriminator value: canvas:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - canvas:updated
            description: 'Discriminator value: canvas:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - canvas:deleted
            description: 'Discriminator value: canvas:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - canvas-area:created
            description: 'Discriminator value: canvas-area:created'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - canvas-area:updated
            description: 'Discriminator value: canvas-area:updated'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      - type: object
        properties:
          topic:
            type: string
            enum:
            - canvas-area:deleted
            description: 'Discriminator value: canvas-area:deleted'
          domain:
            $ref: '#/components/schemas/type_events:Domain'
            description: The domain of the event
          context:
            $ref: '#/components/schemas/type_events:Context'
            description: The context of the event
          attributes:
            $ref: '#/components/schemas/type_events:EventAttributes'
            description: The attributes of the event
          callbackUrl:
            type: string
            description: The callback url to acknowledge the event
          dataUrl:
            type: string
            description: The url to retrieve the data associated with the event
          target:
            type: string
          origin:
            $ref: '#/components/schemas/type_events:Origin'
          namespaces:
            type: array
            items:
              type: string
          id:
            $ref: '#/components/schemas/type_commons:EventId'
          createdAt:
            type: string
            format: date-time
            description: Date the event was created
          deletedAt:
            type: string
            format: date-time
            description: Date the event was deleted
          acknowledgedAt:
            type: string
            format: date-time
            description: Date the event was acknowledged
          acknowledgedBy:
            type: string
            description: The actor (user or system) who acknowledged the event
          payload:
            type: object
            additionalProperties:
              description: Any type
        required:
        - topic
        - domain
        - context
        - id
        - createdAt
        - payload
      discriminator:
        propertyName: topic
      description: An event that tracks an activity within an environment
      title: Event
    type_events:ListAllEventsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_events:Event'
      required:
      - data
      title: ListAllEventsResponse
    type_events:CreateEventConfig:
      type: object
      properties:
        domain:
          $ref: '#/components/schemas/type_events:Domain'
          description: The domain of the event
        context:
          $ref: '#/components/schemas/type_events:Context'
          description: The context of the event
        attributes:
          $ref: '#/components/schemas/type_events:EventAttributes'
          description: The attributes of the event
        callbackUrl:
          type: string
          description: The callback url to acknowledge the event
        dataUrl:
          type: string
          description: The url to retrieve the data associated with the event
        target:
          type: string
        origin:
          $ref: '#/components/schemas/type_events:Origin'
        namespaces:
          type: array
          items:
            type: string
        topic:
          $ref: '#/components/schemas/type_events:EventTopic'
        payload:
          type: object
          additionalProperties:
            description: Any type
        deletedAt:
          type: string
          format: date-time
          description: Date the event was deleted
      required:
      - domain
      - context
      - topic
      - payload
      description: Properties used to create a new event
      title: CreateEventConfig
    type_events:EventResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_events:Event'
      required:
      - data
      title: EventResponse
    type_files:Mode:
      type: string
      enum:
      - import
      - export
      title: Mode
    type_files:ModelFileStatusEnum:
      type: string
      enum:
      - partial
      - analyzing
      - analyzed
      - complete
      - archived
      - purged
      - failed
      description: 'Status of the file. Partial: File is uploaded but not yet processed.
        Analyzing: Smart Extract is running. Analyzed: Smart Extract has finished
        running. Complete: File has been extracted and is ready to be used. Archived:
        File has been archived. Purged: File has been purged. Failed: File has failed
        to be extracted.'
      title: ModelFileStatusEnum
    type_files:FileOrigin:
      type: string
      enum:
      - filesystem
      - googledrive
      - box
      - onedrive
      title: FileOrigin
    type_files:FileTreatments:
      type: string
      enum:
      - IS_BASIC_FILE_SHAPE
      - IS_COMPLEX_FILE_SHAPE
      title: FileTreatments
    type_files:File:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:FileId'
        name:
          type: string
          description: Original filename
        description:
          type: string
          description: Description of the file
        ext:
          type: string
          description: Extension of the file
        mimetype:
          type: string
          description: MIME Type of the file
        encoding:
          type: string
          description: Text encoding of the file
        status:
          $ref: '#/components/schemas/type_files:ModelFileStatusEnum'
        mode:
          $ref: '#/components/schemas/type_files:Mode'
          description: The storage mode of file
        size:
          type: integer
          description: Size of file in bytes
        bytesReceived:
          type: integer
          description: Number of bytes that have been uploaded so far (useful for
            progress tracking)
        createdAt:
          type: string
          format: date-time
          description: Date the file was created
        updatedAt:
          type: string
          format: date-time
          description: Date the file was last updated
        expiredAt:
          type: string
          format: date-time
          description: Date the file was expired
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
        origin:
          $ref: '#/components/schemas/type_files:FileOrigin'
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/type_files:FileTreatments'
      required:
      - id
      - name
      - ext
      - mimetype
      - encoding
      - status
      - size
      - bytesReceived
      - createdAt
      - updatedAt
      - spaceId
      description: Any uploaded file of any type
      title: File
    type_files:ListFilesResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_files:File'
      required:
      - data
      title: ListFilesResponse
    type_files:FileResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_files:File'
      required:
      - data
      title: FileResponse
    type_files:HeaderDetectionAlgorithm:
      type: string
      enum:
      - aiDetection
      - default
      - explicitHeaders
      - specificRows
      - dataRowAndSubHeaderDetection
      title: HeaderDetectionAlgorithm
    type_files:HeaderDetectionOptions:
      type: object
      properties:
        algorithm:
          $ref: '#/components/schemas/type_files:HeaderDetectionAlgorithm'
        rowsToSearch:
          type: integer
        skip:
          type: integer
        headers:
          type: array
          items:
            type: string
        rowNumbers:
          type: array
          items:
            type: integer
      required:
      - algorithm
      title: HeaderDetectionOptions
    type_files:HeaderDetectionResult:
      type: object
      properties:
        header:
          type: array
          items:
            type: string
        headerRow:
          type: integer
        letters:
          type: array
          items:
            type: string
      required:
      - header
      - headerRow
      - letters
      title: HeaderDetectionResult
    type_files:DetectHeaderResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_files:HeaderDetectionResult'
      required:
      - data
      title: DetectHeaderResponse
    type_flags:CreateFlagRequest:
      type: object
      properties:
        slug:
          type: string
          description: The unique identifier for the flag
        label:
          type: string
          description: The human-readable name for the flag
        colorHex:
          type: string
          description: The hex color code for the flag (e.g., "#0090FF")
      required:
      - slug
      - label
      - colorHex
      description: Request to create a new flag
      title: CreateFlagRequest
    type_flags:FlagResponse:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the flag
        slug:
          type: string
          description: The flag slug
        label:
          type: string
          description: The flag label
        colorHex:
          type: string
          description: The hex color code for the flag
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The workbook this flag belongs to
        createdAt:
          type: string
          format: date-time
          description: When the flag was created
        updatedAt:
          type: string
          format: date-time
          description: When the flag was last updated
      required:
      - id
      - slug
      - label
      - colorHex
      - workbookId
      - createdAt
      - updatedAt
      description: A flag object
      title: FlagResponse
    type_flags:UpdateFlagRequest:
      type: object
      properties:
        label:
          type: string
          description: The new label for the flag
        colorHex:
          type: string
          description: The new hex color code for the flag
        newSlug:
          type: string
          description: The new slug for the flag
      description: Request to update an existing flag
      title: UpdateFlagRequest
    type_flags:FlagOperation:
      type: string
      enum:
      - apply
      - update
      - delete
      - replace
      description: The type of flag operation to perform
      title: FlagOperation
    type_flags:FlagMutationData:
      type: object
      properties:
        label:
          type: string
          description: The flag label
        colorHex:
          type: string
          description: The flag color in hex format
      description: Flag data for mutation operations
      title: FlagMutationData
    type_flags:BulkMutateFlagsRequest:
      type: object
      properties:
        operation:
          $ref: '#/components/schemas/type_flags:FlagOperation'
          description: The operation to perform
        slug:
          type: string
          description: The flag slug to operate on
        flag:
          $ref: '#/components/schemas/type_flags:FlagMutationData'
          description: Flag data for apply/update operations
        exceptions:
          type: array
          items:
            type: string
          description: Record IDs to exclude from the operation
        query:
          type: string
          description: Query string to filter records
        filter:
          description: Filter object to apply to records
        filterField:
          type: string
          description: Field to filter on
        searchValue:
          type: string
          description: Value to search for
        searchField:
          type: string
          description: Field to search in
        q:
          type: string
          description: General search query
        ids:
          type: array
          items:
            type: string
          description: Specific record IDs to target
        snapshotLabel:
          type: string
          description: Label for snapshot before mutation
      required:
      - operation
      - slug
      description: Request to perform bulk flag operations
      title: BulkMutateFlagsRequest
    type_flags:BulkMutateFlagsResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the operation was successfully queued
        jobId:
          type: string
          description: The ID of the job handling the bulk mutation
      required:
      - success
      - jobId
      description: Response from bulk flag mutation
      title: BulkMutateFlagsResponse
    type_guests:GuestWorkbook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      required:
      - id
      title: GuestWorkbook
    type_guests:GuestSheet:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:SheetId'
      required:
      - id
      title: GuestSheet
    type_guests:GuestSpace:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:SpaceId'
        workbooks:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:GuestWorkbook'
        sheets:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:GuestSheet'
        lastAccessed:
          type: string
          format: date-time
      required:
      - id
      title: GuestSpace
    type_guests:Guest:
      type: object
      properties:
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        email:
          type: string
        name:
          type: string
        spaces:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:GuestSpace'
        id:
          $ref: '#/components/schemas/type_commons:GuestId'
        createdAt:
          type: string
          format: date-time
          description: Date the guest object was created
        updatedAt:
          type: string
          format: date-time
          description: Date the guest object was last updated
      required:
      - environmentId
      - email
      - name
      - spaces
      - id
      - createdAt
      - updatedAt
      title: Guest
    type_guests:ListGuestsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:Guest'
      required:
      - data
      title: ListGuestsResponse
    type_guests:GuestConfig:
      type: object
      properties:
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        email:
          type: string
        name:
          type: string
        spaces:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:GuestSpace'
      required:
      - environmentId
      - email
      - name
      - spaces
      description: Configurations for the guests
      title: GuestConfig
    type_guests:CreateGuestResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:Guest'
      required:
      - data
      title: CreateGuestResponse
    type_guests:GuestResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_guests:Guest'
      required:
      - data
      title: GuestResponse
    type_guests:GuestConfigUpdate:
      type: object
      properties:
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        email:
          type: string
        name:
          type: string
        spaces:
          type: array
          items:
            $ref: '#/components/schemas/type_guests:GuestSpace'
      description: Properties used to update an existing guest
      title: GuestConfigUpdate
    type_guests:GuestToken:
      type: object
      properties:
        token:
          type: string
          description: The token used to authenticate the guest
        valid:
          type: boolean
      required:
      - token
      - valid
      title: GuestToken
    type_guests:GuestTokenResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_guests:GuestToken'
      required:
      - data
      title: GuestTokenResponse
    type_guests:Invite:
      type: object
      properties:
        guestId:
          $ref: '#/components/schemas/type_commons:GuestId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        fromName:
          type: string
          description: The name of the person or company sending the invitation
        message:
          type: string
          description: Message to send with the invite
      required:
      - guestId
      - spaceId
      title: Invite
    type_commons:SortDirection:
      type: string
      enum:
      - asc
      - desc
      description: Sort direction - asc (ascending) or desc (descending)
      title: SortDirection
    type_jobs:JobType:
      type: string
      enum:
      - file
      - workbook
      - sheet
      - space
      - document
      - app
      - agent
      - autobuild
      - onboarding
      description: The type of job
      title: JobType
    type_jobs:JobSource:
      type: string
      description: The id of a file, workbook, sheet, or app
      title: JobSource
    type_jobs:JobDestination:
      $ref: '#/components/schemas/type_commons:WorkbookId'
      description: The id of the workbook where extracted file data will be sent
      title: JobDestination
    type_commons:Filter:
      type: string
      enum:
      - valid
      - error
      - all
      - none
      description: Options to filter records
      title: Filter
    type_commons:FilterField:
      type: string
      description: Use this to narrow the valid/error filter results to a specific
        field
      title: FilterField
    type_commons:SearchValue:
      type: string
      description: Search for the given value, returning matching rows. For exact
        matches, wrap the value in double quotes ("Bob"). To search for null values,
        send empty double quotes ("")
      title: SearchValue
    type_commons:SearchField:
      type: string
      description: Use this to narrow the searchValue results to a specific field
      title: SearchField
    type_jobs:DeleteRecordsJobConfig:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/type_commons:Filter'
          description: Options to filter records (default=none)
        filterField:
          $ref: '#/components/schemas/type_commons:FilterField'
          description: Use this to narrow the valid/error filter results to a specific
            field (Requires filter to be set)
        searchValue:
          $ref: '#/components/schemas/type_commons:SearchValue'
        searchField:
          $ref: '#/components/schemas/type_commons:SearchField'
        q:
          type: string
          description: FFQL query to filter records
        sheet:
          $ref: '#/components/schemas/type_commons:SheetId'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:RecordId'
          description: List of record ids to exclude from deletion
        snapshotLabel:
          type: string
          description: If specified, a snapshot will be generated with this label
      required:
      - sheet
      description: The configuration for a delete job
      title: DeleteRecordsJobConfig
    type_jobs:Driver:
      type: string
      enum:
      - csv
      description: The driver to use for extracting data from the file
      title: Driver
    type_jobs:FileJobConfig:
      type: object
      properties:
        driver:
          $ref: '#/components/schemas/type_jobs:Driver'
          description: The driver to use for extracting data from the file
        options:
          type: object
          additionalProperties:
            description: Any type
          description: The options to use for extracting data from the file
        detectedHeaderRow:
          type: integer
          description: The row number of the header row detected at extraction time
      required:
      - driver
      title: FileJobConfig
    type_commons:RunbookId:
      type: string
      description: Runbook ID
      title: RunbookId
    type_jobs:PipelineJobConfig:
      type: object
      properties:
        sourceSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        destinationSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        runbookId:
          $ref: '#/components/schemas/type_commons:RunbookId'
      required:
      - sourceSheetId
      - destinationSheetId
      title: PipelineJobConfig
    type_commons:SortField:
      type: string
      description: Name of field by which to sort records
      title: SortField
    type_jobs:ExportOptions:
      type: object
      properties:
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
          description: If provided, the snapshot version of the workbook will be used
            for the export
        sortField:
          $ref: '#/components/schemas/type_commons:SortField'
          description: The field to sort the records on
        sortDirection:
          $ref: '#/components/schemas/type_commons:SortDirection'
          description: The direction to sort the records
        filter:
          $ref: '#/components/schemas/type_commons:Filter'
          description: The filter to apply to the records
        filterField:
          $ref: '#/components/schemas/type_commons:FilterField'
          description: The field to filter on
        searchValue:
          $ref: '#/components/schemas/type_commons:SearchValue'
          description: The value to search for
        searchField:
          $ref: '#/components/schemas/type_commons:SearchField'
          description: The field to search for the search value in
        q:
          type: string
          description: The FFQL query to filter records
        ids:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:RecordId'
          description: The Record Ids param (ids) is a list of record ids that can
            be passed to several record endpoints allowing the user to identify specific
            records to INCLUDE in the query, or specific records to EXCLUDE, depending
            on whether or not filters are being applied. When passing a query param
            that filters the record dataset, such as 'searchValue', or a 'filter'
            of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records
            from the filtered results. For basic queries that do not filter the dataset,
            passing record ids in the 'ids' param will limit the dataset to INCLUDE
            just those specific records
      title: ExportOptions
    type_jobs:ExportJobConfig:
      type: object
      properties:
        options:
          $ref: '#/components/schemas/type_jobs:ExportOptions'
      required:
      - options
      title: ExportJobConfig
    type_jobs:MutateJobConfig:
      type: object
      properties:
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        mutateRecord:
          type: string
          description: A JavaScript function that will be run on each record in the
            sheet, it should return a mutated record.
        mutationId:
          type: string
          description: If the mutation was generated through some sort of id-ed process,
            this links this job and that process.
        snapshotLabel:
          type: string
          description: If specified, a snapshot will be generated with this label
        snapshotId:
          type: string
          description: The generated snapshotId will be stored here
        filter:
          $ref: '#/components/schemas/type_commons:Filter'
        filterField:
          $ref: '#/components/schemas/type_commons:FilterField'
        searchValue:
          $ref: '#/components/schemas/type_commons:SearchValue'
        searchField:
          $ref: '#/components/schemas/type_commons:SearchField'
        q:
          type: string
        ids:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:RecordId'
          description: The Record Ids param (ids) is a list of record ids that can
            be passed to several record endpoints allowing the user to identify specific
            records to INCLUDE in the query, or specific records to EXCLUDE, depending
            on whether or not filters are being applied. When passing a query param
            that filters the record dataset, such as 'searchValue', or a 'filter'
            of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records
            from the filtered results. For basic queries that do not filter the dataset,
            passing record ids in the 'ids' param will limit the dataset to INCLUDE
            just those specific records
      required:
      - sheetId
      - mutateRecord
      title: MutateJobConfig
    type_jobs:FindAndReplaceJobConfig:
      type: object
      properties:
        filter:
          $ref: '#/components/schemas/type_commons:Filter'
          description: The filter to apply to the records
        filterField:
          $ref: '#/components/schemas/type_commons:FilterField'
          description: The field to filter on
        searchValue:
          $ref: '#/components/schemas/type_commons:SearchValue'
          description: The value to search for
        searchField:
          $ref: '#/components/schemas/type_commons:SearchField'
          description: The field to search for the search value in
        q:
          type: string
          description: The FFQL query to filter records
        ids:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:RecordId'
          description: The Record Ids param (ids) is a list of record ids that can
            be passed to several record endpoints allowing the user to identify specific
            records to INCLUDE in the query, or specific records to EXCLUDE, depending
            on whether or not filters are being applied. When passing a query param
            that filters the record dataset, such as 'searchValue', or a 'filter'
            of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records
            from the filtered results. For basic queries that do not filter the dataset,
            passing record ids in the 'ids' param will limit the dataset to INCLUDE
            just those specific records
        find:
          $ref: '#/components/schemas/type_records:CellValueUnion'
          description: A value to find for a given field in a sheet. Wrap the value
            in "" for exact match
        replace:
          $ref: '#/components/schemas/type_records:CellValueUnion'
          description: The value to replace found values with
        fieldKey:
          type: string
          description: A unique key used to identify a field in a sheet
        snapshotLabel:
          type: string
          description: If specified, a snapshot will be generated with this label
      required:
      - fieldKey
      title: FindAndReplaceJobConfig
    type_jobs:MappingProgramJobConfig:
      type: object
      properties:
        sourceSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        destinationSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        mappingRules:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
        canRecompute:
          type: boolean
      required:
      - sourceSheetId
      - destinationSheetId
      - mappingRules
      title: MappingProgramJobConfig
    type_jobs:AiGenerateBlueprintJobConfig:
      type: object
      properties:
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
      required:
      - spaceId
      - appId
      title: AiGenerateBlueprintJobConfig
    type_jobs:AiGenerateSampleDataJobConfig:
      type: object
      properties:
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
      required:
      - spaceId
      - appId
      title: AiGenerateSampleDataJobConfig
    type_jobs:AiGenerateBlueprintConstraintsJobConfig:
      type: object
      properties:
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
      required:
      - spaceId
      - workbookId
      title: AiGenerateBlueprintConstraintsJobConfig
    type_property:StoredConstraint:
      type: object
      properties:
        validator:
          type: string
          description: Must match the constraint validator name.
        version:
          type: integer
          description: The version of the stored constraint to use. (Defaults to version
            1.)
        description:
          type: string
          description: A full description of what this constraint configuration does
        label:
          type: string
          description: A short description of what this constraint constraint should
            do, example - values between 1 and 100
        config:
          description: Any type
      required:
      - validator
      title: StoredConstraint
    type_jobs:AiGenerateConstraintJobConfig:
      type: object
      properties:
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_property:StoredConstraint'
        description:
          type: string
          description: A description of what the constraint to be generated should
            do
      required:
      - spaceId
      - constraints
      title: AiGenerateConstraintJobConfig
    type_jobs:AiRuleCreationJobConfig:
      type: object
      properties:
        label:
          type: string
          description: Display name for the rule to be created
        prompt:
          type: string
          description: The natural language description of the rule to be created
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the sheet containing the field to create/update the
            rule for
        fieldKey:
          type: string
          description: The key of the field to create/update the rule for
        index:
          type: integer
          description: To edit an existing rule, provide the index of the constraint
            in the constraints array for the field and that constraint will be replaced.
      required:
      - prompt
      - sheetId
      - fieldKey
      description: Configuration for AI-powered rule creation jobs that generate or
        replace field constraints
      title: AiRuleCreationJobConfig
    type_jobs:CaptureRoutineJobConfig:
      type: object
      properties:
        sourceJobId:
          $ref: '#/components/schemas/type_commons:JobId'
        runbookId:
          $ref: '#/components/schemas/type_commons:RunbookId'
      required:
      - sourceJobId
      - runbookId
      title: CaptureRoutineJobConfig
    type_jobs:RunRunbookJobConfig:
      type: object
      properties:
        sourceSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        runbookId:
          $ref: '#/components/schemas/type_commons:RunbookId'
      required:
      - sourceSheetId
      - runbookId
      title: RunRunbookJobConfig
    type_jobs:MappingFromPreprocessingJobConfig:
      type: object
      properties:
        proposal:
          description: Any type
        mappingJobId:
          $ref: '#/components/schemas/type_commons:JobId'
      required:
      - proposal
      - mappingJobId
      title: MappingFromPreprocessingJobConfig
    type_jobs:EmptyObject:
      type: object
      properties: {}
      title: EmptyObject
    type_jobs:AddRecordsToDataClipJobConfig:
      type: object
      properties:
        dataClipId:
          $ref: '#/components/schemas/type_commons:DataClipId'
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
      required:
      - dataClipId
      - sheetId
      description: The configuration for an add records to DataClip job
      title: AddRecordsToDataClipJobConfig
    type_jobs:UpdateDataClipResolutionsJobConfig:
      type: object
      properties:
        clipId:
          $ref: '#/components/schemas/type_commons:DataClipId'
          description: The ID of the data clip to resolve
        clippedSheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the sheet that contains the data clip
        resolveTo:
          $ref: '#/components/schemas/type_data-clips:ResolveTo'
        removedFromMainResolution:
          $ref: '#/components/schemas/type_data-clips:RemovedFromMainResolution'
        columnField:
          type: string
          description: Optional. If provided, only this column will be resolved.
        columnValue:
          type: string
          description: Optional. If provided, this value in the column will be replaced
            with the resolution target.
      required:
      - clipId
      - clippedSheetId
      - resolveTo
      - removedFromMainResolution
      - columnField
      - columnValue
      description: Configuration for a data clip resolution job
      title: UpdateDataClipResolutionsJobConfig
    type_jobs:AgentExportJobConfig:
      type: object
      properties:
        exportType:
          $ref: '#/components/schemas/type_agent-exports:AgentExportType'
      required:
      - exportType
      description: The configuration for an agent export job
      title: AgentExportJobConfig
    type_jobs:AgentPromotionJobConfig:
      type: object
      properties:
        targetEnvironmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: The environment ID where the agent should be promoted
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The space ID where the agent is being promoted from
      required:
      - targetEnvironmentId
      - spaceId
      description: The configuration for an agent promotion job
      title: AgentPromotionJobConfig
    type_jobs:CompanyResearchJobConfig:
      type: object
      properties:
        onboardingId:
          type: string
          description: The onboarding id
        url:
          type: string
          description: The url of the company to research
        companyName:
          type: string
          description: The name of the company to research
      required:
      - onboardingId
      description: The configuration for a company research job
      title: CompanyResearchJobConfig
    type_jobs:ConfigureDemoJobConfig:
      type: object
      properties:
        companyName:
          type: string
          description: The name of the company
      required:
      - companyName
      description: The configuration for an onboarding job
      title: ConfigureDemoJobConfig
    type_jobs:FlagMutationConfigData:
      type: object
      properties:
        slug:
          type: string
          description: The flag slug
        label:
          type: string
          description: The flag label
        colorHex:
          type: string
          description: The flag color in hex format
      required:
      - slug
      description: Flag data for mutation operations
      title: FlagMutationConfigData
    type_jobs:FlagMutationConfig:
      type: object
      properties:
        type:
          type: string
          enum:
          - flag
          description: The type of mutation (always "flag")
        operation:
          $ref: '#/components/schemas/type_flags:FlagOperation'
          description: The operation to perform
        flag:
          $ref: '#/components/schemas/type_jobs:FlagMutationConfigData'
          description: The flag data for the operation
        flags:
          type: array
          items:
            type: string
          description: Array of flag slugs for delete operation
      required:
      - type
      - operation
      - flag
      description: Configuration for flag mutation operations
      title: FlagMutationConfig
    type_jobs:BulkMutateFlagsJobConfig:
      type: object
      properties:
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The workbook to perform flag mutations on
        exceptions:
          type: array
          items:
            type: string
          description: Record IDs to exclude from the operation
        query:
          type: string
          description: Query string to filter records
        filter:
          description: Filter object to apply to records
        filterField:
          type: string
          description: Field to filter on
        searchValue:
          type: string
          description: Value to search for
        searchField:
          type: string
          description: Field to search in
        q:
          type: string
          description: General search query
        ids:
          type: array
          items:
            type: string
          description: Specific record IDs to target
        snapshotLabel:
          type: string
          description: Label for snapshot before mutation
        mutation:
          $ref: '#/components/schemas/type_jobs:FlagMutationConfig'
          description: The flag mutation configuration
      required:
      - workbookId
      - mutation
      description: The configuration for a bulk flag mutation job
      title: BulkMutateFlagsJobConfig
    type_jobs:JobUpdateConfig:
      oneOf:
      - $ref: '#/components/schemas/type_jobs:DeleteRecordsJobConfig'
      - $ref: '#/components/schemas/type_jobs:FileJobConfig'
      - $ref: '#/components/schemas/type_jobs:PipelineJobConfig'
      - $ref: '#/components/schemas/type_jobs:ExportJobConfig'
      - $ref: '#/components/schemas/type_jobs:MutateJobConfig'
      - $ref: '#/components/schemas/type_jobs:FindAndReplaceJobConfig'
      - $ref: '#/components/schemas/type_jobs:MappingProgramJobConfig'
      - $ref: '#/components/schemas/type_jobs:AiGenerateBlueprintJobConfig'
      - $ref: '#/components/schemas/type_jobs:AiGenerateSampleDataJobConfig'
      - $ref: '#/components/schemas/type_jobs:AiGenerateBlueprintConstraintsJobConfig'
      - $ref: '#/components/schemas/type_jobs:AiGenerateConstraintJobConfig'
      - $ref: '#/components/schemas/type_jobs:AiRuleCreationJobConfig'
      - $ref: '#/components/schemas/type_jobs:CaptureRoutineJobConfig'
      - $ref: '#/components/schemas/type_jobs:RunRunbookJobConfig'
      - $ref: '#/components/schemas/type_jobs:MappingFromPreprocessingJobConfig'
      - $ref: '#/components/schemas/type_jobs:EmptyObject'
      - $ref: '#/components/schemas/type_jobs:AddRecordsToDataClipJobConfig'
      - $ref: '#/components/schemas/type_jobs:UpdateDataClipResolutionsJobConfig'
      - $ref: '#/components/schemas/type_jobs:AgentExportJobConfig'
      - $ref: '#/components/schemas/type_jobs:AgentPromotionJobConfig'
      - $ref: '#/components/schemas/type_jobs:CompanyResearchJobConfig'
      - $ref: '#/components/schemas/type_jobs:ConfigureDemoJobConfig'
      - $ref: '#/components/schemas/type_jobs:BulkMutateFlagsJobConfig'
      title: JobUpdateConfig
    type_jobs:Trigger:
      type: string
      enum:
      - manual
      - immediate
      description: The type of trigger to use for this job
      title: Trigger
    type_jobs:JobStatus:
      type: string
      enum:
      - created
      - planning
      - scheduled
      - ready
      - executing
      - complete
      - failed
      - canceled
      - waiting
      description: the status of the job
      title: JobStatus
    type_jobs:JobMode:
      type: string
      enum:
      - foreground
      - background
      - toolbarBlocking
      - hidden
      description: the mode of the job
      title: JobMode
    type_jobs:JobSubject:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - resource
            description: 'Discriminator value: resource'
          id:
            type: string
        required:
        - type
        - id
      - type: object
        properties:
          type:
            type: string
            enum:
            - collection
            description: 'Discriminator value: collection'
          resource:
            type: string
          params:
            type: object
            additionalProperties:
              description: Any type
          query:
            type: object
            additionalProperties:
              description: Any type
        required:
        - type
        - resource
      discriminator:
        propertyName: type
      description: Subject parameters for this job type
      title: JobSubject
    type_jobs:JobPartExecution:
      type: string
      enum:
      - sequential
      - parallel
      title: JobPartExecution
    type_commons:ActorId:
      type: string
      description: Actor ID
      title: ActorId
    type_jobs:Job:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_jobs:JobType'
          description: The type of job
        operation:
          type: string
          description: the type of operation to perform on the data. For example,
            "export".
        source:
          $ref: '#/components/schemas/type_jobs:JobSource'
        destination:
          $ref: '#/components/schemas/type_jobs:JobDestination'
        config:
          $ref: '#/components/schemas/type_jobs:JobUpdateConfig'
        trigger:
          $ref: '#/components/schemas/type_jobs:Trigger'
          description: the type of trigger to use for this job
        status:
          $ref: '#/components/schemas/type_jobs:JobStatus'
          description: the status of the job
        progress:
          type: integer
          description: the progress of the job. Whole number between 0 and 100
        fileId:
          $ref: '#/components/schemas/type_commons:FileId'
        mode:
          $ref: '#/components/schemas/type_jobs:JobMode'
          description: the mode of the job
        input:
          type: object
          additionalProperties:
            description: Any type
          description: Input parameters for this job type.
        subject:
          $ref: '#/components/schemas/type_jobs:JobSubject'
          description: Subject parameters for this job type.
        outcome:
          type: object
          additionalProperties:
            description: Any type
          description: Outcome summary of job.
        result:
          type: object
          additionalProperties:
            description: Any type
          description: Information computed during job execution can be stored here
        info:
          type: string
          description: Current status of job in text
        managed:
          type: boolean
          description: Indicates if Flatfile is managing the control flow of this
            job or if it is being manually tracked.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: The id of the environment this job belongs to
        part:
          type: integer
          description: The part number of this job
        partData:
          type: object
          additionalProperties:
            description: Any type
          description: The data for this part of the job
        partExecution:
          $ref: '#/components/schemas/type_jobs:JobPartExecution'
          description: The execution mode for this part of the job
        parentId:
          $ref: '#/components/schemas/type_commons:JobId'
          description: The id of the parent job
        predecessorIds:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:JobId'
          description: The ids of the jobs that must complete before this job can
            start
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Additional metadata for the job
        id:
          $ref: '#/components/schemas/type_commons:JobId'
        createdBy:
          $ref: '#/components/schemas/type_commons:ActorId'
          description: The user, guest, or agent who created the job
        createdAt:
          type: string
          format: date-time
          description: Date the item was created
        updatedAt:
          type: string
          format: date-time
          description: Date the item was last updated
        startedAt:
          type: string
          format: date-time
          description: the time that the job started at
        finishedAt:
          type: string
          format: date-time
          description: the time that the job finished at
        outcomeAcknowledgedAt:
          type: string
          format: date-time
          description: the time that the job's outcome has been acknowledged by a
            user
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The id of the space this job belongs to
      required:
      - type
      - operation
      - source
      - id
      - createdBy
      - createdAt
      - updatedAt
      description: A single unit of work that will execute asynchronously
      title: Job
    type_jobs:ListJobsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:Job'
      required:
      - data
      title: ListJobsResponse
    type_jobs:JobConfig:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_jobs:JobType'
          description: The type of job
        operation:
          type: string
          description: the type of operation to perform on the data. For example,
            "export".
        source:
          $ref: '#/components/schemas/type_jobs:JobSource'
        destination:
          $ref: '#/components/schemas/type_jobs:JobDestination'
        config:
          $ref: '#/components/schemas/type_jobs:JobUpdateConfig'
        trigger:
          $ref: '#/components/schemas/type_jobs:Trigger'
          description: the type of trigger to use for this job
        status:
          $ref: '#/components/schemas/type_jobs:JobStatus'
          description: the status of the job
        progress:
          type: integer
          description: the progress of the job. Whole number between 0 and 100
        fileId:
          $ref: '#/components/schemas/type_commons:FileId'
        mode:
          $ref: '#/components/schemas/type_jobs:JobMode'
          description: the mode of the job
        input:
          type: object
          additionalProperties:
            description: Any type
          description: Input parameters for this job type.
        subject:
          $ref: '#/components/schemas/type_jobs:JobSubject'
          description: Subject parameters for this job type.
        outcome:
          type: object
          additionalProperties:
            description: Any type
          description: Outcome summary of job.
        result:
          type: object
          additionalProperties:
            description: Any type
          description: Information computed during job execution can be stored here
        info:
          type: string
          description: Current status of job in text
        managed:
          type: boolean
          description: Indicates if Flatfile is managing the control flow of this
            job or if it is being manually tracked.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: The id of the environment this job belongs to
        part:
          type: integer
          description: The part number of this job
        partData:
          type: object
          additionalProperties:
            description: Any type
          description: The data for this part of the job
        partExecution:
          $ref: '#/components/schemas/type_jobs:JobPartExecution'
          description: The execution mode for this part of the job
        parentId:
          $ref: '#/components/schemas/type_commons:JobId'
          description: The id of the parent job
        predecessorIds:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:JobId'
          description: The ids of the jobs that must complete before this job can
            start
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Additional metadata for the job
      required:
      - type
      - operation
      - source
      description: A single unit of work that a pipeline will execute
      title: JobConfig
    type_jobs:JobResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_jobs:Job'
      required:
      - data
      title: JobResponse
    type_jobs:JobUpdate:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/type_jobs:JobUpdateConfig'
        status:
          $ref: '#/components/schemas/type_jobs:JobStatus'
          description: the status of the job
        progress:
          type: integer
          description: the progress of the job. Whole number between 0 and 100
        outcomeAcknowledgedAt:
          type: string
          format: date-time
          description: the time that the job's outcome has been acknowledged by a
            user
        info:
          type: string
          description: Current status of job in text
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Additional metadata for the job
      description: A single unit of work that will be executed
      title: JobUpdate
    type_property:RequiredConstraintConfig:
      type: object
      properties:
        message:
          type: string
          description: Custom validation message to display when the constraint fails
        level:
          $ref: '#/components/schemas/type_records:ValidationType'
          description: Validation level (error, warn, info). Defaults to error.
      title: RequiredConstraintConfig
    type_property:UniqueConstraintConfig:
      type: object
      properties:
        caseSensitive:
          type: boolean
          description: Ignore casing when determining uniqueness
        ignoreEmpty:
          type: boolean
          description: Do not flag empty values as duplicate
        message:
          type: string
          description: Custom validation message to display when the constraint fails
        level:
          $ref: '#/components/schemas/type_records:ValidationType'
          description: Validation level (error, warn, info). Defaults to error.
      title: UniqueConstraintConfig
    type_property:Constraint:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - required
            description: 'Discriminator value: required'
          config:
            $ref: '#/components/schemas/type_property:RequiredConstraintConfig'
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - unique
            description: 'Discriminator value: unique'
          config:
            $ref: '#/components/schemas/type_property:UniqueConstraintConfig'
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - computed
            description: 'Discriminator value: computed'
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - external
            description: 'Discriminator value: external'
          validator:
            type: string
          description:
            type: string
            description: A full description of what this constraint configuration
              does
          label:
            type: string
            description: A short description of what this constraint constraint should
              do, example - values between 1 and 100
          config:
            description: Any type
        required:
        - type
        - validator
      - type: object
        properties:
          type:
            type: string
            enum:
            - stored
            description: 'Discriminator value: stored'
          validator:
            type: string
            description: Must match the constraint validator name.
          version:
            type: integer
            description: The version of the stored constraint to use. (Defaults to
              version 1.)
          description:
            type: string
            description: A full description of what this constraint configuration
              does
          label:
            type: string
            description: A short description of what this constraint constraint should
              do, example - values between 1 and 100
          config:
            description: Any type
        required:
        - type
        - validator
      discriminator:
        propertyName: type
      title: Constraint
    type_property:FieldSize:
      type: string
      enum:
      - xs
      - s
      - m
      - l
      - xl
      description: The default visual sizing. This sizing may be overridden by a user
      title: FieldSize
    type_property:FieldAppearance:
      type: object
      properties:
        size:
          $ref: '#/components/schemas/type_property:FieldSize'
      description: Control the appearance of this field when it's displayed in a table
        or input
      title: FieldAppearance
    type_property:StringConfigOptions:
      type: string
      enum:
      - tiny
      - normal
      - medium
      - long
      description: How much text should be storeable in this field
      title: StringConfigOptions
    type_property:StringConfig:
      type: object
      properties:
        size:
          $ref: '#/components/schemas/type_property:StringConfigOptions'
      required:
      - size
      title: StringConfig
    type_property:NumberConfig:
      type: object
      properties:
        decimalPlaces:
          type: integer
          description: Number of decimal places to round data to
      title: NumberConfig
    type_property:BooleanPropertyConfig:
      type: object
      properties:
        allowIndeterminate:
          type: boolean
          description: Allow a neither true or false state to be stored as `null`
      required:
      - allowIndeterminate
      title: BooleanPropertyConfig
    type_property:EnumPropertyOption:
      type: object
      properties:
        label:
          type: string
          description: A visual label for this option
        description:
          type: string
          description: A short description for this option
        color:
          type: string
          description: An optional color to assign this option
        icon:
          type: string
          description: A reference pointer to a previously registered icon
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: An arbitrary JSON object to be associated with this option
            and made available to hooks
        value:
          description: The value or ID of this option. This value will be sent in
            egress. The type is a string | integer | boolean.
        alternativeNames:
          type: array
          items:
            type: string
          description: Alternative names to match this enum option to
        ordinal:
          type: integer
          description: The order of this option in the list. SortBy must be set to
            `ordinal` to use this.
      required:
      - value
      title: EnumPropertyOption
    type_property:EnumPropertySortBy:
      type: string
      enum:
      - label
      - value
      - ordinal
      title: EnumPropertySortBy
    type_property:EnumPropertyConfig:
      type: object
      properties:
        allowCustom:
          type: boolean
          description: Permit the user to create new options for this specific field.
        options:
          type: array
          items:
            $ref: '#/components/schemas/type_property:EnumPropertyOption'
        sortBy:
          $ref: '#/components/schemas/type_property:EnumPropertySortBy'
          description: Sort the options by the value of this property. Defaults to
            `label`.
      required:
      - options
      title: EnumPropertyConfig
    type_property:ReferenceFilter:
      type: object
      properties:
        refField:
          type: string
          description: The field key of the reference sheet to filter with
        recordField:
          type: string
          description: The field key of the record used to filter the reference field
      required:
      - refField
      - recordField
      description: If provided, the reference filter will narrow the set of records
        in the reference sheet used as the set of valid values for the record. Only
        rows where the value in the reference sheet's refField matches the value in
        this record's recordField will be used.
      title: ReferenceFilter
    type_property:ReferencePropertyRelationship:
      type: string
      enum:
      - has-one
      - has-many
      title: ReferencePropertyRelationship
    type_property:ReferencePropertyConfig:
      type: object
      properties:
        ref:
          type: string
          description: Full path reference to a sheet configuration. Must be in the
            same workbook.
        key:
          type: string
          description: Key of the property to use as the reference key. Defaults to
            `id`
        filter:
          $ref: '#/components/schemas/type_property:ReferenceFilter'
          description: Optional filter to narrow the set of records in the reference
            sheet used as valid values
        relationship:
          $ref: '#/components/schemas/type_property:ReferencePropertyRelationship'
          description: The type of relationship this defines
      required:
      - ref
      - key
      title: ReferencePropertyConfig
    type_property:ReferenceListPropertyConfig:
      type: object
      properties:
        ref:
          type: string
          description: Full path reference to a sheet configuration. Must be in the
            same workbook.
        key:
          type: string
          description: Key of the property to use as the reference key. Defaults to
            `id`
        filter:
          $ref: '#/components/schemas/type_property:ReferenceFilter'
          description: Optional filter to narrow the set of records in the reference
            sheet used as valid values
      required:
      - ref
      - key
      title: ReferenceListPropertyConfig
    type_property:Property:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - string
            description: 'Discriminator value: string'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          config:
            $ref: '#/components/schemas/type_property:StringConfig'
        required:
        - type
        - key
      - type: object
        properties:
          type:
            type: string
            enum:
            - number
            description: 'Discriminator value: number'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          isArray:
            type: boolean
            description: Will allow multiple values and store as an array. Use enum-list
              type instead.
          config:
            $ref: '#/components/schemas/type_property:NumberConfig'
        required:
        - type
        - key
      - type: object
        properties:
          type:
            type: string
            enum:
            - boolean
            description: 'Discriminator value: boolean'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          config:
            $ref: '#/components/schemas/type_property:BooleanPropertyConfig'
        required:
        - type
        - key
      - type: object
        properties:
          type:
            type: string
            enum:
            - date
            description: 'Discriminator value: date'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
        required:
        - type
        - key
      - type: object
        properties:
          type:
            type: string
            enum:
            - enum
            description: 'Discriminator value: enum'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          isArray:
            type: boolean
            description: Will allow multiple values and store as an array. Use enum-list
              type instead.
          multi:
            type: boolean
            description: Will allow multiple values and store / provide the values
              in an array if set. Not all field types support arrays. Use enum-list
              type instead.
          config:
            $ref: '#/components/schemas/type_property:EnumPropertyConfig'
        required:
        - type
        - key
        - config
      - type: object
        properties:
          type:
            type: string
            enum:
            - reference
            description: 'Discriminator value: reference'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          isArray:
            type: boolean
            description: Will allow multiple values and store as an array. Use enum-list
              type instead.
          config:
            $ref: '#/components/schemas/type_property:ReferencePropertyConfig'
        required:
        - type
        - key
        - config
      - type: object
        properties:
          type:
            type: string
            enum:
            - reference-list
            description: 'Discriminator value: reference-list'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          isArray:
            type: boolean
            description: Will allow multiple values and store as an array. Use enum-list
              type instead.
          config:
            $ref: '#/components/schemas/type_property:ReferenceListPropertyConfig'
        required:
        - type
        - key
        - config
      - type: object
        properties:
          type:
            type: string
            enum:
            - string-list
            description: 'Discriminator value: string-list'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
        required:
        - type
        - key
      - type: object
        properties:
          type:
            type: string
            enum:
            - enum-list
            description: 'Discriminator value: enum-list'
          key:
            type: string
          label:
            type: string
            description: User friendly field name
          description:
            type: string
            description: A short description of the field. Markdown syntax is supported.
          constraints:
            type: array
            items:
              $ref: '#/components/schemas/type_property:Constraint'
            description: A list of constraints that should be applied to this field.
              This is limited to a maximum of 10 constraints and all external and
              stored constraints must have unique validator values.
          readonly:
            type: boolean
          appearance:
            $ref: '#/components/schemas/type_property:FieldAppearance'
          actions:
            type: array
            items:
              $ref: '#/components/schemas/type_commons:Action'
            description: An array of actions that end users can perform on this Column.
          metadata:
            description: Useful for any contextual metadata regarding the schema.
              Store any valid json here.
          treatments:
            type: array
            items:
              type: string
            description: A unique presentation for a field in the UI.
          alternativeNames:
            type: array
            items:
              type: string
          config:
            $ref: '#/components/schemas/type_property:EnumPropertyConfig'
        required:
        - type
        - key
        - config
      discriminator:
        propertyName: type
      title: Property
    type_jobs:EnumValue:
      oneOf:
      - type: string
      - type: integer
      - type: boolean
      title: EnumValue
    type_jobs:CategoryMapping:
      type: object
      properties:
        sourceValue:
          $ref: '#/components/schemas/type_jobs:EnumValue'
          description: The source value to map from
        destinationValue:
          $ref: '#/components/schemas/type_jobs:EnumValue'
          description: The destination value to map to
      title: CategoryMapping
    type_jobs:EnumDetails:
      type: object
      properties:
        mapping:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:CategoryMapping'
          description: The mapping of source values to destination values
        unusedSourceValues:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:EnumValue'
          description: A list of source values that are not mapped from
        unusedDestinationValues:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:EnumValue'
          description: A list of destination values that are not mapped to
      required:
      - mapping
      description: Only available if one or more of the destination fields is of type
        enum. Provides category mapping.
      title: EnumDetails
    type_jobs:Certainty:
      type: string
      enum:
      - absolute
      - strong
      - moderate
      - weak
      title: Certainty
    type_jobs:Metadata:
      type: object
      properties:
        certainty:
          $ref: '#/components/schemas/type_jobs:Certainty'
        confidence:
          type: number
          format: double
        source:
          type: string
        detectedDelimiter:
          type: string
      title: Metadata
    type_jobs:Edge:
      type: object
      properties:
        sourceField:
          $ref: '#/components/schemas/type_property:Property'
          description: The description of the source field
        destinationField:
          $ref: '#/components/schemas/type_property:Property'
          description: The description of the destination field
        preview:
          type: array
          items:
            type: string
          description: A list of preview values of the data in the destination field
        enumDetails:
          $ref: '#/components/schemas/type_jobs:EnumDetails'
          description: Only available if one or more of the destination fields is
            of type enum. Provides category mapping.
        metadata:
          $ref: '#/components/schemas/type_jobs:Metadata'
          description: Metadata about the edge
      required:
      - sourceField
      - destinationField
      title: Edge
    type_jobs:SourceField:
      type: object
      properties:
        sourceField:
          $ref: '#/components/schemas/type_property:Property'
          description: The description of the source field
        preview:
          type: array
          items:
            type: string
          description: A list of preview values of the data in the source field
      required:
      - sourceField
      title: SourceField
    type_jobs:DestinationField:
      type: object
      properties:
        destinationField:
          $ref: '#/components/schemas/type_property:Property'
          description: The description of the destination field
        preview:
          type: array
          items:
            type: string
          description: A list of preview values of the data in the destination field
      required:
      - destinationField
      title: DestinationField
    type_jobs:JobExecutionPlan:
      type: object
      properties:
        fieldMapping:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:Edge'
        unmappedSourceFields:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:SourceField'
        unmappedDestinationFields:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:DestinationField'
        programId:
          type: string
      required:
      - fieldMapping
      - unmappedSourceFields
      - unmappedDestinationFields
      description: The execution plan for a job, for example, for a map job, the execution
        plan is the mapping of the source sheet to the destination sheet.
      title: JobExecutionPlan
    type_jobs:JobPlan:
      type: object
      properties:
        job:
          $ref: '#/components/schemas/type_jobs:Job'
        plan:
          $ref: '#/components/schemas/type_jobs:JobExecutionPlan'
      required:
      - job
      - plan
      description: The job/plan tuple that contains the full plan and the jobs status
      title: JobPlan
    type_jobs:JobPlanResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_jobs:JobPlan'
      required:
      - data
      title: JobPlanResponse
    type_jobs:JobExecutionPlanRequest:
      type: object
      properties:
        fieldMapping:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:Edge'
        unmappedSourceFields:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:SourceField'
        unmappedDestinationFields:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:DestinationField'
        programId:
          type: string
        fileId:
          $ref: '#/components/schemas/type_commons:FileId'
        jobId:
          $ref: '#/components/schemas/type_commons:JobId'
      required:
      - fieldMapping
      - unmappedSourceFields
      - unmappedDestinationFields
      - fileId
      - jobId
      title: JobExecutionPlanRequest
    type_jobs:JobExecutionPlanConfigRequest:
      type: object
      properties:
        fieldMapping:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:Edge'
        unmappedSourceFields:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:SourceField'
        unmappedDestinationFields:
          type: array
          items:
            $ref: '#/components/schemas/type_jobs:DestinationField'
        programId:
          type: string
        fileId:
          $ref: '#/components/schemas/type_commons:FileId'
        jobId:
          $ref: '#/components/schemas/type_commons:JobId'
      required:
      - fileId
      - jobId
      title: JobExecutionPlanConfigRequest
    type_jobs:JobAckDetails:
      type: object
      properties:
        info:
          type: string
        progress:
          type: integer
          description: the progress of the job. Whole number between 0 and 100
        estimatedCompletionAt:
          type: string
          format: date-time
      description: Details about the user who acknowledged the job
      title: JobAckDetails
    type_jobs:JobOutcomeTriggerType:
      type: string
      enum:
      - manual
      - automatic
      - automatic_silent
      description: Whether a job outcome's effect should be triggered automatically
      title: JobOutcomeTriggerType
    type_jobs:JobOutcomeTriggerAudience:
      type: string
      enum:
      - originator
      - all
      description: For whom the job outcome's next effect should be triggered automatically
      title: JobOutcomeTriggerAudience
    type_jobs:JobOutcomeTriggerDetails:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/type_jobs:JobOutcomeTriggerType'
        audience:
          $ref: '#/components/schemas/type_jobs:JobOutcomeTriggerAudience'
      required:
      - type
      description: Details about the trigger for the job outcome
      title: JobOutcomeTriggerDetails
    type_jobs:JobOutcomeTrigger:
      oneOf:
      - $ref: '#/components/schemas/type_jobs:JobOutcomeTriggerType'
      - $ref: '#/components/schemas/type_jobs:JobOutcomeTriggerDetails'
      title: JobOutcomeTrigger
    type_jobs:JobOutcomeNextFileObject:
      type: object
      properties:
        fileId:
          type: string
        label:
          type: string
      required:
      - fileId
      title: JobOutcomeNextFileObject
    type_jobs:JobOutcomeNext:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - id
            description: 'Discriminator value: id'
          id:
            type: string
          label:
            type: string
          path:
            type: string
          query:
            type: string
        required:
        - type
        - id
      - type: object
        properties:
          type:
            type: string
            enum:
            - url
            description: 'Discriminator value: url'
          url:
            type: string
          label:
            type: string
          replace:
            type: boolean
            description: Whether to replace the current tab or iframe when navigating
              to the url. Defaults to false.
        required:
        - type
        - url
      - type: object
        properties:
          type:
            type: string
            enum:
            - download
            description: 'Discriminator value: download'
          url:
            type: string
          label:
            type: string
          fileName:
            type: string
        required:
        - type
        - url
      - type: object
        properties:
          type:
            type: string
            enum:
            - files
            description: 'Discriminator value: files'
          files:
            type: array
            items:
              $ref: '#/components/schemas/type_jobs:JobOutcomeNextFileObject'
          label:
            type: string
        required:
        - type
        - files
      - type: object
        properties:
          type:
            type: string
            enum:
            - wait
            description: 'Discriminator value: wait'
          fade:
            type: boolean
          confetti:
            type: boolean
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - snapshot
            description: 'Discriminator value: snapshot'
          snapshotId:
            type: string
          sheetId:
            type: string
        required:
        - type
        - snapshotId
        - sheetId
      - type: object
        properties:
          type:
            type: string
            enum:
            - retry
            description: 'Discriminator value: retry'
          label:
            type: string
        required:
        - type
      - type: object
        properties:
          type:
            type: string
            enum:
            - view
            description: 'Discriminator value: view'
          sheetId:
            type: string
          hiddenColumns:
            type: array
            items:
              type: string
            description: An array of field keys from the sheet
          label:
            type: string
        required:
        - type
        - sheetId
        - hiddenColumns
      - type: object
        properties:
          type:
            type: string
            enum:
            - clearFilters
            description: 'Discriminator value: clearFilters'
          label:
            type: string
          sheetIds:
            type: array
            items:
              type: string
        required:
        - type
      discriminator:
        propertyName: type
      title: JobOutcomeNext
    type_jobs:JobOutcome:
      type: object
      properties:
        acknowledge:
          type: boolean
        trigger:
          $ref: '#/components/schemas/type_jobs:JobOutcomeTrigger'
        buttonText:
          type: string
        next:
          $ref: '#/components/schemas/type_jobs:JobOutcomeNext'
        heading:
          type: string
        message:
          type: string
        hideDefaultButton:
          type: boolean
      description: Outcome summary of a job
      title: JobOutcome
    type_jobs:JobCompleteDetails:
      type: object
      properties:
        outcome:
          $ref: '#/components/schemas/type_jobs:JobOutcome'
        info:
          type: string
      description: Outcome summary of a job
      title: JobCompleteDetails
    type_jobs:JobCancelDetails:
      type: object
      properties:
        info:
          type: string
      description: Info about the reason the job was canceled
      title: JobCancelDetails
    type_jobs:JobPartsArray:
      type: array
      items:
        type: object
        additionalProperties:
          description: Any type
      description: Data for each of the job parts
      title: JobPartsArray
    type_jobs:JobParts:
      oneOf:
      - type: integer
      - $ref: '#/components/schemas/type_jobs:JobPartsArray'
      description: Info about the number of parts to create
      title: JobParts
    type_jobs:JobSplitDetails:
      type: object
      properties:
        parts:
          $ref: '#/components/schemas/type_jobs:JobParts'
        runInParallel:
          type: boolean
      required:
      - parts
      description: Info about the reason the job was split
      title: JobSplitDetails
    type_sheets:SheetAccess:
      type: string
      enum:
      - '*'
      - add
      - edit
      - delete
      - import
      title: SheetAccess
    type_sheets:CompositeUniqueConstraintStrategy:
      type: string
      enum:
      - hash
      - concat
      title: CompositeUniqueConstraintStrategy
    type_sheets:CompositeUniqueConstraintConfig:
      type: object
      properties:
        message:
          type: string
          description: Custom validation message to display when the constraint fails
        level:
          $ref: '#/components/schemas/type_records:ValidationType'
          description: Validation level (error, warn, info). Defaults to error.
      title: CompositeUniqueConstraintConfig
    type_sheets:SheetConstraint:
      oneOf:
      - type: object
        properties:
          type:
            type: string
            enum:
            - unique
            description: 'Discriminator value: unique'
          name:
            type: string
            description: The name of the constraint
          fields:
            type: array
            items:
              type: string
            description: The fields that must be unique together
          requiredFields:
            type: array
            items:
              type: string
            description: Fields that, when empty, will cause this unique constraint
              to be ignored
          strategy:
            $ref: '#/components/schemas/type_sheets:CompositeUniqueConstraintStrategy'
          config:
            $ref: '#/components/schemas/type_sheets:CompositeUniqueConstraintConfig'
            description: Configuration options for the composite unique constraint
        required:
        - type
        - name
        - fields
        - strategy
      - type: object
        properties:
          type:
            type: string
            enum:
            - external
            description: 'Discriminator value: external'
          validator:
            type: string
          fields:
            type: array
            items:
              type: string
            description: The fields that must be unique together
          config:
            description: Any type
        required:
        - type
        - validator
      discriminator:
        propertyName: type
      title: SheetConstraint
    type_sheets:SheetTreatments:
      type: string
      enum:
      - CLIPPED_FROM_SHEET
      - ENUM_REFERENCE
      title: SheetTreatments
    type_sheets:SheetConfig:
      type: object
      properties:
        name:
          type: string
          description: The name of your Sheet as it will appear to your end users.
        description:
          type: string
          description: A sentence or two describing the purpose of your Sheet.
        slug:
          type: string
          description: A unique identifier for your Sheet.
        readonly:
          type: boolean
          description: A boolean specifying whether or not this sheet is read only.
            Read only sheets are not editable by end users.
        allowAdditionalFields:
          type: boolean
          description: Allow end users to add fields during mapping.
        mappingConfidenceThreshold:
          type: number
          format: double
          description: The minimum confidence required to automatically map a field
        access:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetAccess'
          description: Control Sheet-level access for all users.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_property:Property'
          description: Where you define your Sheet's data schema.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
          description: An array of actions that end users can perform on this Sheet.
        metadata:
          description: Useful for any contextual metadata regarding the schema. Store
            any valid json
        constraints:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetConstraint'
          description: An array of constraints that end users can perform on this
            Sheet.
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetTreatments'
          description: An array of treatments that define the behavior of the sheet.
        collection:
          type: string
          description: Collection in which to group the sheet
      required:
      - name
      - fields
      description: Describes shape of data as well as behavior
      title: SheetConfig
    type_commons:FamilyId:
      type: string
      description: Mapping Family ID
      title: FamilyId
    type_mapping:MappingRuleConfig:
      type: object
      properties:
        name:
          type: string
          description: Name of the mapping rule
        type:
          type: string
        config:
          description: Any type
        acceptedAt:
          type: string
          format: date-time
          description: Time the mapping rule was last updated
        acceptedBy:
          $ref: '#/components/schemas/type_commons:ActorId'
          description: User ID of the contributor of the mapping rule
        metadata:
          description: Metadata of the mapping rule
      required:
      - name
      - type
      title: MappingRuleConfig
    type_mapping:ProgramConfig:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/type_sheets:SheetConfig'
          description: Source schema
        destination:
          $ref: '#/components/schemas/type_sheets:SheetConfig'
          description: Destination schema
        familyId:
          $ref: '#/components/schemas/type_commons:FamilyId'
          description: ID of the family to add the program to
        namespace:
          type: string
          description: Namespace of the program
        save:
          type: boolean
          description: Whether to save the program for editing later. Defaults to
            false. If true, the response will contain an ID and access token.
        rules:
          type: array
          items:
            $ref: '#/components/schemas/type_mapping:MappingRuleConfig'
          description: Mapping rules to use for the program. If present, the program
            will be created with these rules.
      required:
      - source
      - destination
      title: ProgramConfig
    type_commons:MappingId:
      type: string
      description: Mapping Rule ID
      title: MappingId
    type_mapping:MappingRuleOrConfig:
      type: object
      properties:
        name:
          type: string
          description: Name of the mapping rule
        type:
          type: string
        config:
          description: Any type
        acceptedAt:
          type: string
          format: date-time
          description: Time the mapping rule was last updated
        acceptedBy:
          $ref: '#/components/schemas/type_commons:ActorId'
          description: User ID of the contributor of the mapping rule
        metadata:
          description: Metadata of the mapping rule
        id:
          $ref: '#/components/schemas/type_commons:MappingId'
          description: ID of the mapping rule
        confidence:
          type: integer
          description: Confidence of the mapping rule
        createdBy:
          $ref: '#/components/schemas/type_commons:UserId'
          description: User ID of the creator of the mapping rule
        createdAt:
          type: string
          format: date-time
          description: Time the mapping rule was created
        updatedAt:
          type: string
          format: date-time
          description: Time the mapping rule was last updated
        deletedAt:
          type: string
          format: date-time
          description: Time the mapping rule was deleted
      required:
      - name
      - type
      title: MappingRuleOrConfig
    type_mapping:ProgramSummary:
      type: object
      properties:
        totalRuleCount:
          type: integer
          description: Total number of mapping rules
        addedRuleCount:
          type: integer
          description: Number of mapping rules added
        deletedRuleCount:
          type: integer
          description: Number of mapping rules deleted
      required:
      - totalRuleCount
      - addedRuleCount
      - deletedRuleCount
      title: ProgramSummary
    type_mapping:Program:
      type: object
      properties:
        rules:
          type: array
          items:
            $ref: '#/components/schemas/type_mapping:MappingRuleOrConfig'
          description: Mapping rules
        id:
          type: string
          description: If this program was saved, this is the ID of the program
        namespace:
          type: string
          description: Namespace of the program
        familyId:
          $ref: '#/components/schemas/type_commons:FamilyId'
          description: Family ID of the program, if it belongs to a family
        createdAt:
          type: string
          format: date-time
          description: If this program was saved, this is the time it was created
        createdBy:
          $ref: '#/components/schemas/type_commons:UserId'
          description: If this program was saved, this is the user ID of the creator
        sourceKeys:
          type: array
          items:
            type: string
          description: Source keys
        destinationKeys:
          type: array
          items:
            type: string
          description: Destination keys
        summary:
          $ref: '#/components/schemas/type_mapping:ProgramSummary'
          description: Summary of the mapping rules
        accessToken:
          type: string
          description: If this program was saved, this token allows you to modify
            the program
        acceptedAt:
          type: string
          format: date-time
          description: If this program was accepted, this is the time it was accepted
        acceptedBy:
          $ref: '#/components/schemas/type_commons:ActorId'
          description: If this program was accepted, this is the user ID of the user
            who accepted it
      required:
      - rules
      - sourceKeys
      - destinationKeys
      title: Program
    type_mapping:ProgramResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_mapping:Program'
      required:
      - data
      title: ProgramResponse
    type_mapping:ProgramsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_mapping:Program'
      required:
      - data
      title: ProgramsResponse
    type_mapping:CreateMappingRulesRequest:
      type: array
      items:
        $ref: '#/components/schemas/type_mapping:MappingRuleConfig'
      title: CreateMappingRulesRequest
    type_mapping:MappingRule:
      type: object
      properties:
        name:
          type: string
          description: Name of the mapping rule
        type:
          type: string
        config:
          description: Any type
        acceptedAt:
          type: string
          format: date-time
          description: Time the mapping rule was last updated
        acceptedBy:
          $ref: '#/components/schemas/type_commons:ActorId'
          description: User ID of the contributor of the mapping rule
        metadata:
          description: Metadata of the mapping rule
        id:
          $ref: '#/components/schemas/type_commons:MappingId'
          description: ID of the mapping rule
        confidence:
          type: integer
          description: Confidence of the mapping rule
        createdBy:
          $ref: '#/components/schemas/type_commons:UserId'
          description: User ID of the user who suggested the mapping rule
        createdAt:
          type: string
          format: date-time
          description: Time the mapping rule was created
        updatedAt:
          type: string
          format: date-time
          description: Time the mapping rule was last updated
        deletedAt:
          type: string
          format: date-time
          description: Time the mapping rule was deleted
      required:
      - name
      - type
      - id
      - createdAt
      - updatedAt
      title: MappingRule
    type_mapping:MappingRulesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_mapping:MappingRule'
      required:
      - data
      title: MappingRulesResponse
    type_mapping:MappingRuleResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_mapping:MappingRule'
      required:
      - data
      title: MappingRuleResponse
    type_mapping:UpdateMappingRulesRequest:
      type: array
      items:
        $ref: '#/components/schemas/type_mapping:MappingRule'
      title: UpdateMappingRulesRequest
    type_records:GetRecordsResponseData:
      type: object
      properties:
        success:
          type: boolean
        records:
          $ref: '#/components/schemas/type_records:RecordsWithLinks'
        counts:
          $ref: '#/components/schemas/type_records:RecordCounts'
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
      required:
      - success
      - records
      description: A list of records with optional record counts
      title: GetRecordsResponseData
    type_records:GetRecordsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_records:GetRecordsResponseData'
      required:
      - data
      title: GetRecordsResponse
    type_records:RecordIndices:
      type: object
      properties:
        id:
          type: string
        index:
          type: integer
      required:
      - id
      - index
      description: A record index object
      title: RecordIndices
    type_records:GetRecordIndicesResponse:
      type: array
      items:
        $ref: '#/components/schemas/type_records:RecordIndices'
      title: GetRecordIndicesResponse
    type_versions:Version:
      type: object
      properties:
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
      required:
      - versionId
      title: Version
    type_versions:VersionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_versions:Version'
      required:
      - data
      title: VersionResponse
    type_records:RecordsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_records:RecordsResponseData'
      required:
      - data
      title: RecordsResponse
    type_roles:RoleResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:RoleId'
        name:
          type: string
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - name
      - accountId
      - createdAt
      - updatedAt
      title: RoleResponse
    type_roles:ListRolesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_roles:RoleResponse'
      required:
      - data
      title: ListRolesResponse
    type_commons:RoutineId:
      type: string
      description: Routine ID
      title: RoutineId
    type_routines:RoutineType:
      type: string
      enum:
      - JOB
      title: RoutineType
    type_routines:Routine:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:RoutineId'
          description: The ID of the Routine.
        runbookId:
          $ref: '#/components/schemas/type_commons:RunbookId'
        name:
          type: string
          description: The name of the Routine.
        config:
          description: Configuration for the Routine. Related to the type of Routine.
        ordinal:
          type: integer
          description: The order of the Routine in the Runbook.
        type:
          $ref: '#/components/schemas/type_routines:RoutineType'
          description: The type of Routine.
        createdBy:
          type: string
          description: The entity which created the Runbook.
        createdAt:
          type: string
          format: date-time
          description: Date the sheet was created
        updatedAt:
          type: string
          format: date-time
          description: Date the sheet was last updated
      required:
      - id
      - runbookId
      - name
      - config
      - ordinal
      - type
      - createdBy
      - createdAt
      - updatedAt
      description: Routine is a set of instructions or procedures that are followed
        to complete a task.
      title: Routine
    type_routines:RoutinesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_routines:Routine'
      required:
      - data
      title: RoutinesResponse
    type_routines:RoutineResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_routines:Routine'
      required:
      - data
      title: RoutineResponse
    type_routines:CreateRoutineRequest:
      type: object
      properties:
        runbookId:
          $ref: '#/components/schemas/type_commons:RunbookId'
        name:
          type: string
          description: The name of the Routine.
        config:
          description: Configuration for the Routine. Related to the type of Routine.
        ordinal:
          type: integer
          description: The order of the Routine in the Runbook.
        type:
          $ref: '#/components/schemas/type_routines:RoutineType'
          description: The type of Routine.
      required:
      - runbookId
      - name
      - config
      - ordinal
      - type
      title: CreateRoutineRequest
    type_routines:UpdateRoutineRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Routine.
        config:
          description: Configuration for the Routine. Related to the type of Routine.
        ordinal:
          type: integer
          description: The order of the Routine in the Runbook.
        type:
          $ref: '#/components/schemas/type_routines:RoutineType'
          description: The type of Routine.
      required:
      - name
      - config
      - ordinal
      - type
      title: UpdateRoutineRequest
    type_runbooks:SheetTransformConfig:
      type: object
      properties:
        sourceSheetIds:
          type: array
          items:
            type: string
          description: The ids of the sourceSheets to transform
        destinationSheetIds:
          type: array
          items:
            type: string
          description: The id of the destinationSheet to transform
      required:
      - sourceSheetIds
      - destinationSheetIds
      title: SheetTransformConfig
    type_runbooks:RunbookConfig:
      oneOf:
      - $ref: '#/components/schemas/type_runbooks:SheetTransformConfig'
      title: RunbookConfig
    type_runbooks:RunbookStatus:
      type: string
      enum:
      - CREATED
      - RECORDING
      - EXECUTING
      - WAITING
      - COMPLETED
      - FAILED
      - CANCELED
      title: RunbookStatus
    type_runbooks:RunbookType:
      type: string
      enum:
      - SHEET_TOOL
      - PREPROCESSING
      title: RunbookType
    type_runbooks:Runbook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:RunbookId'
          description: The ID of the Runbook.
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        name:
          type: string
          description: The name of the Runbook.
        config:
          $ref: '#/components/schemas/type_runbooks:RunbookConfig'
          description: The configuration of the Runbook.
        status:
          $ref: '#/components/schemas/type_runbooks:RunbookStatus'
          description: The status of the Runbook.
        type:
          $ref: '#/components/schemas/type_runbooks:RunbookType'
          description: The type of the Runbook.
        createdBy:
          type: string
          description: The entity which created the Runbook.
        createdAt:
          type: string
          format: date-time
          description: Date the sheet was created
        updatedAt:
          type: string
          format: date-time
          description: Date the sheet was last updated
      required:
      - id
      - accountId
      - appId
      - environmentId
      - spaceId
      - name
      - config
      - status
      - type
      - createdBy
      - createdAt
      - updatedAt
      description: Runbook
      title: Runbook
    type_runbooks:RunbooksResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_runbooks:Runbook'
      required:
      - data
      title: RunbooksResponse
    type_runbooks:RunbookResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_runbooks:Runbook'
      required:
      - data
      title: RunbookResponse
    type_runbooks:CreateRunbookRequest:
      type: object
      properties:
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        name:
          type: string
          description: The name of the Runbook.
        config:
          $ref: '#/components/schemas/type_runbooks:RunbookConfig'
          description: The configuration of the Runbook.
        status:
          $ref: '#/components/schemas/type_runbooks:RunbookStatus'
          description: The status of the Runbook.
        type:
          $ref: '#/components/schemas/type_runbooks:RunbookType'
          description: The type of the Runbook.
      required:
      - accountId
      - appId
      - environmentId
      - spaceId
      - name
      - config
      - status
      - type
      title: CreateRunbookRequest
    type_runbooks:UpdateRunbookRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Runbook.
        status:
          $ref: '#/components/schemas/type_runbooks:RunbookStatus'
          description: The status of the Runbook.
        config:
          $ref: '#/components/schemas/type_runbooks:RunbookConfig'
          description: The configuration of the Runbook.
      title: UpdateRunbookRequest
    type_secrets:SecretName:
      type: string
      description: The name of a secret. Minimum 1 character, maximum 1024
      title: SecretName
    type_secrets:SecretValue:
      type: string
      description: The value of a secret. Minimum 1 character, maximum 1024
      title: SecretValue
    type_commons:SecretId:
      type: string
      description: Secret ID
      title: SecretId
    type_secrets:Secret:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/type_secrets:SecretName'
          description: The reference name for a secret.
        value:
          $ref: '#/components/schemas/type_secrets:SecretValue'
          description: The secret value. This is hidden in the UI.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: The Environment of the secret.
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The Space of the secret.
        actorId:
          $ref: '#/components/schemas/type_commons:ActorIdUnion'
          description: The Actor of the secret.
        id:
          $ref: '#/components/schemas/type_commons:SecretId'
          description: The ID of the secret.
      required:
      - name
      - value
      - id
      description: The value of a secret
      title: Secret
    type_secrets:SecretsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_secrets:Secret'
      required:
      - data
      title: SecretsResponse
    type_secrets:WriteSecret:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/type_secrets:SecretName'
          description: The reference name for a secret.
        value:
          $ref: '#/components/schemas/type_secrets:SecretValue'
          description: The secret value. This is hidden in the UI.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: The Environment of the secret.
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The Space of the secret.
        actorId:
          $ref: '#/components/schemas/type_commons:ActorIdUnion'
          description: The Actor of the secret.
      required:
      - name
      - value
      description: The properties required to write to a secret. Value is the only
        mutable property. Name, environmentId, spaceId (optional) are used for finding
        the secret.
      title: WriteSecret
    type_sheets:Sheet:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the Sheet.
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The ID of the Workbook.
        name:
          type: string
          description: The name of the Sheet.
        slug:
          type: string
          description: The slug of the Sheet.
        config:
          $ref: '#/components/schemas/type_sheets:SheetConfig'
          description: Describes shape of data as well as behavior
        metadata:
          description: Useful for any contextual metadata regarding the sheet. Store
            any valid json
        namespace:
          type: string
          description: The scoped namespace of the Sheet.
        lockedBy:
          type: string
          description: The actor who locked the Sheet.
        updatedAt:
          type: string
          format: date-time
          description: Date the sheet was last updated
        createdAt:
          type: string
          format: date-time
          description: Date the sheet was created
        lockedAt:
          type: string
          format: date-time
          description: The time the Sheet was locked.
        recordCounts:
          $ref: '#/components/schemas/type_records:RecordCounts'
          description: The precomputed counts of records in the Sheet (may not exist).
        createdFrom:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The sheet id of the template that was used to create this sheet
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time the sheet template configuration was propagated
            to this sheet
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetTreatments'
          description: An array of treatments that define the behavior of the sheet.
        collection:
          type: string
          description: Collection in which to group the sheet
      required:
      - id
      - workbookId
      - name
      - slug
      - config
      - updatedAt
      - createdAt
      description: A place to store tabular data
      title: Sheet
    type_sheets:ListSheetsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:Sheet'
      required:
      - data
      title: ListSheetsResponse
    type_sheets:SheetResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_sheets:Sheet'
      required:
      - data
      title: SheetResponse
    type_sheets:RecordCountsResponseData:
      type: object
      properties:
        counts:
          $ref: '#/components/schemas/type_records:RecordCounts'
        success:
          type: boolean
      required:
      - counts
      - success
      title: RecordCountsResponseData
    type_sheets:RecordCountsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_sheets:RecordCountsResponseData'
      required:
      - data
      title: RecordCountsResponse
    type_commons:CalculationId:
      type: string
      description: Calculation ID
      title: CalculationId
    type_sheets:CalculationType:
      type: string
      enum:
      - COUNT_EMPTY
      - COUNT_NON_EMPTY
      - PERCENT_EMPTY
      - PERCENT_NON_EMPTY
      - COUNT_CHANGED
      - PERCENT_CHANGED
      - SUM
      - AVERAGE
      - MIN
      - MAX
      title: CalculationType
    type_sheets:Calculation:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:CalculationId'
          description: Unique identifier for the calculation
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: ID of the workbook this calculation belongs to
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: ID of the sheet this calculation belongs to
        fieldKey:
          type: string
          description: Field key this calculation is performed on
        type:
          $ref: '#/components/schemas/type_sheets:CalculationType'
          description: Type of calculation being performed
        value:
          type: number
          format: double
          description: Result of the calculation
      required:
      - id
      - workbookId
      - sheetId
      - fieldKey
      - type
      title: Calculation
    type_sheets:ListCalculationsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:Calculation'
      required:
      - data
      title: ListCalculationsResponse
    type_commits:ListCommitsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_commits:Commit'
      required:
      - data
      title: ListCommitsResponse
    type_sheets:FieldKey:
      type: string
      description: Returns results from the given field only. Otherwise all field
        cells are returned
      title: FieldKey
    type_sheets:Distinct:
      type: boolean
      description: When true, excludes duplicate values
      title: Distinct
    type_sheets:IncludeCounts:
      type: boolean
      description: When both distinct and includeCounts are true, the count of distinct
        field values will be returned
      title: IncludeCounts
    type_sheets:CellValueWithCounts:
      type: object
      properties:
        valid:
          type: boolean
        messages:
          type: array
          items:
            $ref: '#/components/schemas/type_records:ValidationMessage'
        metadata:
          type: object
          additionalProperties:
            description: Any type
          description: Deprecated, use record level metadata instead.
        value:
          $ref: '#/components/schemas/type_records:CellValueUnion'
        layer:
          type: string
        updatedAt:
          type: string
          format: date-time
        counts:
          $ref: '#/components/schemas/type_records:RecordCounts'
      title: CellValueWithCounts
    type_sheets:CellsResponseData:
      type: object
      additionalProperties:
        type: array
        items:
          $ref: '#/components/schemas/type_sheets:CellValueWithCounts'
      description: Cell values grouped by field key
      title: CellsResponseData
    type_sheets:CellsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_sheets:CellsResponseData'
      required:
      - data
      title: CellsResponse
    type_sheets:SheetUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the Sheet.
        slug:
          type: string
          description: The slug of the Sheet.
        metadata:
          description: Useful for any contextual metadata regarding the sheet. Store
            any valid json
      description: Changes to make to an existing sheet
      title: SheetUpdateRequest
    type_snapshots:SummarySection:
      type: object
      properties:
        total:
          type: integer
        byField:
          type: object
          additionalProperties:
            type: integer
      required:
      - total
      title: SummarySection
    type_snapshots:SchemaDiffEnum:
      type: string
      enum:
      - added
      - removed
      - unchanged
      title: SchemaDiffEnum
    type_snapshots:SchemaDiffData:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/type_snapshots:SchemaDiffEnum'
      title: SchemaDiffData
    type_snapshots:SchemaDiffRecord:
      $ref: '#/components/schemas/type_snapshots:SchemaDiffData'
      title: SchemaDiffRecord
    type_snapshots:SnapshotSummary:
      type: object
      properties:
        createdSince:
          $ref: '#/components/schemas/type_snapshots:SummarySection'
        updatedSince:
          $ref: '#/components/schemas/type_snapshots:SummarySection'
        deletedSince:
          $ref: '#/components/schemas/type_snapshots:SummarySection'
        schemaDiff:
          $ref: '#/components/schemas/type_snapshots:SchemaDiffRecord'
          description: The schema diff between the snapshot and the current sheet
            schema.
        config:
          $ref: '#/components/schemas/type_sheets:SheetConfig'
          description: The sheet configuration at the time of the snapshot.
      required:
      - createdSince
      - updatedSince
      - deletedSince
      - schemaDiff
      - config
      title: SnapshotSummary
    type_snapshots:Snapshot:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:SnapshotId'
          description: The ID of the Snapshot.
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the Sheet.
        label:
          type: string
          description: The title of the Snapshot.
        threadId:
          type: string
          description: The ID of the thread associated with the snapshot.
        summary:
          $ref: '#/components/schemas/type_snapshots:SnapshotSummary'
          description: A summary of the Snapshot. This field is only available on
            the single get snapshot endpoint. It is not available for the list snapshots
            endpoint.
        createdAt:
          type: string
          format: date-time
          description: The time the Snapshot was created.
        createdBy:
          $ref: '#/components/schemas/type_commons:UserId'
          description: The actor who created the Snapshot.
      required:
      - id
      - sheetId
      - createdAt
      - createdBy
      title: Snapshot
    type_snapshots:SnapshotResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_snapshots:Snapshot'
      required:
      - data
      title: SnapshotResponse
    type_snapshots:SnapshotsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_snapshots:Snapshot'
      required:
      - data
      title: SnapshotsResponse
    type_snapshots:RestoreOptions:
      type: object
      properties:
        created:
          type: boolean
        updated:
          type: boolean
        deleted:
          type: boolean
      required:
      - created
      - updated
      - deleted
      title: RestoreOptions
    type_snapshots:ChangeType:
      type: string
      enum:
      - createdSince
      - updatedSince
      - deletedSince
      description: Options to filter records in a snapshot
      title: ChangeType
    type_spaces:GetSpacesSortField:
      type: string
      enum:
      - name
      - workbooksCount
      - filesCount
      - environmentId
      - createdByUserName
      - createdAt
      - lastActivityAt
      title: GetSpacesSortField
    type_commons:SpaceConfigId:
      type: string
      description: Space Config ID
      title: SpaceConfigId
    type_spaces:SpaceSidebarConfig:
      type: object
      properties:
        workbookSidebarOrder:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:WorkbookId'
          description: Used to set the order of workbooks in the sidebar. This will
            not affect workbooks that are pinned and workbooks that are not specified
            here will be sorted alphabetically.
      title: SpaceSidebarConfig
    type_spaces:SpaceSettings:
      type: object
      properties:
        sidebarConfig:
          $ref: '#/components/schemas/type_spaces:SpaceSidebarConfig'
          description: The sidebar configuration for the space. (This will eventually
            replace metadata.sidebarconfig)
        filesMappedAfterJob:
          type: string
          description: The name of the job that needs to complete before navigating
            to file mapping
        extractionOptions:
          $ref: '#/components/schemas/type_files:HeaderDetectionOptions'
          description: The extraction options for CSV files.
        omitActions:
          type: array
          items:
            type: string
          description: List of action names to omit from the space interface (e.g.,
            'file.import', 'records.delete', 'records.download')
        omitRowSelectionToolbar:
          type: boolean
          description: Whether to hide the floating toolbar at the bottom that appears
            when rows are selected
      description: Settings for a space
      title: SpaceSettings
    type_spaces:SpaceAccess:
      type: string
      enum:
      - '*'
      - upload
      title: SpaceAccess
    type_spaces:SpaceSize:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
        numUsers:
          type: integer
        pdv:
          type: integer
        numFiles:
          type: integer
      required:
      - name
      - id
      - numUsers
      - pdv
      - numFiles
      description: The size of a space
      title: SpaceSize
    type_spaces:Space:
      type: object
      properties:
        spaceConfigId:
          $ref: '#/components/schemas/type_commons:SpaceConfigId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        primaryWorkbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The ID of the primary workbook for the space. This should not
            be included in create space requests.
        metadata:
          description: Metadata for the space
        settings:
          $ref: '#/components/schemas/type_spaces:SpaceSettings'
          description: The Space settings.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
        access:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceAccess'
        autoConfigure:
          type: boolean
          description: Only used during creation - will be ignored on update
        namespace:
          type: string
        labels:
          type: array
          items:
            type: string
        translationsPath:
          type: string
        languageOverride:
          type: string
        archivedAt:
          type: string
          format: date-time
          description: Date when space was archived
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
          description: The ID of the App that space is associated with
        isAppTemplate:
          type: boolean
          description: Whether the space is an app template. Only one space per app
            can be an app template.
        id:
          $ref: '#/components/schemas/type_commons:SpaceId'
        workbooksCount:
          type: integer
          description: Amount of workbooks in the space
        filesCount:
          type: integer
          description: Amount of files in the space
        createdByUserId:
          $ref: '#/components/schemas/type_commons:UserId'
        createdByUserName:
          type: string
          description: User name who created space
        createdAt:
          type: string
          format: date-time
          description: Date when space was created
        updatedAt:
          type: string
          format: date-time
          description: Date when space was updated
        expiredAt:
          type: string
          format: date-time
          description: Date when space was expired
        lastActivityAt:
          type: string
          format: date-time
          description: This date marks the most recent activity within the space,
            tracking actions to the second. Activities include creating or updating
            records in a sheet, uploading files, or modifying a workbook's configuration.
        guestLink:
          type: string
          description: Guest link to the space
        name:
          type: string
          description: The name of the space
        displayOrder:
          type: integer
          description: The display order
        accessToken:
          type: string
          description: Access token for the space
        isCollaborative:
          type: boolean
          description: Flag for collaborative (project) spaces
        size:
          $ref: '#/components/schemas/type_spaces:SpaceSize'
          description: Size information for the space
        upgradedAt:
          type: string
          format: date-time
          description: Date when the space was upgraded
        guestAuthentication:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuestAuthenticationEnum'
          description: Type of guest authentication
        createdFrom:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The space id of the template that was used to create this space
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time the space template configuration was propagated
            to this space
      required:
      - id
      - createdAt
      - updatedAt
      - name
      - guestAuthentication
      description: A place to store your workbooks
      title: Space
    type_spaces:ListSpacesResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:Space'
      required:
      - data
      description: List of Space objects
      title: ListSpacesResponse
    type_spaces:SpaceConfig:
      type: object
      properties:
        spaceConfigId:
          $ref: '#/components/schemas/type_commons:SpaceConfigId'
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
        primaryWorkbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The ID of the primary workbook for the space. This should not
            be included in create space requests.
        metadata:
          description: Metadata for the space
        settings:
          $ref: '#/components/schemas/type_spaces:SpaceSettings'
          description: The Space settings.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
        access:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceAccess'
        autoConfigure:
          type: boolean
          description: Only used during creation - will be ignored on update
        namespace:
          type: string
        labels:
          type: array
          items:
            type: string
        translationsPath:
          type: string
        languageOverride:
          type: string
        archivedAt:
          type: string
          format: date-time
          description: Date when space was archived
        appId:
          $ref: '#/components/schemas/type_commons:AppId'
          description: The ID of the App that space is associated with
        isAppTemplate:
          type: boolean
          description: Whether the space is an app template. Only one space per app
            can be an app template.
        name:
          type: string
          description: The name of the space
        displayOrder:
          type: integer
          description: The display order
        guestAuthentication:
          type: array
          items:
            $ref: '#/components/schemas/type_environments:GuestAuthenticationEnum'
      description: Properties used to create a new Space
      title: SpaceConfig
    type_spaces:SpaceResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_spaces:Space'
      required:
      - data
      title: SpaceResponse
    type_spaces:TriggerEnum:
      type: string
      enum:
      - first
      - hover
      - event
      - manual
      title: TriggerEnum
    type_spaces:TypeEnum:
      type: string
      enum:
      - sidebar
      - popout
      - tooltip
      title: TypeEnum
    type_spaces:RoleEnum:
      type: string
      enum:
      - admin
      - guest
      title: RoleEnum
    type_spaces:GuidanceOptions:
      type: object
      properties:
        target:
          type: string
        trigger:
          $ref: '#/components/schemas/type_spaces:TriggerEnum'
        type:
          $ref: '#/components/schemas/type_spaces:TypeEnum'
        role:
          $ref: '#/components/schemas/type_spaces:RoleEnum'
          description: The role for which this guidance should be displayed. If not
            specified, guidance will be shown to both admin and guest users.
      required:
      - target
      - trigger
      - type
      title: GuidanceOptions
    type_spaces:GuidanceApiCreateData:
      type: object
      properties:
        guideSlug:
          type: string
        options:
          $ref: '#/components/schemas/type_spaces:GuidanceOptions'
          description: Options for the guidance
      required:
      - guideSlug
      - options
      title: GuidanceApiCreateData
    type_commons:GuidanceId:
      type: string
      description: Guidance ID
      title: GuidanceId
    type_spaces:GuidanceResource:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:GuidanceId'
        guideSlug:
          type: string
        options:
          $ref: '#/components/schemas/type_spaces:GuidanceOptions'
        createdFrom:
          $ref: '#/components/schemas/type_commons:GuidanceId'
          description: The guidance id of the template that was used to create this
            guidance
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time the guidance template configuration was propagated
            to this guidance
      required:
      - id
      - guideSlug
      - options
      title: GuidanceResource
    type_spaces:GuidanceListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:GuidanceResource'
      required:
      - data
      title: GuidanceListResponse
    type_spaces:GuidanceApiUpdateData:
      type: object
      properties:
        options:
          $ref: '#/components/schemas/type_spaces:GuidanceOptions'
          description: Options for the guidance
      required:
      - options
      title: GuidanceApiUpdateData
    type_spaces:SpaceDraft:
      type: object
      properties:
        sourceSpaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        draftSpaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        mergedAt:
          type: string
          format: date-time
        deletedAt:
          type: string
          format: date-time
      required:
      - sourceSpaceId
      - draftSpaceId
      - createdAt
      - updatedAt
      title: SpaceDraft
    type_spaces:SpaceDraftResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_spaces:SpaceDraft'
      required:
      - data
      title: SpaceDraftResponse
    type_spaces:SpaceDraftListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraft'
      required:
      - data
      title: SpaceDraftListResponse
    type_spaces:JSONPatchOperationType:
      type: string
      enum:
      - add
      - remove
      - replace
      - move
      - copy
      - test
      title: JSONPatchOperationType
    type_spaces:JSONPatchOperation:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/type_spaces:JSONPatchOperationType'
        from:
          type: string
        path:
          type: string
        value:
          description: Any type
      required:
      - op
      title: JSONPatchOperation
    type_spaces:SpaceDraftMergeOperation:
      type: object
      properties:
        action:
          type: string
        id:
          type: string
        mergeId:
          type: string
        jsonPatch:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:JSONPatchOperation'
      required:
      - action
      title: SpaceDraftMergeOperation
    type_spaces:SpaceDraftMergeOperations:
      type: object
      properties:
        space:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
        workbook:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
        sheet:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
        guidance:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
        document:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
        action:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
        agent:
          type: array
          items:
            $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperation'
      required:
      - space
      - workbook
      - sheet
      - guidance
      - document
      - action
      - agent
      title: SpaceDraftMergeOperations
    type_spaces:SpaceDraftMergeOperationsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_spaces:SpaceDraftMergeOperations'
      required:
      - data
      title: SpaceDraftMergeOperationsResponse
    type_users:ListUsersSortField:
      type: string
      enum:
      - email
      - name
      - id
      - idp
      - idp_ref
      - created_at
      - updated_at
      - last_seen_at
      - dashboard
      title: ListUsersSortField
    type_users:User:
      type: object
      properties:
        email:
          type: string
        name:
          type: string
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        id:
          $ref: '#/components/schemas/type_commons:UserId'
        idp:
          type: string
        idpRef:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        lastSeenAt:
          type: string
          format: date-time
        dashboard:
          type: integer
      required:
      - email
      - name
      - accountId
      - id
      - idp
      - metadata
      - createdAt
      - updatedAt
      description: Configurations for the user
      title: User
    type_users:ListUsersResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_users:User'
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
      required:
      - data
      title: ListUsersResponse
    type_users:UserCreateAndInviteRequest:
      type: object
      properties:
        email:
          type: string
        name:
          type: string
        actorRoles:
          type: array
          items:
            $ref: '#/components/schemas/type_roles:AssignActorRoleRequest'
      required:
      - email
      - name
      - actorRoles
      description: Properties used to create a new user
      title: UserCreateAndInviteRequest
    type_users:UserWithRoles:
      type: object
      properties:
        email:
          type: string
        name:
          type: string
        accountId:
          $ref: '#/components/schemas/type_commons:AccountId'
        id:
          $ref: '#/components/schemas/type_commons:UserId'
        idp:
          type: string
        idpRef:
          type: string
        metadata:
          type: object
          additionalProperties:
            description: Any type
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        lastSeenAt:
          type: string
          format: date-time
        dashboard:
          type: integer
        actorRoles:
          type: array
          items:
            $ref: '#/components/schemas/type_roles:ActorRoleResponse'
      required:
      - email
      - name
      - accountId
      - id
      - idp
      - metadata
      - createdAt
      - updatedAt
      - actorRoles
      title: UserWithRoles
    type_users:UserWithRolesResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_users:UserWithRoles'
      required:
      - data
      title: UserWithRolesResponse
    type_users:UserResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_users:User'
      required:
      - data
      title: UserResponse
    type_commons:ViewId:
      type: string
      description: View ID
      title: ViewId
    type_views:ViewConfig:
      type: object
      properties:
        versionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `commitId` instead.
        commitId:
          $ref: '#/components/schemas/type_commons:CommitId'
        sinceVersionId:
          $ref: '#/components/schemas/type_commons:VersionId'
          description: Deprecated, use `sinceCommitId` instead.
        sinceCommitId:
          $ref: '#/components/schemas/type_commons:CommitId'
        sortField:
          $ref: '#/components/schemas/type_commons:SortField'
        sortDirection:
          $ref: '#/components/schemas/type_commons:SortDirection'
        filter:
          $ref: '#/components/schemas/type_commons:Filter'
        filterField:
          $ref: '#/components/schemas/type_commons:FilterField'
          description: Name of field by which to filter records
        searchValue:
          $ref: '#/components/schemas/type_commons:SearchValue'
        searchField:
          $ref: '#/components/schemas/type_commons:SearchField'
        ids:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:RecordId'
          description: The Record Ids param (ids) is a list of record ids that can
            be passed to several record endpoints allowing the user to identify specific
            records to INCLUDE in the query, or specific records to EXCLUDE, depending
            on whether or not filters are being applied. When passing a query param
            that filters the record dataset, such as 'searchValue', or a 'filter'
            of 'valid' | 'error' | 'all', the 'ids' param will EXCLUDE those records
            from the filtered results. For basic queries that do not filter the dataset,
            passing record ids in the 'ids' param will limit the dataset to INCLUDE
            just those specific records. Maximum of 100 allowed.
        pageSize:
          type: integer
          description: Number of records to return in a page (default 10,000)
        pageNumber:
          type: integer
          description: Based on pageSize, which page of records to return (Note -
            numbers start at 1)
        includeCounts:
          type: boolean
          description: '**DEPRECATED** Use GET /sheets/:sheetId/counts'
        includeLength:
          type: boolean
          description: The length of the record result set, returned as counts.total
        includeLinks:
          type: boolean
          description: If true, linked records will be included in the results. Defaults
            to false.
        includeMessages:
          type: boolean
          description: Include error messages, defaults to false.
        for:
          $ref: '#/components/schemas/type_commons:EventId'
          description: if "for" is provided, the query parameters will be pulled from
            the event payload
        q:
          type: string
          description: An FFQL query used to filter the result set
      description: The configuration of a view. Filters, sorting, and search query.
      title: ViewConfig
    type_views:View:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:ViewId'
          description: The ID of the view
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The associated sheet ID of the view
        name:
          type: string
          description: The name of the view
        config:
          $ref: '#/components/schemas/type_views:ViewConfig'
          description: The view filters of the view
        createdBy:
          type: string
          description: ID of the actor who created the view
      required:
      - id
      - sheetId
      - name
      - config
      - createdBy
      description: A view
      title: View
    type_views:ListViewsResponse:
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/type_commons:Pagination'
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_views:View'
      required:
      - data
      title: ListViewsResponse
    type_views:ViewCreate:
      type: object
      properties:
        sheetId:
          $ref: '#/components/schemas/type_commons:SheetId'
        name:
          type: string
        config:
          $ref: '#/components/schemas/type_views:ViewConfig'
      required:
      - sheetId
      - name
      - config
      title: ViewCreate
    type_views:ViewResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_views:View'
      required:
      - data
      title: ViewResponse
    type_views:ViewUpdate:
      type: object
      properties:
        name:
          type: string
        config:
          $ref: '#/components/schemas/type_views:ViewConfig'
      required:
      - config
      title: ViewUpdate
    type_workbooks:WorkbookConfigSettings:
      type: object
      properties:
        trackChanges:
          type: boolean
          description: Whether to track changes for this workbook. Defaults to false.
            Tracking changes on a workbook allows for disabling workbook and sheet
            actions while data in the workbook is still being processed. You must
            run a recordHook listener if you enable this feature.
        noMappingRedirect:
          type: boolean
          description: When noMappingRedirect is set to true, dragging a file into
            a sheet will not redirect to the mapping screen. Defaults to false.
        sheetSidebarOrder:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:SheetId'
          description: Used to set the order of sheets in the sidebar. Sheets that
            are not specified will be shown after those listed.
        autoRunAnalysis:
          type: boolean
          description: Whether to automatically run analysis on the workbook when
            the inlineTransform feature is enabled. Defaults to true.
      description: Settings for a workbook
      title: WorkbookConfigSettings
    type_workbooks:WorkbookTreatments:
      type: string
      enum:
      - EXTRACTED_FROM_SOURCE
      - SMALL_DATA
      description: Available treatments for a workbook
      title: WorkbookTreatments
    type_workbooks:StorageStrategy:
      type: string
      enum:
      - RAINBOW_TABLES
      - CELL_HISTORY
      - HYPERCUBE
      - QUICKSTORE
      - DUCKDB
      - FOREIGNDB
      - MEMCSV
      title: StorageStrategy
    type_workbooks:Workbook:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: ID of the Workbook.
        name:
          type: string
          description: Name of the Workbook.
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: Associated Space ID of the Workbook.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: Associated Environment ID of the Workbook.
        sheets:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:Sheet'
          description: A list of Sheets associated with the Workbook.
        labels:
          type: array
          items:
            type: string
          description: A list of labels for the Workbook.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
          description: A list of Actions associated with the Workbook.
        settings:
          $ref: '#/components/schemas/type_workbooks:WorkbookConfigSettings'
          description: The Workbook settings.
        metadata:
          description: Metadata for the workbook
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/type_workbooks:WorkbookTreatments'
          description: Treatments for the workbook
        namespace:
          type: string
        updatedAt:
          type: string
          format: date-time
          description: Date the workbook was last updated
        createdAt:
          type: string
          format: date-time
          description: Date the workbook was created
        expiredAt:
          type: string
          format: date-time
          description: Date the workbook was created
        storageType:
          type: string
          description: The storage type of the workbook
        storageStrategy:
          $ref: '#/components/schemas/type_workbooks:StorageStrategy'
          description: The storage strategy of the workbook
        createdFrom:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The workbook id of the template that was used to create this
            workbook
        lastPropagatedAt:
          type: string
          format: date-time
          description: The last time the workbook template configuration was propagated
            to this workbook
        folder:
          type: string
          description: The folder to group the workbook in
      required:
      - id
      - spaceId
      - environmentId
      - updatedAt
      - createdAt
      description: A collection of one or more sheets
      title: Workbook
    type_workbooks:ListWorkbooksResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/type_workbooks:Workbook'
      required:
      - data
      title: ListWorkbooksResponse
    type_workbooks:CreateWorkbookConfig:
      type: object
      properties:
        name:
          type: string
          description: The name of the Workbook.
        labels:
          type: array
          items:
            type: string
          description: An optional list of labels for the Workbook.
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: Space to associate with the Workbook.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: Environment to associate with the Workbook
        namespace:
          type: string
          description: Optional namespace to apply to the Workbook.
        sheets:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetConfig'
          description: Sheets to create on the Workbook.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
          description: Actions to create on the Workbook.
        settings:
          $ref: '#/components/schemas/type_workbooks:WorkbookConfigSettings'
          description: The Workbook settings.
        metadata:
          description: Metadata for the workbook
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/type_workbooks:WorkbookTreatments'
          description: Treatments for the workbook
        storageStrategy:
          $ref: '#/components/schemas/type_workbooks:StorageStrategy'
          description: Storage strategy for the workbook. Defaults to QUICKSTORE.
        folder:
          type: string
          description: The folder to group the workbook in
      required:
      - name
      description: Properties used to create a new Workbook
      title: CreateWorkbookConfig
    type_workbooks:WorkbookResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_workbooks:Workbook'
      required:
      - data
      title: WorkbookResponse
    type_sheets:SheetConfigOrUpdate:
      type: object
      properties:
        name:
          type: string
          description: The name of your Sheet as it will appear to your end users.
        description:
          type: string
          description: A sentence or two describing the purpose of your Sheet.
        slug:
          type: string
          description: A unique identifier for your Sheet. **Required when updating
            a Workbook.**
        readonly:
          type: boolean
          description: A boolean specifying whether or not this sheet is read only.
            Read only sheets are not editable by end users.
        allowAdditionalFields:
          type: boolean
          description: Allow end users to add fields during mapping.
        mappingConfidenceThreshold:
          type: number
          format: double
          description: The minimum confidence required to automatically map a field
        access:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetAccess'
          description: Control Sheet-level access for all users.
        fields:
          type: array
          items:
            $ref: '#/components/schemas/type_property:Property'
          description: Where you define your Sheet's data schema.
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
          description: An array of actions that end users can perform on this Sheet.
        treatments:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetTreatments'
          description: An array of treatments that define the behavior of the sheet.
        collection:
          type: string
          description: Collection in which to group the sheet
        id:
          $ref: '#/components/schemas/type_commons:SheetId'
          description: The ID of the Sheet.
        workbookId:
          $ref: '#/components/schemas/type_commons:WorkbookId'
          description: The ID of the Workbook.
        config:
          $ref: '#/components/schemas/type_sheets:SheetConfig'
          description: Describes shape of data as well as behavior.
        metadata:
          description: Useful for any contextual metadata regarding the sheet. Store
            any valid json
        namespace:
          type: string
          description: The scoped namespace of the Sheet.
        updatedAt:
          type: string
          format: date-time
          description: Date the sheet was last updated
        createdAt:
          type: string
          format: date-time
          description: Date the sheet was created
      title: SheetConfigOrUpdate
    type_workbooks:WorkbookUpdate:
      type: object
      properties:
        name:
          type: string
          description: The name of the Workbook.
        labels:
          type: array
          items:
            type: string
          description: An optional list of labels for the Workbook.
        spaceId:
          $ref: '#/components/schemas/type_commons:SpaceId'
          description: The Space Id associated with the Workbook.
        environmentId:
          $ref: '#/components/schemas/type_commons:EnvironmentId'
          description: The Environment Id associated with the Workbook.
        namespace:
          type: string
          description: The namespace of the Workbook.
        sheets:
          type: array
          items:
            $ref: '#/components/schemas/type_sheets:SheetConfigOrUpdate'
          description: Describes shape of data as well as behavior
        actions:
          type: array
          items:
            $ref: '#/components/schemas/type_commons:Action'
        metadata:
          description: Metadata for the workbook
        settings:
          $ref: '#/components/schemas/type_workbooks:WorkbookConfigSettings'
          description: The Workbook settings.
        folder:
          type: string
          description: The folder to group the workbook in
      description: The updates to be made to an existing workbook
      title: WorkbookUpdate
  securitySchemes:
    default:
      type: http
      scheme: bearer