Fax for Agents Sandbox API

openapi: 3.2.0
info:
  title: Faxforagents Sandbox API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged sandbox across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: Sandbox
paths:
  /v1/sandbox/scenarios:
    get:
      tags:
      - Sandbox
      summary: The scenario catalog and active fixtures
      operationId: list_sandbox_scenarios
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxScenarios'
    post:
      tags:
      - Sandbox
      summary: Select the outcome of the next sends
      operationId: create_sandbox_scenario
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxScenarioCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxFixture'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/sandbox/inbound-faxes:
    post:
      tags:
      - Sandbox
      summary: Create a synthetic inbound fax (the same pipeline as a real one)
      description: 'A synthetic PDF goes through ``inbox.service.receive_now``: the private document, the inbox item,

        the ``fax.received`` event with its download reference, exactly as a carrier delivery (M8).'
      operationId: create_sandbox_inbound_fax
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SandboxInboundCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faxforagents__api__schemas__InboxItem'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/sandbox/data:
    delete:
      tags:
      - Sandbox
      summary: Reset this organization's test data
      operationId: reset_sandbox_data
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxReset'
components:
  schemas:
    faxforagents__api__schemas__InboxItem:
      properties:
        id:
          type: string
          title: Id
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        to:
          type: string
          title: To
        pages:
          type: integer
          title: Pages
        status:
          type: string
          title: Status
        document_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Document Id
        received_at:
          type: string
          title: Received At
        amount_micro:
          type: integer
          title: Amount Micro
          default: 0
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
      additionalProperties: true
      type: object
      required:
      - id
      - to
      - pages
      - status
      - document_id
      - received_at
      title: InboxItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    SandboxFixture:
      properties:
        id:
          type: string
          title: Id
        scenario:
          type: string
          title: Scenario
        destination:
          anyOf:
          - type: string
          - type: 'null'
          title: Destination
        created_at:
          type: string
          title: Created At
        expires_at:
          type: string
          title: Expires At
      additionalProperties: true
      type: object
      required:
      - id
      - scenario
      - destination
      - created_at
      - expires_at
      title: SandboxFixture
    SandboxReset:
      properties:
        reset:
          type: boolean
          title: Reset
        deleted:
          additionalProperties:
            type: integer
          type: object
          title: Deleted
        wallet_available_micro:
          type: integer
          title: Wallet Available Micro
      additionalProperties: true
      type: object
      required:
      - reset
      - deleted
      - wallet_available_micro
      title: SandboxReset
    SandboxInboundCreate:
      properties:
        to:
          type: string
          title: To
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        pages:
          type: integer
          maximum: 200.0
          minimum: 1.0
          title: Pages
          default: 1
        partial_content:
          type: boolean
          title: Partial Content
          description: Rehearse a cut-off transmission.
          default: false
      additionalProperties: false
      type: object
      required:
      - to
      title: SandboxInboundCreate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SandboxScenarios:
      properties:
        scenarios:
          items:
            additionalProperties:
              type: string
            type: object
          type: array
          title: Scenarios
        destinations:
          items:
            additionalProperties:
              type: string
            type: object
          type: array
          title: Destinations
        fixtures:
          items:
            $ref: '#/components/schemas/SandboxFixture'
          type: array
          title: Fixtures
      additionalProperties: true
      type: object
      required:
      - scenarios
      - destinations
      - fixtures
      title: SandboxScenarios
    SandboxScenarioCreate:
      properties:
        scenario:
          type: string
          title: Scenario
        destination:
          anyOf:
          - type: string
          - type: 'null'
          title: Destination
          description: Apply to one destination; omit for every send.
      additionalProperties: false
      type: object
      required:
      - scenario
      title: SandboxScenarioCreate
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json