openapi: 3.2.0
info:
  title: Trustarc Email Templates API
  version: v1
  description: 'Operations tagged Email Templates across 2 of this provider''s published API definitions: trustarc-guardian-openapi.json, trustarc-guardian-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://login.truste.com
  description: Generated server url
tags:
- name: Email Templates
paths:
  /api/v1/emailtemplates/{id}:
    get:
      tags:
      - Email Templates
      operationId: get_10
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerEmailTemplate'
      security:
      - guardianAuth: []
    put:
      tags:
      - Email Templates
      operationId: update_9
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerEmailTemplate'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CustomerEmailTemplate'
      security:
      - guardianAuth: []
    delete:
      tags:
      - Email Templates
      operationId: delete_8
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      security:
      - guardianAuth: []
    servers:
    - url: https://login.truste.com
      description: Generated server url
  /api/v1/emailtemplates:
    get:
      tags:
      - Email Templates
      operationId: list_10
      parameters:
      - name: accountId
        in: query
        required: false
        schema:
          type: string
          default: ''
      - name: emailTemplateType
        in: query
        required: false
        schema:
          type: string
          enum:
          - FORGOT_PASSWORD
          - NEW_USER
          - IMPORT_JOB
          - EXPORT_JOB
          - LOGIN_REPORT
          - FULL_LOGIN_REPORT
          - EXPIRE_TOKEN
          - OTP
          - NEW_USER_REPORT
      - name: page
        in: query
        description: Results page you want to retrieve (0..N).
        schema:
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of recods per page.
        schema:
          default: 10
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        schema:
          type: array
          items: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageCustomerEmailTemplate'
      security:
      - guardianAuth: []
    post:
      tags:
      - Email Templates
      operationId: create_10
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomerEmailTemplate'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerEmailTemplate'
      security:
      - guardianAuth: []
    servers:
    - url: https://login.truste.com
      description: Generated server url
  /api/v1/emailtemplates/{emailTemplateType}/macros:
    get:
      tags:
      - Email Templates
      operationId: getMacros
      parameters:
      - name: emailTemplateType
        in: path
        required: true
        schema:
          type: string
          enum:
          - FORGOT_PASSWORD
          - NEW_USER
          - IMPORT_JOB
          - EXPORT_JOB
          - LOGIN_REPORT
          - FULL_LOGIN_REPORT
          - EXPIRE_TOKEN
          - OTP
          - NEW_USER_REPORT
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items: {}
      security:
      - guardianAuth: []
    servers:
    - url: https://login.truste.com
      description: Generated server url
  /api/v1/emailtemplates/defaults:
    get:
      tags:
      - Email Templates
      operationId: getDefaults
      parameters:
      - name: emailTemplateType
        in: query
        required: false
        schema:
          type: string
          enum:
          - FORGOT_PASSWORD
          - NEW_USER
          - IMPORT_JOB
          - EXPORT_JOB
          - LOGIN_REPORT
          - FULL_LOGIN_REPORT
          - EXPIRE_TOKEN
          - OTP
          - NEW_USER_REPORT
      - name: page
        in: query
        description: Results page you want to retrieve (0..N).
        schema:
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of recods per page.
        schema:
          default: 10
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        schema:
          type: array
          items: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageCustomerEmailTemplate'
      security:
      - guardianAuth: []
    servers:
    - url: https://login.truste.com
      description: Generated server url
components:
  schemas:
    PageCustomerEmailTemplate:
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/PageableObject'
        size:
          type: integer
          format: int32
        content:
          type: array
          items:
            $ref: '#/components/schemas/CustomerEmailTemplate'
        number:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject'
        first:
          type: boolean
        last:
          type: boolean
        numberOfElements:
          type: integer
          format: int32
        empty:
          type: boolean
    PageableObject:
      properties:
        paged:
          type: boolean
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        offset:
          type: integer
          format: int64
        sort:
          $ref: '#/components/schemas/SortObject'
        unpaged:
          type: boolean
    SortObject:
      properties:
        empty:
          type: boolean
        sorted:
          type: boolean
        unsorted:
          type: boolean
    CustomerEmailTemplate:
      properties:
        id:
          type: string
        createdDate:
          type: string
          format: date-time
        modifiedDate:
          type: string
          format: date-time
        type:
          type: string
          enum:
          - FORGOT_PASSWORD
          - NEW_USER
          - IMPORT_JOB
          - EXPORT_JOB
          - LOGIN_REPORT
          - FULL_LOGIN_REPORT
          - EXPIRE_TOKEN
          - OTP
          - NEW_USER_REPORT
        content:
          type: string
        accountId:
          type: string
        modifiedById:
          type: string
  securitySchemes:
    guardianAuth:
      type: oauth2
      scheme: bearer
      bearerFormat: JWT
      flows:
        implicit:
          authorizationUrl: https://login.truste.com/oauth/authorize
          tokenUrl: https://login.truste.com/oauth/token
          scopes:
            openid: OpenID
x-refined-from:
- trustarc-guardian-openapi.json
- trustarc-guardian-openapi.yml