swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Notifications API
schemes:
- https
tags:
- name: Notifications
paths:
  /messages/notifications:send:
    post:
      operationId: microsoftAzureNotificationmessagesoperationsSend
      tags:
      - Notifications
      description: Sends a notification message from Business to User.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId'
      - $ref: '#/parameters/Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/NotificationContent'
      responses:
        '202':
          description: The request has been accepted for processing, but processing has not yet completed.
          schema:
            $ref: '#/definitions/SendMessageResult'
          headers:
            Repeatability-Result:
              type: string
              description: Indicates whether the repeatable request was accepted or rejected.
              enum:
              - accepted
              - rejected
              x-ms-enum:
                name: RepeatabilityResult
                modelAsString: false
                values:
                - name: accepted
                  value: accepted
                  description: If the request was accepted and the server guarantees that the server state reflects a single execution of the operation.
                - name: rejected
                  value: rejected
                  description: 'If the request was rejected because the combination of Repeatability-First-Sent and Repeatability-Request-ID were invalid

                    or because the Repeatability-First-Sent value was outside the range of values held by the server.'
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        Sends a notification message - Template:
          $ref: ./examples/NotificationMessages_SendTemplate.json
        Sends a notification message - image:
          $ref: ./examples/NotificationMessages_SendImage.json
        Sends a notification message - text:
          $ref: ./examples/NotificationMessages_SendText.json
      summary: Microsoft Azure Post Messages Notifications:send
definitions:
  Azure.Core.uuid:
    type: string
    format: uuid
    description: Universally Unique Identifier
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  MessageReceipt:
    type: object
    description: Receipt of the sending one message.
    properties:
      messageId:
        type: string
        description: The message id.
      to:
        type: string
        description: The native external platform user identifier of the recipient.
    required:
    - messageId
    - to
  NotificationContent:
    type: object
    description: Details of the message to send.
    properties:
      channelRegistrationId:
        $ref: '#/definitions/Azure.Core.uuid'
        description: The Channel Registration ID for the Business Identifier.
      to:
        type: array
        description: The native external platform user identifiers of the recipient.
        items:
          type: string
      kind:
        $ref: '#/definitions/CommunicationMessageKind'
        description: The type discriminator describing a notification type.
    discriminator: kind
    required:
    - channelRegistrationId
    - to
    - kind
  SendMessageResult:
    type: object
    description: Result of the send message operation.
    properties:
      receipts:
        type: array
        description: Receipts of the send message operation.
        items:
          $ref: '#/definitions/MessageReceipt'
        x-ms-identifiers: []
    required:
    - receipts
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  CommunicationMessageKind:
    type: string
    description: The type of message. Supports text, image, template.
    enum:
    - text
    - image
    - template
    x-ms-enum:
      name: CommunicationMessageKind
      modelAsString: true
      values:
      - name: text
        value: text
        description: Text message type.
      - name: image
        value: image
        description: Image message type.
      - name: template
        value: template
        description: Template message type.
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  Azure.Core.RepeatabilityRequestHeaders.repeatabilityFirstSent:
    name: Repeatability-First-Sent
    in: header
    description: Specifies the date and time at which the request was first created.
    required: false
    type: string
    format: date-time
    x-ms-parameter-location: method
    x-ms-client-name: repeatabilityFirstSent
  Azure.Core.RepeatabilityRequestHeaders.repeatabilityRequestId:
    name: Repeatability-Request-ID
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: repeatabilityRequestId
  Azure.Core.ClientRequestIdHeader:
    name: x-ms-client-request-id
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    format: uuid
    x-ms-parameter-location: method
    x-ms-client-name: clientRequestId
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'