invoicepdfs-com Template Versions API

openapi: 3.2.0
info:
  title: Invoicepdfs Com Template Versions API
  version: 0.3.0
  contact:
    name: InvoicePDFs
    url: https://invoicepdfs.com/
  license:
    name: MIT
  description: 'Operations tagged template-versions 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: template-versions
paths:
  /api/v1/templates/{template_id}/versions:
    get:
      tags:
      - template-versions
      summary: List Template Versions
      description: Every published version of a custom template, newest first.
      operationId: list_template_versions
      security:
      - HTTPBearer: []
      parameters:
      - name: template_id
        in: path
        required: true
        schema:
          type: string
          title: Template Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateVersionsListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
    post:
      tags:
      - template-versions
      summary: Create Template Version
      description: 'Snapshot a template''s current configuration as a new version.


        A document can pin a version, so a render months later reproduces the design

        that was live when it was issued rather than today''s.'
      operationId: create_template_version
      security:
      - HTTPBearer: []
      parameters:
      - name: template_id
        in: path
        required: true
        schema:
          type: string
          title: Template Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplateVersionCreateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateVersionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/templates/{template_id}/versions/{version}:
    get:
      tags:
      - template-versions
      summary: Get Template Version
      description: One version's stored configuration.
      operationId: get_template_version
      security:
      - HTTPBearer: []
      parameters:
      - name: template_id
        in: path
        required: true
        schema:
          type: string
          title: Template Id
      - name: version
        in: path
        required: true
        schema:
          type: integer
          title: Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateVersionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
  /api/v1/templates/{template_id}/versions/{version}/restore:
    post:
      tags:
      - template-versions
      summary: Restore Template Version
      description: 'Put a template back to the config a version recorded.


        The template moves; the version does not. Restoring v1 over v3''s config does

        not delete v3 or renumber anything — the next snapshot is v4, and the history

        stays a record of what happened rather than a record of the last decision.

        Take a version first if the config being replaced is worth keeping.'
      operationId: restore_template_version
      security:
      - HTTPBearer: []
      parameters:
      - name: template_id
        in: path
        required: true
        schema:
          type: string
          title: Template Id
      - name: version
        in: path
        required: true
        schema:
          type: integer
          title: Version
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateVersionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
      x-visibility: public
components:
  schemas:
    TemplateVersionResponse:
      properties:
        data:
          $ref: '#/components/schemas/TemplateVersionOut'
      type: object
      required:
      - data
      title: TemplateVersionResponse
    TemplateVersionCreateRequest:
      properties:
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
          examples:
          - Initial release
        changelog:
          anyOf:
          - type: string
          - type: 'null'
          title: Changelog
          examples:
          - Added header logo support
      type: object
      title: TemplateVersionCreateRequest
    TemplateVersionsListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/TemplateVersionOut'
          type: array
          title: Data
      type: object
      required:
      - data
      title: TemplateVersionsListResponse
    TemplateConfig:
      properties:
        primary_color:
          anyOf:
          - type: string
            pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
          - type: 'null'
          title: Primary Color
          examples:
          - '#0F172A'
        accent_color:
          anyOf:
          - type: string
            pattern: ^#(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$
          - type: 'null'
          title: Accent Color
          examples:
          - '#06B6D4'
        font_family:
          anyOf:
          - type: string
          - type: 'null'
          title: Font Family
          examples:
          - Inter
        header_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Header Text
          examples:
          - Acme Ltd
        footer_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Footer Text
          examples:
          - Thank you for your business
      additionalProperties: false
      type: object
      title: TemplateConfig
      description: 'What a custom template is: a built-in design plus the brand to render it in.


        A custom template is not a design of its own — it names one of the built-ins

        in ``base_template_id`` and carries the values below, which are the same ones

        ``data.branding`` carries. They are applied *underneath* a request''s own

        branding, so a document that states a colour still wins and one template can

        serve several brands.


        Typed rather than the free-form object it used to be: nothing read that

        object, so every key in it was equally correct and a caller could keep

        sending ``primary_colour`` forever without a word back. Unset here means

        "the template has no opinion" — unlike ``Branding``, whose every field has a

        non-empty default and so cannot say that.'
    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
    TemplateVersionOut:
      properties:
        id:
          type: string
          title: Id
        template_id:
          type: string
          title: Template Id
        version:
          type: integer
          title: Version
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        changelog:
          anyOf:
          - type: string
          - type: 'null'
          title: Changelog
        config:
          $ref: '#/components/schemas/TemplateConfig'
        created_at:
          type: string
          title: Created At
      type: object
      required:
      - id
      - template_id
      - version
      - config
      - created_at
      title: TemplateVersionOut
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- openapi.json
- invoicepdfs-com-openapi.json
x-internal-tags:
- auth
- jobs
- logs