invoicepdfs-com Deliveries API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Deliveries API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged deliveries 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: Deliveries
paths:
  /api/v1/deliveries/{delivery_id}:
    get:
      tags:
      - Deliveries
      summary: Get Delivery
      description: 'One email delivery by id — an email sent to a customer.


        Not to be confused with `get_webhook_delivery`, which is an HTTP POST to

        one of your webhook endpoints.'
      operationId: get_delivery
      security:
      - HTTPBearer: []
      parameters:
      - name: delivery_id
        in: path
        required: true
        schema:
          type: string
          title: Delivery Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/deliveries/{delivery_id}/retry:
    post:
      tags:
      - Deliveries
      summary: Retry Delivery
      description: 'Queue a fresh delivery copying a failed one.


        Returns 202 with the new delivery in `queued`. Transient failures are

        already retried automatically; this is for after those are exhausted.'
      operationId: retry_delivery
      security:
      - HTTPBearer: []
      parameters:
      - name: delivery_id
        in: path
        required: true
        schema:
          type: string
          title: Delivery Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeliveryResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    DeliveryStatus:
      type: string
      enum:
      - queued
      - sent
      - failed
      title: DeliveryStatus
      description: 'Email delivery. `sent` is terminal success — nothing reports back what

        the provider did with the message after we handed it over.'
    DeliveryOut:
      properties:
        id:
          type: string
          title: Id
        invoice_id:
          type: string
          title: Invoice Id
        to:
          items:
            type: string
          type: array
          title: To
        cc:
          items:
            type: string
          type: array
          title: Cc
        bcc:
          items:
            type: string
          type: array
          title: Bcc
        subject:
          type: string
          title: Subject
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        attach_pdf:
          type: boolean
          title: Attach Pdf
        status:
          $ref: '#/components/schemas/DeliveryStatus'
        created_at:
          type: string
          title: Created At
        sent_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Sent At
      type: object
      required:
      - id
      - invoice_id
      - to
      - cc
      - bcc
      - subject
      - attach_pdf
      - status
      - created_at
      title: DeliveryOut
    DeliveryResponse:
      properties:
        data:
          $ref: '#/components/schemas/DeliveryOut'
      type: object
      required:
      - data
      title: DeliveryResponse
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs