Fax for Agents Quotes API

openapi: 3.2.0
info:
  title: Faxforagents Quotes 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 quotes 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: Quotes
paths:
  /v1/fax-quotes:
    post:
      tags:
      - Quotes
      summary: Price an exact document to one destination
      operationId: create_fax_quote
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuoteCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quote'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/fax-quotes/{quote_id}:
    get:
      tags:
      - Quotes
      summary: Read a quote
      operationId: get_fax_quote
      parameters:
      - name: quote_id
        in: path
        required: true
        schema:
          type: string
          title: Quote Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Quote'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Quote:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        document_id:
          type: string
          title: Document Id
        document_sha256:
          type: string
          title: Document Sha256
        to:
          type: string
          title: To
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
        route:
          type: string
          title: Route
        document_pages:
          type: integer
          title: Document Pages
        cover_pages:
          type: integer
          title: Cover Pages
        billable_pages:
          type: integer
          title: Billable Pages
        amount_micro:
          type: integer
          title: Amount Micro
        currency:
          type: string
          title: Currency
        price_version:
          type: string
          title: Price Version
        per_page_micro:
          type: integer
          title: Per Page Micro
          default: 0
        route_label:
          type: string
          title: Route Label
          default: ''
        cover:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Cover
        authorization_required:
          type: boolean
          title: Authorization Required
        warnings:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Warnings
        expires_at:
          type: string
          title: Expires At
        expired:
          type: boolean
          title: Expired
        consumed_by_job_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Consumed By Job Id
        created_at:
          type: string
          title: Created At
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - document_id
      - document_sha256
      - to
      - route
      - document_pages
      - cover_pages
      - billable_pages
      - amount_micro
      - currency
      - price_version
      - cover
      - authorization_required
      - warnings
      - expires_at
      - expired
      - consumed_by_job_id
      - created_at
      title: Quote
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    QuoteCreate:
      properties:
        document_id:
          type: string
          title: Document Id
        to:
          type: string
          title: To
          description: Destination in E.164, for example +12025550123.
        from:
          anyOf:
          - type: string
          - type: 'null'
          title: From
          description: A number you own; omit for the shared pool.
        cover:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Cover
          description: 'Cover sheet fields: to_name, from_name, subject, message. Counts as a page.'
      additionalProperties: false
      type: object
      required:
      - document_id
      - to
      title: QuoteCreate
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json