swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Manage Purchased Phone Numbers API
schemes:
- https
tags:
- name: Manage Purchased Phone Numbers
paths:
  /phoneNumbers/{phoneNumber}/capabilities:
    patch:
      tags:
      - Manage Purchased Phone Numbers
      summary: Microsoft Azure Updates The Capabilities Of A Phone Number
      operationId: microsoftAzurePhonenumbersUpdatecapabilities
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: phoneNumber
        description: The phone number id in E.164 format. The leading plus can be either + or encoded as %2B, e.g. +11234567890.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      - in: body
        name: body
        description: Defines the update capabilities request.
        schema:
          $ref: '#/definitions/PhoneNumberCapabilitiesRequest'
      responses:
        '202':
          description: The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' and 'Location' headers. Client side should further query the operation status using the URL specified in 'Operation-Location' header. When operation completes successfully query final result using URL specified in 'Location' header.
          schema:
            $ref: '#/definitions/PurchasedPhoneNumber'
          headers:
            Location:
              description: URL to retrieve the final result after operation completes.
              type: string
            Operation-Location:
              description: URL to query for status of the operation.
              type: string
            operation-id:
              description: The operation id.
              type: string
            capabilities-id:
              description: The capabilities operation id.
              type: string
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Update phoneNumber capabilities:
          $ref: ./examples/UpdatePhoneNumberCapabilities.json
      description: Needs a more full description created.
  /phoneNumbers/{phoneNumber}:
    get:
      tags:
      - Manage Purchased Phone Numbers
      summary: Microsoft Azure Gets The Details Of The Given Purchased Phone Number
      operationId: microsoftAzurePhonenumbersGetbynumber
      produces:
      - application/json
      parameters:
      - in: path
        name: phoneNumber
        description: The purchased phone number whose details are to be fetched in E.164 format, e.g. +11234567890.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PurchasedPhoneNumber'
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-examples:
        Fetch purchased phone number:
          $ref: ./examples/GetPhoneNumber.json
      description: Needs a more full description created.
    delete:
      tags:
      - Manage Purchased Phone Numbers
      summary: Microsoft Azure Releases A Purchased Phone Number
      operationId: microsoftAzurePhonenumbersReleasephonenumber
      parameters:
      - in: path
        name: phoneNumber
        description: Phone number to be released, e.g. +11234567890.
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '202':
          description: The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' and 'Location' headers. Client side should further query the operation status using the URL specified in 'Operation-Location' header. When operation completes successfully query final result using URL specified in 'Location' header.
          headers:
            Operation-Location:
              description: URL to query for status of the operation.
              type: string
            operation-id:
              description: The operation id.
              type: string
            release-id:
              description: The release operation id.
              type: string
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        Release phone number:
          $ref: ./examples/ReleasePhoneNumber.json
      produces:
      - application/json
      description: Needs a more full description created.
  /phoneNumbers:
    get:
      tags:
      - Manage Purchased Phone Numbers
      summary: Microsoft Azure Gets The List Of All Purchased Phone Numbers
      operationId: microsoftAzurePhonenumbersListphonenumbers
      produces:
      - application/json
      parameters:
      - in: query
        name: skip
        description: An optional parameter for how many entries to skip, for pagination purposes. The default value is 0.
        type: integer
        format: int32
        default: 0
      - in: query
        name: top
        description: An optional parameter for how many entries to return, for pagination purposes. The default value is 100.
        type: integer
        format: int32
        default: 100
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PurchasedPhoneNumbers'
        default:
          description: Failure
          schema:
            $ref: ../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
        itemName: phoneNumbers
      x-ms-examples:
        List purchased phone numbers:
          $ref: ./examples/GetPhoneNumbers.json
      description: Needs a more full description created.
definitions:
  PurchasedPhoneNumbers:
    description: The list of purchased phone numbers.
    required:
    - phoneNumbers
    type: object
    properties:
      phoneNumbers:
        description: Represents a list of phone numbers.
        type: array
        items:
          $ref: '#/definitions/PurchasedPhoneNumber'
      nextLink:
        description: Represents the URL link to the next page of phone number results.
        type: string
  PurchasedPhoneNumber:
    description: Represents a purchased phone number.
    required:
    - assignmentType
    - capabilities
    - cost
    - countryCode
    - id
    - phoneNumber
    - phoneNumberType
    - purchaseDate
    type: object
    properties:
      id:
        description: The id of the phone number, e.g. 11234567890.
        type: string
      phoneNumber:
        description: String of the E.164 format of the phone number, e.g. +11234567890.
        type: string
      countryCode:
        description: The ISO 3166-2 code of the phone number's country, e.g. US.
        type: string
      phoneNumberType:
        description: The phone number's type, e.g. Geographic, TollFree.
        enum:
        - geographic
        - tollFree
        type: string
        x-ms-enum:
          name: PhoneNumberType
          modelAsString: true
      capabilities:
        $ref: '#/definitions/PhoneNumberCapabilities'
      assignmentType:
        description: The assignment type of the phone number. A phone number can be assigned to a person, or to an application.
        enum:
        - person
        - application
        type: string
        x-ms-enum:
          name: PhoneNumberAssignmentType
          modelAsString: true
      purchaseDate:
        format: date-time
        description: The date and time that the phone number was purchased.
        type: string
      cost:
        $ref: '#/definitions/PhoneNumberCost'
  PhoneNumberCapabilities:
    description: Capabilities of a phone number.
    required:
    - calling
    - sms
    type: object
    properties:
      calling:
        description: Capability value for calling.
        enum:
        - none
        - inbound
        - outbound
        - inbound+outbound
        type: string
        x-ms-enum:
          name: PhoneNumberCapabilityType
          modelAsString: true
      sms:
        description: Capability value for SMS.
        enum:
        - none
        - inbound
        - outbound
        - inbound+outbound
        type: string
        x-ms-enum:
          name: PhoneNumberCapabilityType
          modelAsString: true
  PhoneNumberCost:
    description: The incurred cost for a single phone number.
    required:
    - amount
    - billingFrequency
    - currencyCode
    type: object
    properties:
      amount:
        format: double
        description: The cost amount.
        type: number
      currencyCode:
        description: The ISO 4217 currency code for the cost amount, e.g. USD.
        type: string
      billingFrequency:
        description: The frequency with which the cost gets billed.
        enum:
        - monthly
        type: string
        x-ms-enum:
          name: BillingFrequency
          modelAsString: true
  PhoneNumberCapabilitiesRequest:
    description: Capabilities of a phone number.
    type: object
    properties:
      calling:
        description: Capability value for calling.
        enum:
        - none
        - inbound
        - outbound
        - inbound+outbound
        type: string
        x-ms-enum:
          name: PhoneNumberCapabilityType
          modelAsString: true
      sms:
        description: Capability value for SMS.
        enum:
        - none
        - inbound
        - outbound
        - inbound+outbound
        type: string
        x-ms-enum:
          name: PhoneNumberCapabilityType
          modelAsString: true
parameters:
  ApiVersionParameter:
    in: query
    name: api-version
    description: Version of API to invoke.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'