NationGraph Email Sequences API

openapi: 3.1.0
info:
  title: Nationgraph Accounts Email Sequences API
  version: 0.2.36
tags:
- name: Email Sequences
paths:
  /api/v3/email-sequences:
    post:
      tags:
      - Email Sequences
      summary: Create Sequence
      operationId: create_sequence_api_v3_email_sequences_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmailSequenceRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailSequenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    get:
      tags:
      - Email Sequences
      summary: Get Sequences
      operationId: get_sequences_api_v3_email_sequences_get
      security:
      - HTTPBearer: []
      parameters:
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EmailSequenceResponse'
                title: Response Get Sequences Api V3 Email Sequences Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v3/email-sequences/{sequence_id}:
    get:
      tags:
      - Email Sequences
      summary: Get Sequence
      operationId: get_sequence_api_v3_email_sequences__sequence_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sequence Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailSequenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Email Sequences
      summary: Update Sequence
      operationId: update_sequence_api_v3_email_sequences__sequence_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sequence Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailSequenceUpdates'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmailSequenceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    EmailSequenceUpdates:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        config:
          anyOf:
          - $ref: '#/components/schemas/EmailSequenceConfig'
          - type: 'null'
        status:
          anyOf:
          - $ref: '#/components/schemas/EmailResourceStatus'
          - type: 'null'
      type: object
      title: EmailSequenceUpdates
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    EmailResourceStatus:
      type: string
      enum:
      - draft
      - active
      - archived
      title: EmailResourceStatus
    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
    CreateEmailSequenceRequest:
      properties:
        name:
          type: string
          title: Name
        config:
          $ref: '#/components/schemas/EmailSequenceConfig'
          default:
            template_ids: []
        status:
          $ref: '#/components/schemas/EmailResourceStatus'
          default: draft
      type: object
      required:
      - name
      title: CreateEmailSequenceRequest
    EmailSequenceConfig:
      properties:
        template_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Template Ids
          default: []
      type: object
      title: EmailSequenceConfig
    EmailSequenceResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        config:
          $ref: '#/components/schemas/EmailSequenceConfig'
        status:
          type: string
          title: Status
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
      type: object
      required:
      - id
      - name
      - config
      - status
      - created_by
      - created_at
      - updated_at
      title: EmailSequenceResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer