openapi: 3.2.0
info:
  title: Fenergo Email API
  version: '4.0'
  description: 'Operations tagged Email across 2 of this provider''s published API definitions: fenergo-portaltenantcommand-v4-0-openapi.json, fenergo-portaltenantquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /portaltenantcommand
- url: /portaltenantquery
security:
- Bearer: []
tags:
- name: Email
paths:
  /api/email/sendemail:
    post:
      tags:
      - Email
      summary: Sends Email using configured Outreach Email Domain
      description: 'Required permissions:

        Following permissions are required: PortalTenantAccess'
      operationId: SendEmail
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.SendEmailDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /portaltenantcommand
  /api/email/emailprovider:
    get:
      tags:
      - Email
      summary: Gets Tenant's Email Provider
      description: 'Required permissions:

        Following permissions are required: PortalTenantAccess'
      operationId: GetEmailProvider
      parameters:
      - name: X-TENANT-ID
        in: header
        description: The UiD of the tenant representing organization
        required: true
        schema:
          type: string
        example: b11f8be3-f29b-4959-8964-956d4af7c468
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
              example:
                data: {}
                messages:
                - message: Not Found
                  type: Error
                  errorCode: Error Code
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse'
        '401':
          description: User is not authorized to perform this request
          content:
            application/json:
              example:
                message: Unauthorized
        '403':
          description: Access to resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
              example:
                data: {}
                messages:
                - message: 'Access denied. Following permissions are required: Permission1, Permission2'
                  type: Forbidden
                  errorCode: Error Code
        '410':
          description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e'
              example:
                data: null
                messages:
                - message: This endpoint is obsolete and was terminated on yyyy-MM-dd
                  type: Error
                  errorCode: OBSOLETE_ENDPOINT
    servers:
    - url: /portaltenantquery
components:
  schemas:
    Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse:
      type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e
    : type: object
      properties:
        data:
          type:
          - string
          - 'null'
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e
    : type: object
      properties:
        data:
          description: The service response DTO
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    Fenergo.Nebula.Portal.Tenant.Shared.Dto.SendEmailDto:
      type: object
      properties:
        to:
          type:
          - string
          - 'null'
        templateName:
          type:
          - string
          - 'null'
        variables:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        journeyId:
          type:
          - string
          - 'null'
        isJourneyCancelled:
          type: boolean
        entityName:
          type:
          - string
          - 'null'
        portalUrl:
          type:
          - string
          - 'null'
      additionalProperties: false
    Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: The message
          example: Success
        type:
          type:
          - string
          - 'null'
          description: 'Type of the message

            One of Info, Warning, Error, Forbidden'
          example: Info
        errorCode:
          type:
          - string
          - 'null'
          description: Error Code
          example: INTERNAL_SERVER_ERROR
      additionalProperties: false
      description: The message associated to the service response
    ? Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.SendEmailDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null
    : type: object
      properties:
        data:
          $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SendEmailDto'
      additionalProperties: false
      description: Service request data
    Fenergo.Nebula.Outreach.Query.DotNetClient.ReceivingDnsRecordDto:
      type: object
      properties:
        recordType:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        priority:
          type:
          - string
          - 'null'
      additionalProperties: false
    Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        name:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        enabled:
          type: boolean
        receivingDnsRecords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Fenergo.Nebula.Outreach.Query.DotNetClient.ReceivingDnsRecordDto'
        sendingDnsRecords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Fenergo.Nebula.Outreach.Query.DotNetClient.SendingDnsRecordDto'
      additionalProperties: false
    ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null
    : type: object
      properties:
        data:
          $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto'
        messages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage'
          description: List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response
      additionalProperties: false
      description: Service response data
    Fenergo.Nebula.Outreach.Query.DotNetClient.SendingDnsRecordDto:
      type: object
      properties:
        recordType:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header
x-refined-from:
- fenergo-portaltenantcommand-v4-0-openapi.json
- fenergo-portaltenantquery-v4-0-openapi.json