swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector SentShareInvitation API
schemes:
- https
tags:
- name: SentShareInvitation
paths:
  /sentShares/{sentShareId}/sentShareInvitations:
    get:
      tags:
      - SentShareInvitation
      summary: Microsoft Azure List All Sent Share Invitations In A Sent Share
      description: List sent share recipients
      operationId: microsoftAzureSentsharesListinvitations
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/sentShareId'
      - $ref: '#/parameters/api-version'
      - $ref: '#/parameters/filter'
      - $ref: '#/parameters/orderby'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SentShareInvitationList'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        SentShares_ListInvitations:
          $ref: ./examples/SentShares_ListInvitations.json
      x-ms-pageable:
        nextLinkName: nextLink
  /sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}:
    get:
      tags:
      - SentShareInvitation
      summary: Microsoft Azure Get Sent Share Invitation For A Given Sent Share
      description: Get recipient for a given sent share
      operationId: microsoftAzureSentsharesGetinvitation
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/sentShareId'
      - $ref: '#/parameters/sentShareInvitationId'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SentShareInvitation'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        SentShares_GetInvitation:
          $ref: ./examples/SentShares_GetInvitation.json
        SentShares_GetUserInvitation:
          $ref: ./examples/SentShares_GetUserInvitation.json
        SentShares_GetServiceInvitation:
          $ref: ./examples/SentShares_GetServiceInvitation.json
    put:
      tags:
      - SentShareInvitation
      summary: Microsoft Azure Create A Sent Share Invitation
      description: Create a recipient for a given sent share
      operationId: microsoftAzureSentsharesCreateinvitation
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/sentShareId'
      - $ref: '#/parameters/sentShareInvitationId'
      - $ref: '#/parameters/api-version'
      - in: body
        name: sentShareInvitation
        description: The sent share invitation to create.
        required: true
        schema:
          $ref: '#/definitions/SentShareInvitation'
      responses:
        '201':
          description: Success
          schema:
            $ref: '#/definitions/SentShareInvitation'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        SentShares_CreateInvitation:
          $ref: ./examples/SentShares_CreateInvitation.json
        SentShares_CreateServiceInvitation:
          $ref: ./examples/SentShares_CreateServiceInvitation.json
        SentShares_CreateUserInvitation:
          $ref: ./examples/SentShares_CreateUserInvitation.json
    delete:
      tags:
      - SentShareInvitation
      summary: Microsoft Azure Delete Invitation In A Share
      description: Delete a sent share invitation
      operationId: microsoftAzureSentsharesDeleteinvitation
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/sentShareId'
      - $ref: '#/parameters/sentShareInvitationId'
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/OperationResponse'
          headers:
            Operation-Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        SentShares_DeleteInvitation:
          $ref: ./examples/SentShares_DeleteInvitation.json
      x-ms-long-running-operation: true
  /sentShares/{sentShareId}/sentShareInvitations/{sentShareInvitationId}:notify:
    post:
      tags:
      - SentShareInvitation
      summary: Microsoft Azure Notifies The Recipient Of The Sent Share Invitation
      description: Notifies the user recipient of the sent share invitation, does not apply to service invitations.
      operationId: microsoftAzureSentsharesNotifyuserinvitation
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/sentShareId'
      - $ref: '#/parameters/sentShareInvitationId'
      - $ref: '#/parameters/api-version'
      - in: header
        name: repeatability-request-id
        description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SentShareInvitation'
        default:
          description: Default error response.
          schema:
            $ref: '#/definitions/PurviewShareError'
          headers:
            x-ms-error-code:
              description: The error code
              type: string
      x-ms-examples:
        SentShares_NotifyUserInvitation:
          $ref: ./examples/SentShares_NotifyUserInvitation.json
definitions:
  PurviewShareError:
    description: The purview share error model.
    required:
    - error
    type: object
    properties:
      error:
        $ref: '#/definitions/PurviewShareErrorInfo'
  OperationStatus:
    description: States for long running operations.
    enum:
    - Running
    - TransientFailure
    - Succeeded
    - Failed
    - NotStarted
    type: string
    x-ms-enum:
      name: OperationStatus
      modelAsString: true
      values:
      - value: Running
        description: The long running operation is in 'Running' state
        name: Long running operation state is 'Running'
      - value: TransientFailure
        description: The long running operation hit a transient failure
        name: Long running operation state is 'TransientFailure'
      - value: Succeeded
        description: The long running operation is in 'Succeeded' state
        name: Long running operation state is 'Succeeded'
      - value: Failed
        description: The long running operation is in 'Failed' state
        name: Long running operation state is 'Failed'
      - value: NotStarted
        description: The long running operation has not started
        name: Long running operation state is 'NotStarted'
  ProxyResource:
    description: Base data transfer object implementation for proxy resources.
    type: object
    properties:
      id:
        description: The unique id of the resource.
        type: string
        readOnly: true
      type:
        description: Type of the resource.
        type: string
        readOnly: true
  SentShareInvitationList:
    description: List of the sent share invitations
    required:
    - value
    type: object
    properties:
      nextLink:
        format: url
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type SentShareInvitation
        type: array
        items:
          $ref: '#/definitions/SentShareInvitation'
  SentShareInvitation:
    description: A sent share invitation data transfer object.
    required:
    - invitationKind
    type: object
    allOf:
    - $ref: '#/definitions/ProxyResource'
    properties:
      invitationKind:
        $ref: '#/definitions/InvitationKind'
    discriminator: invitationKind
  PurviewShareErrorInfo:
    description: The purview share error body model.
    required:
    - code
    - message
    type: object
    properties:
      code:
        description: Code of the error
        type: string
      details:
        description: Nested details of the error model
        type: array
        items:
          $ref: '#/definitions/PurviewShareErrorInfo'
      message:
        description: Message of the error
        type: string
      target:
        description: Target of the error
        type: string
  OperationResponse:
    description: Response for long running operation.
    required:
    - status
    type: object
    properties:
      endTime:
        format: date-time
        description: End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
        type: string
      error:
        $ref: '#/definitions/PurviewShareErrorInfo'
      id:
        description: Job id of the long running operation
        type: string
      startTime:
        format: date-time
        description: Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
        type: string
      status:
        $ref: '#/definitions/OperationStatus'
  InvitationKind:
    description: The types of invitations.
    enum:
    - User
    - Service
    type: string
    x-ms-enum:
      name: InvitationKind
      modelAsString: true
      values:
      - value: User
        description: The invitation is sent to a user
        name: User invitation
      - value: Service
        description: The invitation is sent to a service
        name: Service invitation
parameters:
  sentShareId:
    in: path
    name: sentShareId
    description: Id of the sent share
    required: true
    type: string
    maxLength: 36
    pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$
    x-ms-parameter-location: method
  orderby:
    in: query
    name: orderby
    description: Sorts the results using OData syntax
    type: string
    x-ms-parameter-location: method
  filter:
    in: query
    name: filter
    description: Filters the results using OData syntax
    type: string
    x-ms-parameter-location: method
  sentShareInvitationId:
    in: path
    name: sentShareInvitationId
    description: Id of the sent share invitation
    required: true
    type: string
    maxLength: 36
    pattern: ^(?:\{{0,1}(?:[0-9a-fA-F]){8}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){4}-(?:[0-9a-fA-F]){12}\}{0,1})$|^(?:[0-9a-fA-F]+)$
    x-ms-parameter-location: method
  api-version:
    in: query
    name: api-version
    description: The api version to use
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'