invoicepdfs-com Jobs API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Jobs API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged jobs across 2 of this provider''s published API definitions: openapi.json, invoicepdfs-com-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Jobs
paths:
  /api/v1/jobs:
    get:
      tags:
      - Jobs
      summary: List Jobs
      description: 'This account''s jobs, newest first.


        Without it the other three routes here were unreachable: a job id was never

        returned by anything, so there was no way to arrive at one.'
      operationId: list_jobs
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Limit
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobsListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: internal
  /api/v1/jobs/{job_id}:
    get:
      tags:
      - Jobs
      summary: Get Job
      description: One job's status and progress.
      operationId: get_job
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: internal
  /api/v1/jobs/{job_id}/cancel:
    post:
      tags:
      - Jobs
      summary: Cancel Job
      description: Stop a job that has not finished.
      operationId: cancel_job
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: internal
  /api/v1/jobs/{job_id}/retry:
    post:
      tags:
      - Jobs
      summary: Retry Job
      description: 'Return a `failed` or `cancelled` job to `queued`, clearing its progress and error.


        `409` from any other status.'
      operationId: retry_job
      security:
      - HTTPBearer: []
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          type: string
          title: Job Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: internal
components:
  schemas:
    CursorPagination:
      properties:
        has_more:
          type: boolean
          title: Has More
          default: false
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
      type: object
      title: CursorPagination
    JobResponse:
      properties:
        data:
          $ref: '#/components/schemas/JobOut'
      type: object
      required:
      - data
      title: JobResponse
    JobsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/JobOut'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/CursorPagination'
      type: object
      required:
      - data
      title: JobsListResponse
    ApiErrorResponse:
      type: object
      title: ApiErrorResponse
      properties:
        error:
          type: object
          properties:
            status:
              type: integer
              example: 422
              description: HTTP status, mirroring the response status line.
            code:
              type: string
              example: unprocessable_entity
            message:
              type: string
              example: Request validation failed
            request_id:
              type: string
              nullable: true
              description: Trace id for this request; also returned as X-Trace-Id.
            details:
              type: object
              nullable: true
              description: Error-specific context. Validation failures carry `fields`.
          required:
          - status
          - code
          - message
      required:
      - error
    JobStatus:
      type: string
      enum:
      - queued
      - processing
      - completed
      - failed
      - cancelled
      title: JobStatus
    JobOut:
      properties:
        id:
          type: string
          title: Id
        type:
          type: string
          title: Type
        status:
          $ref: '#/components/schemas/JobStatus'
        progress:
          $ref: '#/components/schemas/JobProgressOut'
        result:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Result
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        created_at:
          type: string
          title: Created At
        started_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Started At
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
      type: object
      required:
      - id
      - type
      - status
      - progress
      - created_at
      title: JobOut
    JobProgressOut:
      properties:
        current:
          type: integer
          title: Current
        total:
          type: integer
          title: Total
        percentage:
          type: integer
          title: Percentage
      type: object
      required:
      - current
      - total
      - percentage
      title: JobProgressOut
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs