openapi: 3.0.2
x-explorer-enabled: false
x-samples-languages:
- curl
- node
- java
- javascript
- python
- go
info:
  title: Admin - Voice
  description: "The Voice provider APIs are used to manage information about voice specific elements and different voice related\
    \ entities e.g. Phone numbers.\n\nVoice Services will support multiple ways to provision voice providers\n  1. Programmatic\
    \ Interface (Rest APIs)\n  2. User Interface\n"
  contact:
    name: Avaya API Team
    url: https://developers.avayacloud.com/onecloud-ccaas
    email: apiteam@avaya.com
  license:
    name: Avaya Software Development Kit (SDK) Software License Terms
    url: http://support.avaya.com/css/P8/documents/101038288
  version: 1.0.2
security:
- {}
- BearerAuth: []
  AppKey: []
servers:
- url: '{protocol}://{server}{basePath}'
  description: Open API
  variables:
    protocol:
      enum:
      - https
      default: https
    server:
      default: HOST-REGION.api.avayacloud.com
    basePath:
      default: /api/admin/voice/v1
tags:
- name: Available Phone Numbers
  description: 'The available phone numbers that can be added to the contact center.

    '
- name: Avaya Aura Device Services
  description: 'Administration of Avaya Aura Device Service Elements. These API are expected to be called by an account administrator.
    AADS is the abbreviated form for Avaya Aura Device Service and is commonly used in the summary of the Apis. OIDC stands
    for OpenID Connect Discovery.

    '
- name: Avaya Cloud Office management
  description: 'APIs to manage Avaya Cloud Office element in voice service

    '
- name: Avaya Cloud Office SIP Trunks
  description: 'APIs to manage Avaya Cloud Office SIP Trunk element in voice service

    '
- name: Communication Manager
  description: 'Administration of Communication Manager configuration. These API are expected to be called by an account administrator.
    CM is the abbreviated form for Communication Manager and is commonly used in the summary of the Apis.

    '
- name: Comm Manager Job Details
  description: 'This API is used to get details of list of jobs or a single job for a specific Communication Manager. These
    API are expected to be called by an account administrator.

    '
- name: Country
  description: 'The countries in which available phone numbers are available.

    '
- name: Extension
  description: 'Management of non e164 Extension that are assigned to Account. These API are expected to be called by an account
    administrator.

    '
- name: Hybrid Extension
  description: 'Management of hybrid extensions assigned to users. These API are expected to be called by an account administrator.

    '
- name: Hybrid Skill
  description: 'Administration of Hybrid Skills. These APIs are expected to be called by an account administrator.

    '
- name: Gateway Connection Manager
  description: 'Get Details of Gateway Connection Manager. These API are expected to be called by an account administrator.

    '
- name: Hybrid Cloud Gateway
  description: 'Administration of Avaya Hybrid Cloud Gateway. These API are expected to be called by an account administrator.
    HCG is the abbreviated form for Hybrid Cloud Gateway and is commonly used in the summary of the APIs.

    '
- name: Hybrid Cloud Manager
  description: Administration of Hybrid Cloud Manager.This API is expected to be called by an account administrator.
- name: Location Profile
  description: 'This API is for managing location profiles. These API are expected to be called by an account administrator.

    '
- name: Agent Location
  description: 'Agent location Routing APIs for System Administrator. It will enable agents connecting from different countries
    to be able to go through specific trunks or connection.

    '
- name: Microsoft Teams management
  description: 'APIs to manage Microsoft Teams element in voice service.

    '
- name: Microsoft Teams SIP Trunks
  description: 'APIs to manage Microsoft Teams SIP Trunk element in voice service.

    '
- name: Outbound Number Routing Rules
  description: 'APIs to manage Outbound Call Number Routing Rules in voice service by an account administrator.

    '
- name: Phone Number
  description: 'Management of phone numbers that are the entry point for contact center voice engagements. Phone number can
    be assigned and released.

    '
- name: Reason Codes
  description: Reason codes are a set of codes that agents can select from agent desktop clients to further describe their
    current activity or state. Reason Codes consist of a unique codeName, codeNumber and codeType combination. This API is
    used to create, update, retrieve and delete NOT_READY, LOGOUT reason codes and CALL_WORK_CODES codes.
- name: SIP Trunks
  description: 'This API is used to get list of all SIP trunk elements and update caller id for an account administrator.

    '
- name: Sync Aura Entities
  description: 'Set of API to initiate synchronization of data from Aura to AXP admin. These API are expected to be called
    by an account administrator.

    '
- name: System Manager
  description: 'Administration of System Manager. These API are expected to be called by an account administrator.

    '
- name: Voice Numbers And Extensions
  description: 'APIs to export the Voice Numbers and Agent Extensions and its associated fields in a CSV file for account
    administrator.

    '
- name: Voice Plan
  description: 'Represents Voice Plan of configured Communication Managers for Account Administrator. These API are expected
    to be called by an account administrator.

    '
paths:
  /accounts/{accountId}/avaya-aura-device-services:
    post:
      tags:
      - Avaya Aura Device Services
      summary: Creates an AADS Element
      description: '**This API requires the Account Administrator role.**


        Creates an Avaya Aura Device Service Element for specified account

        '
      operationId: createAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvayaAuraDeviceService'
            examples:
              default:
                $ref: '#/components/examples/AvayaAuraDeviceServiceReq'
        required: true
      responses:
        '202':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceServiceResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServiceRes'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Avaya Aura Device Services
      summary: Gets a list of all AADS
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Avaya Aura Device Service Elements by account Id

        '
      operationId: getAllAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
          The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an\
          \ exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will\
          \ be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will\
          \ be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be\
          \ used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=AADS123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:AADS1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*AADS
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceServices'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServicesRes'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/avaya-aura-device-services/{avayaAuraDeviceServiceId}:
    put:
      tags:
      - Avaya Aura Device Services
      summary: Updates an AADS Element
      description: '**This API requires the Account Administrator role.**


        Updates an existing Avaya Aura Device Service Element with unique id of the element by account id

        '
      operationId: updateAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/avayaAuraDeviceServiceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AvayaAuraDeviceService'
            examples:
              default:
                $ref: '#/components/examples/AvayaAuraDeviceServiceReq'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceServiceResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServiceRes'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Avaya Aura Device Services
      summary: Gets the details of a AADS
      description: '**This API requires the Account Administrator role.**


        Returns the details of an Avaya Aura Device Service Element, based on unique id of the element and account id

        '
      operationId: getAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/avayaAuraDeviceServiceId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvayaAuraDeviceService'
              examples:
                default:
                  $ref: '#/components/examples/AvayaAuraDeviceServiceObj'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Avaya Aura Device Services
      summary: Deletes an AADS Element
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Avaya Aura Device Service Element identified by unique id of the element

        '
      operationId: deleteAvayaAuraDeviceService
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/avayaAuraDeviceServiceId'
      responses:
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/avaya-aura-device-services:discoveryUrl:
    get:
      tags:
      - Avaya Aura Device Services
      summary: Gets the OIDC Url
      description: '**This API requires the Account Administrator role.**


        Returns the OpenID Connect Discovery Url, based on account id

        '
      operationId: getOpenIDConnectDiscovery
      parameters:
      - $ref: '#/components/parameters/accountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenIDConnectDiscovery'
              examples:
                default:
                  $ref: '#/components/examples/OpenIDConnectDiscoveryRes'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/aco-elements:
    post:
      tags:
      - Avaya Cloud Office management
      summary: Create Avaya Cloud Office
      description: "**This API requires the Account Administrator role.**\n\nAdd a new Avaya Cloud Office element with required\
        \ ACO Server data.\n\nOnly one instance of Avaya Cloud Office element can be created for an account.\n\nThe following\
        \ field must be unique otherwise a `HTTP 409 Conflict` will be returned:\n  * `name`\n\n  Will trigger asynchronous\
        \ updates, the status of which should be monitored via `GET /aco-elements/{elementId}`.\n"
      operationId: createAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        description: Avaya Cloud Office
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACOElement'
            examples:
              ACO:
                $ref: '#/components/examples/ACORequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOElement'
              examples:
                ACO:
                  $ref: '#/components/examples/ACOResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorACOExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/aco-elements/{elementId}:
    put:
      tags:
      - Avaya Cloud Office management
      summary: Update Avaya Cloud Office
      description: "**This API requires the Account Administrator role.**\n\n Update an existing Avaya Cloud Office element\
        \ by unique element Id and ACO server details.\n\n\n  Will trigger asynchronous updates, the status of which should\
        \ be monitored via `GET /aco-elements/{elementId}`.\n"
      operationId: updateAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ACOElement'
            examples:
              ACO:
                $ref: '#/components/examples/ACORequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOElement'
              examples:
                ACO:
                  $ref: '#/components/examples/ACOResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorACOExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Avaya Cloud Office management
      summary: Get Avaya Cloud Office
      description: "**This API requires the Account Administrator role.**\n\n   Get an existing Avaya Cloud Office element\
        \ by unique element Id\n"
      operationId: getAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOElement'
              examples:
                ACO:
                  $ref: '#/components/examples/ACOResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Avaya Cloud Office management
      summary: Delete Avaya Cloud Office
      description: "**This API requires the Account Administrator role.**\n\n   Delete an existing Avaya Cloud Office instance\
        \ by unique element Id\n"
      operationId: deleteAco
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/msteams-elements:
    post:
      tags:
      - Microsoft Teams management
      summary: Create MS Teams
      description: "**This API requires the Account Administrator role.**\n\nAdd a new MS Teams element for an Account with\
        \ required data.\n\nOnly one instance of Microsoft Teams element can be created for an account.\n\nThe following field\
        \ must be unique otherwise a `HTTP 409 Conflict` will be returned:\n  * `name`\n\n  Will trigger asynchronous updates,\
        \ the status of which should be monitored via `GET /msteams-elements/{elementId}`.\n"
      operationId: createMSTeams
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        description: Microsoft Teams
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MSTeamsElement'
            examples:
              MSTeams:
                $ref: '#/components/examples/MSTeamsRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MSTeamsElement'
              examples:
                MSTeams:
                  $ref: '#/components/examples/MSTeamsResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorMSTeamsExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/msteams-elements/{elementId}:
    put:
      tags:
      - Microsoft Teams management
      summary: Update MS Teams
      description: "**This API requires the Account Administrator role.**\n\nUpdate existing MS Teams element for an Account\
        \ with required data.\n\n\n  Will trigger asynchronous updates, the status of which should be monitored via `GET /msteams-elements/{elementId}`.\n"
      operationId: updateMSTeams
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      requestBody:
        description: Refer MSTeamsElement model
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MSTeamsElement'
            examples:
              MSTeams:
                $ref: '#/components/examples/MSTeamsRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MSTeamsElement'
              examples:
                MSTeams:
                  $ref: '#/components/examples/MSTeamsResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorMSTeamsExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Microsoft Teams management
      summary: Get MS Teams
      description: '**This API requires the Account Administrator role.**


        Get an existing MS Teams server instance by element Id.

        '
      operationId: getMSTeams
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MSTeamsElement'
              examples:
                MSTeams:
                  $ref: '#/components/examples/MSTeamsResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Microsoft Teams management
      summary: Delete MS Teams
      description: '**This API requires the Account Administrator role.**


        Delete an existing MS Teams server instance by element Id.

        '
      operationId: deleteMSTeams
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/outbound-routing-rules:
    post:
      tags:
      - Outbound Number Routing Rules
      summary: Add Routing Rules
      description: "**This API requires the Account Administrator role.**\n\nThe following field must be unique otherwise\
        \ a `HTTP 409 Conflict` will be returned:\n  * `priority`\n\nCreates Outbound Call Number Routing Rules for mixed\
        \ type of MPC trunks.\n"
      operationId: createOutboundRoutingRule
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OutboundRoutingRule'
            examples:
              OutboundRoutingRules:
                $ref: '#/components/examples/OutboundRoutingRules'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundRoutingRule'
              examples:
                OutboundRoutingRuleResponse:
                  $ref: '#/components/examples/OutboundRoutingRuleResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorOutboundDuplicatePriorityExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - Outbound Number Routing Rules
      summary: Update Bulk Routing Rules
      description: "**This API requires the Account Administrator role.**\n\nThe following field must be unique otherwise\
        \ a `HTTP 409 Conflict` will be returned:\n  * `priority`\n\nUpdates Outbound Call Number Routing Rules for mixed\
        \ type of MPC trunks.\n"
      operationId: bulkUpdateOutboundRoutingRule
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              maxItems: 100
              items:
                $ref: '#/components/schemas/BulkUpdateOutboundRoutingRule'
            example:
            - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
              type: NUMBER_PREFIX
              priority: 4
              prefix: '+1'
              minLength: 1
              maxLength: 50
              sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
              callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
              isoCountry: IN-MH
              locationIds:
              - c8c2909d-75e9-484a-94c0-b7e8d29771fe
            - id: c8c2909d-75e9-484a-94c0-b7e8d29771ff
              type: NUMBER_PREFIX
              priority: 2
              prefix: '+1'
              minLength: 1
              maxLength: 50
              sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771ff
              callerId: c8c2909d-75e9-484a-94c0-b7e8d29771ff
              isoCountry: IN-MH
              locationIds:
              - c8c2909d-75e9-484a-94c0-b7e8d29771fe
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                maxItems: 100
                items:
                  $ref: '#/components/schemas/BulkUpdateOutboundRoutingRule'
              example:
              - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
                type: NUMBER_PREFIX
                priority: 4
                prefix: '+1'
                minLength: 1
                maxLength: 50
                sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
                callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
                isoCountry: IN-MH
                locationIds:
                - c8c2909d-75e9-484a-94c0-b7e8d29771fe
              - id: c8c2909d-75e9-484a-94c0-b7e8d29771ff
                type: NUMBER_PREFIX
                priority: 2
                prefix: '+1'
                minLength: 1
                maxLength: 50
                sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771ff
                callerId: c8c2909d-75e9-484a-94c0-b7e8d29771ff
                isoCountry: IN-MH
                locationIds:
                - c8c2909d-75e9-484a-94c0-b7e8d29771fe
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorOutboundDuplicatePriorityExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Outbound Number Routing Rules
      summary: List Outbound Routing Rules
      description: '**This API requires the Account Administrator role.**


        Get list of outbound routing rules for different SIP trunks.

        '
      operationId: listOutboundRoutingRule
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: The max number of records to retrieve per page. Default value is 5, Any value like 5,10,15,20,25,30 is
          allowed. If value comes more than 100 then max 100 records will be returned.
        required: false
        schema:
          type: integer
          format: int32
          example: 5
          default: 5
          minimum: 1
          maximum: 100
      - name: filter
        in: query
        required: false
        description: "The possible fields you can filter on are type,priority,prefix,minLength,maxLength,callerId,trunkId,isoCountryCode.\
          \ \nThe allowed format:\n- Begins with the field name to be filtered, followed by a colon and:\n  - Either an exact\
          \ string to match, or\n  - A string expression including the * wildcard character\n\nExamples include 'callerId:+35311234567',\
          \ 'isoCountryCode:IN'\n"
        schema:
          type: string
          example: isoCountryCode:IN
          maxLength: 255
      - name: orderBy
        in: query
        required: false
        description: 'The possible fields you can filter on are type,priority,prefix,minLength,maxLength,callerId,trunkId,isoCountryCode.

          Specifies how response data should be sorted.

          Field Names are case-senstive (should be written as it is in description).

          To specify descending order, a suffix " desc" should be added. For example, "priority asc" for ascending or "priority
          desc" for descending".

          The default sorting order is priority ascending.

          '
        schema:
          type: string
          default: priority
          maxLength: 255
        examples:
          orderByPriorityInDescendingOrder:
            value: priority desc
            summary: sort data based on priority in descending order
          orderByPriorityInAscendingOrder:
            value: priority
            summary: sort data based on priority in ascending order
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundRoutingRulePage'
              examples:
                OutboundRoutingRulePageResponse:
                  $ref: '#/components/examples/OutboundRoutingRulePageResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/outbound-routing-rules/{routingRuleId}:
    get:
      tags:
      - Outbound Number Routing Rules
      summary: Get Routing Rule
      description: '**This API requires the Account Administrator role.**


        Get existing single outbound routing rule.

        '
      operationId: getOutboundRoutingRule
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/routingRuleId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundRoutingRule'
              examples:
                default:
                  $ref: '#/components/examples/OutboundRoutingRuleResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - Outbound Number Routing Rules
      summary: Update Routing Rule
      description: '**This API requires the Account Administrator role.**


        Update the existing outbound routing rule.

        '
      operationId: updateOutboundRoutingRule
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/routingRuleId'
      requestBody:
        description: '**This API requires the Account Administrator role.**


          Update existing outbound routing rule for mixed type of MPC trunks.

          '
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOutboundRoutingRule'
            examples:
              OutboundRoutingRules:
                $ref: '#/components/examples/UpdateOutboundRoutingRule'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OutboundRoutingRule'
              examples:
                default:
                  $ref: '#/components/examples/OutboundRoutingRuleResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorOutboundDuplicatePriorityExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Outbound Number Routing Rules
      summary: Delete Routing Rule
      description: '**This API requires the Account Administrator role.**


        Delete the existing outbound routing rule.

        '
      operationId: deleteOutboundRoutingRule
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/routingRuleId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/msteams-sip-trunk-elements/{elementId}:
    get:
      tags:
      - Microsoft Teams SIP Trunks
      summary: Get MS Teams SIP Trunk
      description: '**This API requires the Account Administrator role.**


        Get an existing Microsoft Teams SIP Trunk instance by element Id.

        '
      operationId: getMSTeamsSIPTrunk
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MSTeamsSIPTrunkResponse'
              examples:
                MSTeamsSIPTrunk:
                  $ref: '#/components/examples/MSTeamsSIPTrunkResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/aco-sip-trunk-elements/{elementId}:
    get:
      tags:
      - Avaya Cloud Office SIP Trunks
      summary: Get ACO SIP Trunk
      description: '**This API requires the Account Administrator role.**


        Get an existing Avaya Cloud Office(ACO) SIP Trunk instance by element Id.

        '
      operationId: getACOSIPTrunk
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/elementId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ACOSIPTrunkResponse'
              examples:
                ACOSIPTrunk:
                  $ref: '#/components/examples/ACOSIPTrunkResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/available-phone-numbers:
    get:
      tags:
      - Available Phone Numbers
      summary: List Available Numbers
      description: '**This API requires the Account Administrator role.**


        List available phone numbers

        '
      operationId: listAvailablePhoneNumbers
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: countryCode
        in: query
        description: 'Two letter ISO country code present here "https://www.iban.com/country-codes". Not all code supported
          which are listed here.

          '
        required: true
        schema:
          type: string
          minLength: 2
          maxLength: 2
          pattern: ^[A-Z]{2}$
          example: US
      - $ref: '#/components/parameters/type'
      - name: areaCode
        in: query
        description: Filters list of available numbers based on area code.
        required: false
        schema:
          type: string
          example: '330'
          minLength: 1
          maxLength: 5
      - name: phoneNumber
        in: query
        description: Specifies the desired characters contained within the available numbers to list.
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 15
          example: '+16479308804'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePhoneNumberPage'
              examples:
                PhoneNumbers:
                  $ref: '#/components/examples/AvailablePhoneNumberPage'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/phone-numbers:
    post:
      tags:
      - Phone Number
      summary: Add Number
      description: "**This API requires the Account Administrator role.**\n\n Assign phone number which is available.\n The\
        \ following field must be unique otherwise a `HTTP 409 Conflcit` will be returned:\n* `phoneNumber`\n\n\nWill trigger\
        \ asynchronous updates, the status of which should be monitored via `/phone-numbers/{phoneNumberId}`.\n"
      operationId: addPhoneNumber
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumber'
            examples:
              PhoneNumber:
                $ref: '#/components/examples/PhoneNumberRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumber'
              examples:
                PhoneNumber INPROGRESS Status Response:
                  $ref: '#/components/examples/PhoneNumberInProgressResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorPhoneNumberExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Phone Number
      summary: List Numbers
      description: '**This API requires the Account Administrator role.**


        List phone numbers with accountId

        '
      operationId: searchPhoneNumbers
      parameters:
      - name: accountId
        description: The unique 6 character internal id that represents the customer account
        required: true
        in: path
        schema:
          type: string
          minLength: 1
          maxLength: 6
          example: ABCDEF
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      - name: filter
        in: query
        required: false
        description: "The possible fields you can filter on are phoneNumber, displayName, countryCode, type and status. The\
          \ allowed format:\n- Begins with the field name to be filtered, followed by a colon and:\n  - Either an exact string\
          \ to match, or\n  - A string expression including the * wildcard character\n\nExamples include 'phoneNumber:+35311234567',\
          \ 'countryCode:IN'\n"
        schema:
          type: string
          example: countryCode:IN
          maxLength: 255
          pattern: (([a-zA-Z]+[:=!]+[\*]*[^,*]*[\*]*[,]{0,1}){1}){1,}[^,]$
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The possible fields that can be ordered by are phoneNumber,
          displayName, countryCode, type.

          Field names are case-sensitive (should be written as it is in description).

          The default sorting order is ''phoneNumber ascending''.

          To specify descending order, a suffix '' desc'' should be appended. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          example: phoneNumber
          maxLength: 255
          pattern: ([a-zA-Z]+[,]*|([a-zA-Z]+(( asc)|( desc))[,]*){1,})+(?<!,)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberPage'
              examples:
                PhoneNumbers:
                  $ref: '#/components/examples/PhoneNumberPage'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/phone-numbers/{phoneNumberId}:
    delete:
      tags:
      - Phone Number
      summary: Release Number
      description: '**This API requires the Account Administrator role.**


        Release phone number allows you remove Number from Account

        '
      operationId: releasePhoneNumber
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/phoneNumberId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Phone Number
      summary: Get Number
      description: "**This API requires the Account Administrator role.**\n\n Get assigned phone number\n"
      operationId: getPhoneNumber
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/phoneNumberId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumber'
              examples:
                PhoneNumber INPROGRESS Status Response:
                  $ref: '#/components/examples/PhoneNumberInProgressResponse'
                PhoneNumber FAILED Status Response:
                  $ref: '#/components/examples/PhoneNumberFailedResponse'
                PhoneNumber INACTIVE Status Response:
                  $ref: '#/components/examples/PhoneNumberInActiveResponse'
                PhoneNumber ACTIVE Status Response:
                  $ref: '#/components/examples/PhoneNumberActiveResponse'
                PhoneNumber DISABLED Status Response:
                  $ref: '#/components/examples/PhoneNumberDisabledResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - Phone Number
      summary: Update Number
      description: "**This API requires the Account Administrator role.**\n\nUpdate phone number by using accountId and phoneNumberId.\
        \ The possible field you can update is displayName.\n\nThe following field must be unique otherwise a `HTTP 409 Conflcit`\
        \ will be returned:\n  * `phoneNumber`\n\n\nWill trigger asynchronous updates, the status of which should be monitored\
        \ via `/phone-numbers/{phoneNumberId}`.\n"
      operationId: updatePhoneNumber
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/phoneNumberId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePhoneNumber'
            examples:
              PhoneNumber:
                $ref: '#/components/examples/PhoneNumberUpdateRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumber'
              examples:
                PhoneNumber:
                  $ref: '#/components/examples/PhoneNumberUpdateResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorPhoneNumberExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/phone-numbers:list:
    post:
      tags:
      - Phone Number
      summary: List Phone Numbers
      description: "**This API requires the Account Administrator role.** \n\nIt will accept list of phone number Ids and\
        \ return list of phone number objects which is not DISABLED.\n"
      operationId: listPhoneNumbers
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: orderBy
        in: query
        required: false
        description: 'It Specifies how response data should be sorted.

          Supported fields for orderBy - displayName, phoneNumber.

          Field Names are case-senstive (should be written as it is in description).

          To specify descending order, a suffix " desc" should be added. For example, "displayName asc" for ascending or "displayName
          desc" for descending".

          The default sorting order is displayName ascending when no orderBy param will be passed.

          '
        schema:
          type: string
          default: displayName
          maxLength: 255
        examples:
          orderByDisplayNameInDescendingOrder:
            value: displayName desc
            summary: sort data based on displayName in descending order
          orderByDisplayNameInAscendingOrder:
            value: displayName
            summary: sort data based on displayName in ascending order
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumberListRequest'
            examples:
              PhoneNumberListRequest:
                $ref: '#/components/examples/PhoneNumberListRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberListResponse'
              examples:
                PhoneNumberListResponse:
                  $ref: '#/components/examples/PhoneNumberListResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/phone-numbers:validate:
    post:
      tags:
      - Phone Number
      summary: Validate Phone Numbers
      description: "**This API requires the Account Administrator role.** \n\nIt will accept list of phone number Ids and\
        \ return list of Invalid Phone Number Ids with message\n"
      operationId: validatePhoneNumbers
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumberValidateRequest'
            examples:
              PhoneNumberValidateRequest:
                $ref: '#/components/examples/PhoneNumberValidateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberValidateResponse'
              examples:
                PhoneNumberValidateResponse:
                  $ref: '#/components/examples/PhoneNumberValidateResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/phone-numbers:getByPhoneNumbers:
    post:
      tags:
      - Phone Number
      summary: Get Phone Number Details by phone numbers
      description: "**This API requires the Account Administrator role.** \n\nIt will accept list of phone numbers and return\
        \ list of phone number objects.\n"
      operationId: getByPhoneNumbers
      parameters:
      - name: accountId
        description: The unique 6 character internal id that represents the customer account
        required: true
        in: path
        schema:
          type: string
          minLength: 1
          maxLength: 6
          example: ABCDEF
      - name: filter
        in: query
        required: false
        description: 'filter can be passed to specify accountId. This can be used in the case where system admin persona will
          use this api with * as accountId for URI Parameter and want to query phone number from a specific Tenant.

          '
        schema:
          type: string
          maxLength: 255
        examples:
          filterByAccountId:
            value: accountId=ABCDEF
            summary: filter the Phone Number by passing account Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PhoneNumbersDetailsRequest'
            examples:
              PhoneNumbersDetailsRequest:
                $ref: '#/components/examples/PhoneNumbersDetailsRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberListResponse'
              examples:
                PhoneNumberListResponse:
                  $ref: '#/components/examples/PhoneNumberListResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/countries:
    get:
      tags:
      - Country
      summary: List Available Countries
      description: '**This API requires the Account Administrator role.**


        Shows available countries information for specific phone number type.

        '
      operationId: getAvailableCountries
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/type'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Countries'
              examples:
                Countries:
                  $ref: '#/components/examples/AvailableCountries'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers:
    post:
      tags:
      - Communication Manager
      summary: Creates a CM server
      description: '**This API requires the Account Administrator role.**


        Creates a Communication Manager for specified account

        '
      operationId: createCommunicationManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommunicationManager'
            examples:
              default:
                $ref: '#/components/examples/CommunicationManagerRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/CommunicationManagerAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Communication Manager
      summary: Lists all CM servers
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Communication Manager servers by account id

        '
      operationId: getAllCommunicationManagers
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: The maximum number of records to retrieve per page. Default value is 10 and maximum 10 records will be
          retrieved.
        required: false
        schema:
          type: integer
          format: int32
          example: 5
          default: 10
          minimum: 5
          maximum: 50
      - name: filter
        in: query
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
          The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an\
          \ exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will\
          \ be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will\
          \ be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be\
          \ used to match exact string)\n"
        required: false
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=CM1420
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:CM1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*CM1420
      - name: orderBy
        in: query
        required: false
        description: "Field name on which ordering needs to be performed. The default order is ascending.\n\nThe possible\
          \ fields that can be ordered on are:\n  * name\n\nField Names are case-senstive (should be written as it is in description).\n\
          \nTo specify descending order, a suffix \" desc\" should be added. For example, \"name\" for ascending or \"name\
          \ desc\" for descending\".\n"
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationManagerPage'
              examples:
                default:
                  $ref: '#/components/examples/CommunicationManagerPageResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}:
    put:
      tags:
      - Communication Manager
      summary: Updates a CM server
      description: '**This API requires the Account Administrator role.**


        Updates an existing Communication Manager server with cm id by accound id

        '
      operationId: updateCommunicationManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommunicationManager'
            examples:
              default:
                $ref: '#/components/examples/CommunicationManagerRequest'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/CommunicationManagerAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Communication Manager
      summary: Gets details of a CM server
      description: '**This API requires the Account Administrator role.**


        Returns the details of Communication Manager, based on the specified cm id and account id

        '
      operationId: getCommunicationManagerById
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunicationManagerResponse'
              examples:
                default:
                  $ref: '#/components/examples/CommunicationManagerResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Communication Manager
      summary: Deletes a CM server
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Communication Manager server identified by cm id

        '
      operationId: deleteCommunicationManagerById
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/CommunicationManagerAsyncResponse'
        '204':
          description: No content
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/voice-plans:
    get:
      tags:
      - Voice Plan
      summary: List Voice Plans
      description: '**This API requires the Account Administrator role.**


        Lists all of the Voice Plans configured in the Communication Manager server for an account.

        '
      operationId: getVoicePlans
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: 'The max number of records to retrieve per page. Default value is 10.

          '
        required: false
        schema:
          type: integer
          format: int32
          example: 5
          default: 10
          minimum: 5
          maximum: 50
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\nThe possible fields that can be filtered on are:\n* name\n* type\n\
          * status\n* userProfileId\n\nThe allowed format:\n  - Begins with the column name to be filtered, followed by a\
          \ colon, then:\n    - Either an exact string to match, or\n    - A string expression including the * wildcard character\n\
          \      - :{PREFIX}* will be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word\
          \ end with\n      - : will be used to match exact word\n  - Begin with column name to be filtered, followed by a\
          \ = operator. (this will be used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=Voice Plan
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:Voice*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*Plan
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).

          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending.

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoicePlanPage'
              examples:
                default:
                  $ref: '#/components/examples/VoicePlanPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Voice Plan
      summary: Create voice plan
      description: '**This API requires the Account Administrator role.**


        Create voice plan for specified account id and communication manager server id

        '
      operationId: createVoicePlan
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoicePlan'
            examples:
              System Range:
                $ref: '#/components/examples/SystemRangeRequest'
              User Voice Plan:
                $ref: '#/components/examples/UserVoicePlanRequest'
        description: Voice plan with properties which needs to be created
        required: true
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoicePlan'
              examples:
                System Range:
                  $ref: '#/components/examples/SystemRangeResponse'
                User Voice Plan:
                  $ref: '#/components/examples/UserVoicePlanResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/voice-plans/{voicePlanId}:
    put:
      tags:
      - Voice Plan
      summary: Update voice plan
      description: '**This API requires the Account Administrator role.**


        Update voice plan for specified account id, communication manager server id and voice plan id

        '
      operationId: updateVoicePlan
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/voicePlanId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoicePlan'
            examples:
              System Range:
                $ref: '#/components/examples/SystemRangeRequest'
              User Voice Plan:
                $ref: '#/components/examples/UserVoicePlanRequest'
        description: Voice plan with properties which needs to be updated
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoicePlan'
              examples:
                System Range:
                  $ref: '#/components/examples/SystemRangeResponse'
                User Voice Plan:
                  $ref: '#/components/examples/UserVoicePlanResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Voice Plan
      summary: Get voice plan
      description: '**This API requires the Account Administrator role.**


        Get voice plan for specified account id, communication manager server id and voice plan id

        '
      operationId: getVoicePlan
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/voicePlanId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoicePlan'
              examples:
                System Range:
                  $ref: '#/components/examples/SystemRangeResponse'
                User Voice Plan:
                  $ref: '#/components/examples/UserVoicePlanResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Voice Plan
      summary: Delete voice plan
      description: '**This API requires the Account Administrator role.**


        Delete mentioned voice plan for specified account id, communication manager server id and voice plan id

        '
      operationId: deleteVoicePlan
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/voicePlanId'
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/voice-numbers:export:
    get:
      tags:
      - Voice Numbers And Extensions
      summary: Export Numbers
      description: "**This API requires the Account Administrator role.**\n\n APIs to export the Voice Numbers, Agent Extensions\
        \ and Extension and its associated fields in a CSV file.\n Account Administrator can provide PHONE_NUMBER,USER_EXTENSION\
        \ and EXTENSION separated by comma.\n"
      operationId: exportNumbersAndExtensions
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: numberType
        in: query
        description: The optional number type to query. TA can both options like PHONE_NUMBER,EXTENSION
        required: true
        schema:
          type: string
          enum:
          - PHONE_NUMBER
          - USER_EXTENSION
          - EXTENSION
          readOnly: true
          example: PHONE_NUMBER
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
                format: binary
              example: 'First Name,Last Name,Email,ExtensionNumber,DirectNumber

                firstName,lastname,username@default.com,extensionNumber,didNumber

                '
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/hybrid-cloud-gateways:
    post:
      tags:
      - Hybrid Cloud Gateway
      summary: Creates an HCG server
      description: '**This API requires the Account Administrator role.**


        Creates an Avaya Hybrid Cloud Gateway for specified account

        '
      operationId: createHybridCloudGateway
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridCloudGateway'
            examples:
              default:
                $ref: '#/components/examples/HybridCloudGatewayRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaHybridCloudGatewayAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Hybrid Cloud Gateway
      summary: Lists all HCG servers
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Avaya Hybrid Cloud Gateways by account Id

        '
      operationId: getAllHybridCloudGateways
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
          The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an\
          \ exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will\
          \ be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will\
          \ be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be\
          \ used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=AHCG123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:AHCG1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*AHCG
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridCloudGateways'
              examples:
                default:
                  $ref: '#/components/examples/HybridCloudGateways'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/hybrid-cloud-gateways/{hybridCloudGatewayId}:
    put:
      tags:
      - Hybrid Cloud Gateway
      summary: Updates an HCG server
      description: '**This API requires the Account Administrator role.**


        Updates an existing Avaya Hybrid Cloud Gateway with Avaya Hybrid Cloud Gateway id by account id

        '
      operationId: updateHybridCloudGateway
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/hybridCloudGatewayId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHybridCloudGatewayRequest'
            examples:
              default:
                $ref: '#/components/examples/UpdateHybridCloudGatewayRequest'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaHybridCloudGatewayAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Hybrid Cloud Gateway
      summary: Details of an HCG server
      description: '**This API requires the Account Administrator role.**


        Returns the details of an Avaya Hybrid Cloud Gateway, based on Avaya Hybrid Cloud Gateway id and account id

        '
      operationId: getHybridCloudGateway
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/hybridCloudGatewayId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridCloudGatewayResponse'
              examples:
                default:
                  $ref: '#/components/examples/HybridCloudGateway'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Hybrid Cloud Gateway
      summary: Deletes an HCG server
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Avaya Hybrid Cloud Gateway identified by Avaya Hybrid Cloud Gateway id.

        '
      operationId: deleteHybridCloudGateway
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/hybridCloudGatewayId'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/AvayaHybridCloudGatewayAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/hybrid-cloud-gateway-systems/{systemId}:pushConfig:
    post:
      tags:
      - Hybrid Cloud Gateway
      summary: Re-initiate HCG Config push
      description: '**This API requires the Account Administrator role.**


        This API is used to re-initiate HCG Configuration push from AXP Cloud to Hybrid Cloud Manager

        '
      operationId: pushConfig
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/systemId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridCloudGatewaySystemResponse'
              examples:
                default:
                  $ref: '#/components/examples/HybridCloudGatewaySystemResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/hybrid-cloud-gateway-systems/{systemId}:
    put:
      tags:
      - Hybrid Cloud Gateway
      summary: Update existing HCG config
      description: '**This API requires the Account Administrator role.**


        This API is used to update any property of an existing Avaya Hybrid Cloud Gateway against system id

        '
      operationId: updateHCGConfigBySystemId
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/systemId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHybridCloudGatewaySystemConfig'
            examples:
              default:
                $ref: '#/components/examples/UpdateHybridCloudGatewaySystemConfig'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridCloudGatewaySystemResponse'
              examples:
                default:
                  $ref: '#/components/examples/HybridCloudGatewaySystemResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/system-managers:
    post:
      tags:
      - System Manager
      summary: Creates an System Manager
      description: '**This API requires the Account Administrator role.**


        Creates an System Manager for specified account

        '
      operationId: createSystemManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemManager'
            examples:
              default:
                $ref: '#/components/examples/SystemManagerRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/SystemManagerAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - System Manager
      summary: List all System Managers
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available System Managers by account Id

        '
      operationId: getAllSystemManagers
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
          The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an\
          \ exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will\
          \ be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will\
          \ be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be\
          \ used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=SMGR123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:SMGR1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*SMGR
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemManagers'
              examples:
                default:
                  $ref: '#/components/examples/SystemManagers'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/system-managers/{systemManagerId}:
    put:
      tags:
      - System Manager
      summary: Updates a System Manager
      description: '**This API requires the Account Administrator role.**


        Updates an existing System Manager with System Manager id by account id

        '
      operationId: updateSystemManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/systemManagerId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSystemManager'
            examples:
              default:
                $ref: '#/components/examples/UpdateSystemManagerRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/SystemManagerAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - System Manager
      summary: Details of a System Manager
      description: '**This API requires the Account Administrator role.**


        Returns the details of an System Manager, based on System Manager id and account id

        '
      operationId: getSystemManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/systemManagerId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemManagerResponse'
              examples:
                default:
                  $ref: '#/components/examples/SystemManagerResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - System Manager
      summary: Deletes a System Manager
      description: '**This API requires the Account Administrator role.**


        Deletes an existing System Manager identified by System Manager id.

        '
      operationId: deleteSystemManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/systemManagerId'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/SystemManagerAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/hybrid-cloud-manager:
    get:
      tags:
      - Hybrid Cloud Manager
      summary: Hybrid Cloud Manager
      description: 'This API is used to get Hybrid Cloud Manager details.

        '
      operationId: getHybridCloudManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridCloudManager'
              examples:
                default:
                  $ref: '#/components/examples/HybridCloudManagerResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/gateway-connection-manager:
    get:
      tags:
      - Gateway Connection Manager
      summary: Get Gateway Connection Manager server details
      description: '**This API requires the Account Administrator role.**


        Returns the details of Gateway Connection Manager for specified account

        '
      operationId: getGatewayConnectionManager
      parameters:
      - $ref: '#/components/parameters/accountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GatewayConnectionManager'
              examples:
                default:
                  $ref: '#/components/examples/GatewayConnectionManagerResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/reason-codes:
    get:
      tags:
      - Reason Codes
      summary: List Reason Codes
      description: '**This API requires the Account Administrator role.**


        Returns list of Reason Codes based on the specified filtering criteria. If no filtering criteria is specified, this
        call returns list of all Reason Codes.

        '
      operationId: listReasonCodes
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - name: codeType
        in: query
        description: The mandatory type of the codes to query.
        required: true
        schema:
          type: string
          enum:
          - NOT_READY
          - LOGOUT
          - CALL_WORK_CODE
          example: NOT_READY
      - name: codeName
        in: query
        description: The optional name of the code to query.
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 255
          example: Lunch
      - name: codeNumber
        in: query
        description: The optional number of the code to query.
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 16
          example: '75'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: 'The maximum number of results per page. Default value is 10, max value is 100.

          '
        required: false
        schema:
          type: integer
          format: int32
          example: 10
          default: 10
          minimum: 1
          maximum: 100
      - name: orderBy
        in: query
        required: false
        description: 'Specifies how response data should be sorted. Only codeName and codeNumber are valid options.

          Field Names are case-senstive (should be written as it is in description).

          To specify descending order, a suffix " desc" should be added. For example, "codeName asc" for ascending or "codeName
          desc" for descending".

          The default sorting order is codeName ascending.

          '
        schema:
          type: string
          default: codeName
          maxLength: 260
        examples:
          orderByCodeNameInDescendingOrder:
            value: codeName desc
            summary: sort data based on codeName in descending order
          orderByCodeNameInAscendingOrder:
            value: codeName
            summary: sort data based on codeName in ascending order
          orderByCodeNumberInDescendingOrder:
            value: codeNumber desc
            summary: sort data based on codeNumber in descending order
          orderByCodeNumberInAscendingOrder:
            value: codeNumber
            summary: sort data based on codeNumber in ascending order
          orderByCodeTypeInDescendingOrder:
            value: codeType desc
            summary: sort data based on codeType in descending order
          orderByCodeTypeInAscendingOrder:
            value: codeType
            summary: sort data based on codeType in ascending order
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReasonCodePage'
              examples:
                default:
                  $ref: '#/components/examples/ReasonCodePageResponse'
        '400':
          description: Constraint violation for accountId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Reason Codes
      summary: Create Reason Code
      description: '**This API requires the Account Administrator role.**


        Creates a new Reason Code that can then be selected by agents in a agent desktop client. Reason codes can be of type
        ''NOT_READY'', ''LOGOUT'' or ''CALL_WORK_CODE''. ''NOT_READY'' is used to indicate the reason the agent has went not
        ready (will not receive any new Engagements).

        '
      operationId: createReasonCode
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReasonCode'
            examples:
              Not Ready Reason Code:
                $ref: '#/components/examples/NotReadyCreateRequest'
              Logout Reason Code:
                $ref: '#/components/examples/LogoutCreateRequest'
              Call Work Code:
                $ref: '#/components/examples/CallWorkCodeCreateRequest'
        description: Reason Code
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/ReasonCodeAsyncResponse'
        '400':
          description: Constraint violation while creating Reason Code
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/reason-codes/{reasonCodeId}:
    put:
      tags:
      - Reason Codes
      summary: Update Reason Code
      description: '**This API requires the Account Administrator role.**


        "Update an existing Reason Code name, description and/or other properties."

        '
      operationId: updateReasonCode
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/reasonCodeId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReasonCode'
            examples:
              Not Ready Reason Code:
                $ref: '#/components/examples/NotReadyUpdateRequest'
              Logout Reason Code:
                $ref: '#/components/examples/LogoutUpdateRequest'
              Call Work Code:
                $ref: '#/components/examples/CallWorkCodeUpdateRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/ReasonCodeAsyncResponse'
        '400':
          description: Constraint violation for accountId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Reason Codes
      summary: Details of a Reason Code.
      description: '**This API requires the Account Administrator role.**


        Gets a Reason Code by its unique reasonCodeId.

        '
      operationId: getReasonCode
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/reasonCodeId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReasonCodeResponse'
              examples:
                default:
                  $ref: '#/components/examples/ReasonCodeResponse'
        '204':
          description: No content
        '400':
          description: Constraint violation for reasonCodeId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Reason Codes
      summary: Delete Reason Code
      description: '**This API requires the Account Administrator role.**


        Deletes a Reason Code by ID.

        '
      operationId: deleteReasonCode
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/reasonCodeId'
      responses:
        '202':
          description: Accepted
        '400':
          description: Constraint violation for reasonCodeId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}:sync:
    post:
      tags:
      - Sync Aura Entities
      summary: Trigger sync
      description: '**This API requires the Account Administrator role.**

        Initiate synchronization of Aura entities from specified Communication Manager.

        '
      operationId: initiateSync
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuraSyncRequest'
            examples:
              default:
                $ref: '#/components/examples/AuraSyncRequest'
        description: Synchronization specification for Aura entities.
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuraSyncResponse'
              examples:
                default:
                  $ref: '#/components/examples/AuraSyncResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/extensions:
    get:
      tags:
      - Extension
      summary: Get Extensions
      description: '**This API requires the Account Administrator role.**


        Get list of Extensions belongs to specific account.

        '
      operationId: getExtensions
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      - name: filter
        in: query
        required: false
        description: "The possible fields you can filter on are number and displayName. The allowed format:\n- Begins with\
          \ the field name to be filtered, followed by a colon and:\n  - Either an exact string to match, or\n  - A string\
          \ expression including the * wildcard character\nExamples include 'number:35311234567', 'displayName:John'\n"
        schema:
          type: string
          example: displayName:john
          maxLength: 255
          pattern: (([a-zA-Z]+[:=]+[\*]*[^,*]*[\*]*[,]{0,1}){1}){1,}[^,]$
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The possible fields that can be ordered by are number
          and displayName.

          Field names are case-senstive (should be written as it is in description).

          The default sorting order is ''number ascending''.

          To specify descending order, a suffix '' desc'' should be appended. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          example: displayName
          maxLength: 255
          pattern: ([a-zA-Z]+[,]*|([a-zA-Z]+(( asc)|( desc))[,]*){1,})+(?<!,)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionNumberPage'
              examples:
                Extensions:
                  $ref: '#/components/examples/ExtensionNumberPage'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      tags:
      - Extension
      summary: Create Extension
      description: '**This API requires the Account Administrator role.**


        Creates a new Extension for specified account

        '
      operationId: createExtension
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Extension'
            examples:
              Extension:
                $ref: '#/components/examples/ExtensionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
              examples:
                default:
                  $ref: '#/components/examples/ExtensionResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorExtensionExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/extensions/{extensionId}:
    get:
      tags:
      - Extension
      summary: Get Extension
      description: '**This API requires the Account Administrator role.**

        '
      operationId: getExtension
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/extensionId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
              examples:
                default:
                  $ref: '#/components/examples/ExtensionResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    put:
      tags:
      - Extension
      summary: Update Extension
      description: '**This API requires the Account Administrator role.**

        '
      operationId: updateExtension
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/extensionId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Extension'
            examples:
              default:
                $ref: '#/components/examples/ExtensionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Extension'
              examples:
                default:
                  $ref: '#/components/examples/ExtensionResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ErrorExtensionExists'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Extension
      summary: Delete Extension
      description: '**This API requires the Account Administrator role.**

        '
      operationId: extensionDelete
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/extensionId'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/extensions:
    get:
      tags:
      - Hybrid Extension
      summary: Get Extensions
      description: '**This API requires the Account Administrator role.**


        Get list of Extensions belongs to specific account and communication manager.

        '
      operationId: listExtensions
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: 'The maximum number of results per page. Default value is 10, max value is 100.

          '
        required: false
        schema:
          type: integer
          format: int32
          example: 10
          default: 10
          minimum: 1
          maximum: 100
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter. Only name and number columns are allowed.\n- Field Names are case-senstive\
          \ (should be written as it is in description).\n- The allowed format begins with the column name, A string expression\
          \ including the * wildcard character.\n    - :{PREFIX}* will be used to find out word start with.\n    - :*{POSTFIX}\
          \ will be used to find out word end with\n    - :{string} will be used to find out word that contains given value.\n\
          \    - :{number} will be used to find out number that equal to given value.\n"
        schema:
          type: string
          maxLength: 255
        examples:
          filterByNameStartsWith:
            value: name:extension*
            summary: filter result by name starts with name value
          filterByNameEndsWith:
            value: name:*extension
            summary: filter result by name ends with name value
          filterByNameContainsToUsingColon:
            value: name:extension
            summary: 'filter result by name equals to value using : operator'
          filterByNumberEqualsToUsingColon:
            value: number:10
            summary: 'filter result by number equals to value using : operator'
      - name: orderBy
        in: query
        required: false
        description: 'Specifies details of a filter. Only name and number columns are allowed.

          - Field Names are case-senstive (should be written as it is in description).

          - The default sorting order is ascending.

          - The default order by is number.

          '
        schema:
          type: string
          maxLength: 255
        examples:
          orderByNameInDescendingOrder:
            value: name desc
            summary: sort data based on name in descending order
          orderByNameInAscendingOrder:
            value: name
            summary: sort data based on name in ascending order
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtensionPage'
              examples:
                default:
                  $ref: '#/components/examples/ExtensionPage'
        '400':
          description: Constraint violation for accountId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/extensions/{extensionId}:
    delete:
      tags:
      - Hybrid Extension
      summary: Delete Extension
      description: '**This API requires the Account Administrator role.**


        Deletes a extension by Id.

        '
      operationId: deleteExtension
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/extensionId'
      responses:
        '202':
          description: Accepted
        '400':
          description: Constraint violation for extensionId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/jobs/{jobId}:
    get:
      tags:
      - Comm Manager Job Details
      summary: Get a single job
      description: '**This API requires the Account Administrator role.**


        Gets a single job by its job id.

        '
      operationId: getJob
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/jobId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
              examples:
                default:
                  $ref: '#/components/examples/JobResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/jobs/{jobId}:details:
    get:
      tags:
      - Comm Manager Job Details
      summary: Get details of a single job
      description: '**This API requires the Account Administrator role.**


        Gets details of a single job by its job id.

        '
      operationId: getJobDetails
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/jobId'
      - name: entityType
        in: query
        description: The optional entity type to query
        required: false
        schema:
          type: string
          enum:
          - AGENT
          - EXTENSION
          - REASONCODE_AUX
          - SYSTEM_PARAMETER_FEATURES
          example: AGENT
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDetails'
              examples:
                default:
                  $ref: '#/components/examples/JobDetailsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/jobs/{jobId}:entity-details:
    get:
      tags:
      - Comm Manager Job Details
      summary: Get entity details of a job
      description: '**This API requires the Account Administrator role.**


        Gets details of a sync entity by its job id.

        '
      operationId: getEntityDetails
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/jobId'
      - name: entityType
        in: query
        description: The optional entity type to query
        required: true
        schema:
          type: string
          enum:
          - AGENT
          - EXTENSION
          - REASONCODE_AUX
          - SYSTEM_PARAMETER_FEATURES
          example: AGENT
      - name: statusCode
        in: query
        description: The optional job status code to query
        required: false
        schema:
          type: string
          enum:
          - IN_PROGRESS
          - COMPLETED
          - FAILED
          - CREATED
          - UPDATED
          - DELETED
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - DELETE_IN_PROGRESS
          - NEEDS_ACTION
          example: COMPLETED
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n The possible fields that can be filtered on are:\n  * Name\n  *\
          \ Number\n  * StatusCode\nField Names are case-senstive (should be written as it is in description).\nThe allowed\
          \ format:\n  - Begins with the column name to be filtered, followed by a colon will be used to find out word that\
          \ contains given value.\n"
        schema:
          type: string
          maxLength: 255
        examples:
          contains:
            description: Example of filtering based on an contains string.
            value: Name:dummyName
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: The maximum number of results per page. Default value is 10, max value is 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 10
          default: 10
          minimum: 1
          maximum: 100
      - name: orderBy
        in: query
        required: false
        description: 'Specifies how response data should be sorted. createdAt and updatedAt are valid options.

          Field Names are case-senstive (should be written as it is in description).

          To specify descending order, a suffix " desc" should be added. For example, "createdAt" for ascending or "createdAt
          desc" for descending".

          The default sorting order is createdAt ascending.

          '
        schema:
          type: string
          default: createdAt desc
          maxLength: 255
        examples:
          orderByCreatedAtInAscendingOrder:
            value: createdAt
            summary: sort data based on createdAt in ascending order
          orderByCreatedAtInDescendingOrder:
            value: createdAt desc
            summary: sort data based on createdAt in descending order
          orderByUpdatedAtInAscendingOrder:
            value: updatedAt
            summary: sort data based on updatedAt in ascending order
          orderByUpdatedAtInDescendingOrder:
            value: updatedAt desc
            summary: sort data based on updatedAt in descending order
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncEntityDetailsPage'
              examples:
                default:
                  $ref: '#/components/examples/SyncEntityDetailsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/jobs:
    get:
      tags:
      - Comm Manager Job Details
      summary: Lists all the jobs
      description: '**This API requires the Account Administrator role.**


        Lists all the jobs for the specified Communication Manager.

        '
      operationId: listJobs
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - name: name
        in: query
        description: "The optional name of the job to query.\nThe allowed format:\n  - Begins with the column name to be filtered,\
          \ followed by a colon, then:\n      - Either an exact string to match, or\n      - A string expression including\
          \ the * wildcard character\n        - :{PREFIX}* will be used to find out word start with.\n        - :*{POSTFIX}\
          \ will be used to find out word end with\n        - : will be used to match exact word\n - Begin with column name\
          \ to be filtered, followed by a = operator. (this will be used to match exact string)\n"
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=FullSync_SYNC_Sat Mar 18 16:20:46 GMT 2023
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:FullSync_SYNC_Sat*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*GMT 2024
      - name: statusCode
        in: query
        description: The optional job status code to query
        required: false
        schema:
          type: string
          enum:
          - QUEUED
          - IN_PROGRESS
          - COMPLETED
          - TIMEOUT_FAILED
          - FAILED
          - NEEDS_ACTION
          example: FAILED
      - name: type
        in: query
        description: The optional type of job to query
        required: false
        schema:
          type: string
          enum:
          - SYNC
          - INCREMENTAL_SYNC
          example: SYNC
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: The maximum number of results per page. Default value is 10, max value is 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 10
          default: 10
          minimum: 1
          maximum: 100
      - name: orderBy
        in: query
        required: false
        description: 'Specifies how response data should be sorted. name, type, statusCode, createdAt and updatedAt are valid
          options.

          Field Names are case-senstive (should be written as it is in description).

          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          The default sorting order is name ascending.

          '
        schema:
          type: string
          default: createdAt desc
          maxLength: 255
        examples:
          orderByNameInAscendingOrder:
            value: name
            summary: sort data based on name in ascending order
          orderByNameInDescendingOrder:
            value: name desc
            summary: sort data based on name in descending order
          orderByTypeInAscendingOrder:
            value: type
            summary: sort data based on type in ascending order
          orderByTypeInDescendingOrder:
            value: type desc
            summary: sort data based on type in descending order
          orderByStatusCodeInAscendingOrder:
            value: statusCode
            summary: sort data based on statusCode in ascending order
          orderByStatusCodeInDescendingOrder:
            value: statusCode desc
            summary: sort data based on statusCode in descending order
          orderByCreatedAtInAscendingOrder:
            value: createdAt
            summary: sort data based on createdAt in ascending order
          orderByCreatedAtInDescendingOrder:
            value: createdAt desc
            summary: sort data based on createdAt in descending order
          orderByUpdatedAtInAscendingOrder:
            value: updatedAt
            summary: sort data based on updatedAt in ascending order
          orderByUpdatedAtInDescendingOrder:
            value: updatedAt desc
            summary: sort data based on updatedAt in descending order
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobPage'
              examples:
                default:
                  $ref: '#/components/examples/JobPageResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/jobs/{jobId}:abort:
    post:
      tags:
      - Comm Manager Job Details
      summary: Abort sync job execution
      description: '**This API requires the Account Administrator role.**


        Abort execution of a job by its job id.

        '
      operationId: abortJob
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/jobId'
      responses:
        '202':
          description: Accepted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/location-profiles:
    post:
      tags:
      - Location Profile
      summary: Create Location profile
      description: '**This API requires the Account Administrator role.**


        Creates an Location profile for specified account

        '
      operationId: createLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationProfile'
            examples:
              default:
                $ref: '#/components/examples/LocationProfileRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Location Profile
      summary: List all Location Profiles
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Location Profile by account Id

        '
      operationId: getAllLocationProfiles
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
          The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an\
          \ exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will\
          \ be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will\
          \ be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be\
          \ used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=AHCG123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:AHCG1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*AHCG
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationProfiles'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfiles'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/location-profiles/{locationProfileId}:
    put:
      tags:
      - Location Profile
      summary: Update Location Profile
      description: '**This API requires the Account Administrator role.**


        Updates an existing Location Profile with Location Profile id by account id

        '
      operationId: updateLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationProfileId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocationProfile'
            examples:
              default:
                $ref: '#/components/examples/LocationProfileRequest'
        required: true
      responses:
        '202':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Location Profile
      summary: Get Location Profile
      description: '**This API requires the Account Administrator role.**


        Returns the details of an Location Profile, based on Location Profile id and account id

        '
      operationId: getLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationProfileId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocationProfile'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Location Profile
      summary: Delete Location Profile
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Location Profile identified by Location Profile id.

        '
      operationId: deleteLocationProfile
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationProfileId'
      - $ref: '#/components/parameters/forceDelete'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsynchronousOperationResponse'
              examples:
                default:
                  $ref: '#/components/examples/LocationProfileAsyncResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/agent-locations:
    post:
      tags:
      - Agent Location
      summary: Create Agent Location
      description: '**This API requires the Account Administrator role.**


        Creates an Agent Location for a specified account

        '
      operationId: createAgentLocation
      parameters:
      - $ref: '#/components/parameters/accountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentLocation'
            examples:
              default:
                $ref: '#/components/examples/AgentLocationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentLocation'
              examples:
                default:
                  $ref: '#/components/examples/AgentLocationResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Agent Location
      summary: List all Agent Locations
      description: '**This API requires the Account Administrator role.**


        Returns all the Agent Locations present in the account.

        '
      operationId: getAllAgentLocations
      parameters:
      - $ref: '#/components/parameters/accountId'
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
          The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an\
          \ exact string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will\
          \ be used to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will\
          \ be used to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be\
          \ used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=AHCG123
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:AHCG1*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*AHCG
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAgentLocations'
              examples:
                default:
                  $ref: '#/components/examples/AgentLocations'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/agent-locations/{locationId}:
    put:
      tags:
      - Agent Location
      summary: Update Agent Location
      description: '**This API requires the Account Administrator role.**


        Update an existing Agent Location by Id

        '
      operationId: updateAgentLocation
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgentLocation'
            examples:
              default:
                $ref: '#/components/examples/AgentLocationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentLocation'
              examples:
                default:
                  $ref: '#/components/examples/AgentLocationResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Agent Location
      summary: Get Agent Location
      description: '**This API requires the Account Administrator role.**


        Returns the details of an Agent Location, based on Location Id and account Id

        '
      operationId: getAgentLocation
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentLocation'
              examples:
                default:
                  $ref: '#/components/examples/AgentLocationResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Agent Location
      summary: Delete Agent Location
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Agent Location by Location Id and account Id

        '
      operationId: deleteAgentLocation
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/locationId'
      - $ref: '#/components/parameters/forceDelete'
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/sip-trunks:
    get:
      tags:
      - SIP Trunks
      summary: Get List Of SIP Trunks
      description: '**This API requires the Account Administrator role.**


        Get an All SIP Trunks associated with Account Administrator.

        '
      operationId: getSipTrunks
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/pageNumber'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunkPage'
              examples:
                SipTrunkPageResponse:
                  $ref: '#/components/examples/SipTrunkPageResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/sip-trunks/{sipTrunkId}:
    put:
      tags:
      - SIP Trunks
      summary: Update SIP Trunk Caller ID
      description: '**This API requires the Account Administrator role.**


        Update an SIP Trunks Caller ID associated with Account Administrator.

        '
      operationId: UpdateSipTrunk
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/sipTrunkId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipTrunk'
            examples:
              SipTrunkUpdateRequest:
                $ref: '#/components/examples/SipTrunkUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipTrunk'
              examples:
                SipTrunkUpdateResponse:
                  $ref: '#/components/examples/SipTrunkUpdateResponse'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/skills:
    post:
      tags:
      - Hybrid Skill
      summary: Create Hybrid Skill
      description: '**This API requires the Account Administrator role.**


        Create a skill for specified account id and communication manager server id

        '
      operationId: createSkill
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHybridSkill'
            examples:
              default:
                $ref: '#/components/examples/HybridSkillRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                Skill:
                  $ref: '#/components/examples/HybridSkillResponse'
        '207':
          description: Partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                Skill:
                  $ref: '#/components/examples/HybridSkillResponsePartial'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Hybrid Skill
      summary: List Hybrid Skills
      description: '**This API requires the Account Administrator role.**


        Returns the list of all available Skills by account Id and communication manager Id

        '
      operationId: getAllSkills
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/pageNumber'
      - name: pageSize
        in: query
        description: 'The max number of records to retrieve per page. Default value is 10.

          '
        required: false
        schema:
          type: integer
          format: int32
          example: 5
          default: 10
          minimum: 5
          maximum: 50
      - name: filter
        in: query
        required: false
        description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\
          \  * number\n  * extension\n\n\nThe allowed format:\n  - Begins with the column name to be filtered, followed by\
          \ a colon, then:\n    - Either an exact string to match, or\n    - A string expression including the * wildcard\
          \ character\n      - :{PREFIX}* will be used to find out word start with.\n      - :*{POSTFIX} will be used to find\
          \ out word end with\n      - : will be used to match exact word\n  - Begin with column name to be filtered, followed\
          \ by a = operator. (this will be used to match exact string)\n"
        schema:
          type: string
          maxLength: 255
        examples:
          exact:
            description: Example of filtering based on an exact string.
            value: name=French
          prefix:
            description: Example of filtering based on a prefix string.
            value: name:French*
          postfix:
            description: Example of filtering based on a postfix string.
            value: name:*French
      - name: orderBy
        in: query
        required: false
        description: 'Field name on which ordering needs to be performed. The default order is ascending.


          The possible fields that can be ordered on are:

          * name

          * number

          * extension


          Field Names are case-senstive (should be written as it is in description).


          To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc"
          for descending".

          '
        schema:
          type: string
          default: name
          maxLength: 255
        examples:
          ascending:
            value: name
          descending:
            value: name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillPage'
              examples:
                default:
                  $ref: '#/components/examples/HybridSkillPageResponse'
        '400':
          description: Constraint violation for accountId
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                default:
                  $ref: '#/components/examples/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /accounts/{accountId}/communication-managers/{communicationManagerId}/skills/{skillId}:
    put:
      tags:
      - Hybrid Skill
      summary: Update Hybrid Skill
      description: '**This API requires the Account Administrator role.**


        Update an existing Skill with Skill id, account & communication manager id

        '
      operationId: updateSkill
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/skillId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HybridSkill'
            examples:
              default:
                $ref: '#/components/examples/UpdateHybridSkillRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                default:
                  $ref: '#/components/examples/HybridSkillResponse'
        '207':
          description: Partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                Skill:
                  $ref: '#/components/examples/HybridSkillResponsePartial'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '500':
          $ref: '#/components/responses/InternalServerError'
    get:
      tags:
      - Hybrid Skill
      summary: Get Hybrid Skill
      description: '**This API requires the Account Administrator role.**


        Returns the details of Skill, based on Skill id, account id and communication manager id

        '
      operationId: getSkill
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/skillId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                default:
                  $ref: '#/components/examples/HybridSkillResponse'
        '207':
          description: Partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                Skill:
                  $ref: '#/components/examples/HybridSkillResponsePartial'
        '400':
          $ref: '#/components/responses/ErrorConstraintViolation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      tags:
      - Hybrid Skill
      summary: Delete Hybrid Skill
      description: '**This API requires the Account Administrator role.**


        Deletes an existing Skill identified by Skill id.

        '
      operationId: deleteSkill
      parameters:
      - $ref: '#/components/parameters/accountId'
      - $ref: '#/components/parameters/communicationManagerId'
      - $ref: '#/components/parameters/skillId'
      responses:
        '204':
          description: No Content
        '207':
          description: Partial success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HybridSkillResponse'
              examples:
                Skill:
                  $ref: '#/components/examples/HybridSkillResponsePartial'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: This API uses Bearer Token Authorization Flow
      bearerFormat: JWT
    AppKey:
      type: apiKey
      in: header
      name: appkey
      description: This API needs an appKey as header
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorUnauthorized'
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorForbidden'
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorNotFound'
    InternalServerError:
      description: All other application errors
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorInternalServerError'
    ErrorConstraintViolation:
      description: Constraint Violation
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConstraintViolation'
    ErrorACOExists:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            loginId:
              $ref: '#/components/examples/ErrorACOExists'
    ErrorMSTeamsExists:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            loginId:
              $ref: '#/components/examples/ErrorMSTeamsExists'
    ErrorPhoneNumberExists:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            loginId:
              $ref: '#/components/examples/ErrorPhoneNumberExists'
    ErrorOutboundDuplicatePriorityExists:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            priority:
              $ref: '#/components/examples/ErrorOutboundDuplicatePriorityExists'
    MethodNotAllowed:
      description: Method Not Allowed
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorMethodNotAllowed'
    Conflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorConflict'
    ErrorExtensionExists:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          examples:
            default:
              $ref: '#/components/examples/ErrorExtensionExists'
  schemas:
    OpenIDConnectDiscovery:
      title: OpenIDConnectDiscovery
      type: object
      description: OpenID Connect Discovery Url  which is associated with Avaya Aura Device Service
      properties:
        openIDConnectDiscovery:
          type: string
          readOnly: true
          description: OpenID Connect Discovery Url
          example: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
    AvayaAuraDeviceService:
      title: AvayaAuraDeviceService
      type: object
      description: Avaya Aura Device Service Element
      required:
      - hostname
      - name
      - port
      properties:
        id:
          type: string
          readOnly: true
          description: The unique id of the element.
          example: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
        name:
          type: string
          description: Name of the element. This should be unique per type.
          example: AADS
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          description: Description of Avaya Aura Device Service Element
          example: cust
          minLength: 3
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        hostname:
          type: string
          description: Hostname of Element
          example: aads-dev-11.avaya.com
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\@\-\_\/\:\.\ ]+$
        port:
          type: integer
          format: int32
          description: Port used to connect to Avaya Aura Device Service Element
          minimum: 0
          maximum: 65536
          example: 443
        openIDConnectDiscovery:
          type: string
          readOnly: true
          description: OpenID Connect Discovery URL
          example: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
        status:
          type: string
          readOnly: true
          description: Status of the object under operation
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          example: SUCCESS
    AvayaAuraDeviceServices:
      title: AvayaAuraDeviceServices
      type: object
      description: List of Avaya Aura Device Service Elements
      properties:
        resources:
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/AvayaAuraDeviceService'
    AvayaAuraDeviceServiceResponse:
      type: object
      description: Represents the response for an asynchronous operation that simply returns a HATEOAS url, that provides
        a reference to the object under operation
      properties:
        url:
          type: string
          example: /api/admin/voice/v1/accounts/ABCDEF/avaya-aura-device-services/63c6ff9d-3370-090e-bkb2-7gh442b99985
          maxLength: 2048
    CommunicationManagerPage:
      title: CommunicationManagerPage
      type: object
      description: Communication Manager filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        resources:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/CommunicationManagerResponse'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/{accountId}/communication-managers?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/{accountId}/communication-managers?pageNumber=3&pageSize=10
    CommunicationManager:
      title: CommunicationManager
      type: object
      description: Represents the model used to create or update a Communication Manager element.
      properties:
        id:
          type: string
          readOnly: true
          format: uuid
          example: 690a6253-bc77-4af4-bf94-eaab68ca2ff0
          description: The unique id of the cm.
        name:
          type: string
          example: CM4696
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: This is testing Communication Manager.
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        hostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc1-cm96.avayacloud.stage
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        port:
          type: string
          example: '5022'
          default: '5022'
          minLength: 0
          maxLength: 5
          minimum: 0
          maximum: 65535
        alternateHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN) of alternate CM
          example: dc1-cm98.avayacloud.stage
          minLength: 0
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        alternatePort:
          type: string
          example: '5044'
          minLength: 0
          maxLength: 5
          minimum: 0
          maximum: 65535
        username:
          type: string
          example: cust
          minLength: 0
          maxLength: 255
        password:
          type: string
          example: testpassword
          minLength: 0
          maxLength: 255
        version:
          type: string
          description: Version of Communication Manager.
          enum:
          - NONE
          - V8_X
          - V10_X
          default: V10_X
          example: V10_X
        hybridCloudGatewayId:
          type: string
          format: uuid
          description: Hybrid Cloud Gateway uuid associated with the Communication Manager
          example: 36c707a7-7a29-4cd7-82c0-60a61346ed29
        enableAutoIncrementalSync:
          type: boolean
          description: 'Flag used for automatic incremental sync. '
          example: true
          default: false
        lastOnPremChangeDetectedTime:
          type: string
          description: Last on-prem change detected time from list history
          readOnly: true
          example: 2020-04-21T17:40:28z
      required:
      - name
      - hybridCloudGatewayId
    CommunicationManagerResponse:
      title: CommunicationManagerResponse
      type: object
      description: Represents the model used to get details of a single Communication Manager.
      properties:
        id:
          type: string
          readOnly: true
          format: uuid
          example: 52de9de1-dda8-48d1-8ee5-e1b448b51ba1
          description: The unique id of the cm.
        name:
          type: string
          example: CM4696
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: This is testing Communication Manager.
          minLength: 3
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        hostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc1-cm96.avayacloud.stage
          minLength: 0
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        port:
          type: string
          example: '5022'
          default: '5022'
          minLength: 0
          maxLength: 5
          minimum: 0
          maximum: 65535
        alternateHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN) of alternate CM
          example: dc1-cm98.avayacloud.stage
          minLength: 0
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        alternatePort:
          type: string
          example: '5044'
          minLength: 0
          maxLength: 5
          minimum: 0
          maximum: 65535
        username:
          type: string
          example: cust
          minLength: 0
          maxLength: 255
        password:
          type: string
          example: testpassword
          minLength: 0
          maxLength: 255
        version:
          type: string
          description: Version of Communication Manager.
          enum:
          - V8_X
          - V10_X
          default: V10_X
          example: V10_X
          maxLength: 10
        hybridCloudGatewayId:
          type: string
          format: uuid
          description: Hybrid Cloud Gateway uuid associated with the Communication Manager
          example: d480d85c-c5dd-440d-8d7f-ba172eea5d61
        enableAutoIncrementalSync:
          type: boolean
          description: Enable Auto Incremental Sync
          example: true
          default: false
        status:
          type: string
          description: Status of the object under operation
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          example: IN_PROGRESS
        lastOnPremChangeDetectedTime:
          type: string
          description: Last on-prem change detected time from list history
          readOnly: true
          example: 2020-04-21T17:40:28z
    AsynchronousOperationResponse:
      type: object
      description: Represents the response for an asynchronous operation that simply returns a HATEOAS url, that provides
        a reference to the object under operation
      properties:
        url:
          type: string
          maxLength: 2048
    HybridCloudGatewaySystemResponse:
      type: object
      description: Hybrid Cloud Gateway Systems Response
      properties:
        status:
          type: string
        message:
          type: string
    VoicePlanPage:
      title: VoicePlanPage
      type: object
      description: Voice Plan filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        resources:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/VoicePlan'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/{accountId}/communication-managers/{communicationManagerId}/voice-plans?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/{accountId}/communication-managers/{communicationManagerId}/voice-plans?pageNumber=3&pageSize=10
    VoicePlan:
      type: object
      description: Represents ranges of entities for configured Communication Manager.
      properties:
        voicePlanId:
          type: string
          format: uuid
          readOnly: true
          description: unique identifier for Voice Plan
          example: dfeb5425-b96a-4fb7-a0bd-aa4b8248b814
        name:
          type: string
          description: Name of the voice plan
          example: VoicePlan1
          pattern: ^(?!\s*$).+
          minLength: 3
          maxLength: 255
        type:
          type: string
          description: The type of the Voice Plan. If SYSTEM type is set then allowed to set values for vdnDialPlanRange,
            reasonCodeNotReadyRange, reasonCodeLogOutRange. If USER type is set then allowed to set values for agentDialPlanRange,
            extensionDialPlanRange.
          enum:
          - SYSTEM
          - USER
          example: SYSTEM
        userProfileId:
          type: string
          description: Profile for the voice plan
          example: ASEDFG
          minLength: 0
          maxLength: 6
          pattern: ^$|^[a-zA-Z0-9\-\_\.\ ]+$
        description:
          type: string
          description: Description of the voice plan
          example: Voice plan for Comunication Manager
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        agentDialPlanRange:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 50
          example:
          - 20000:20100
          description: Agent dial plan ranges. Allowed to be set only if voice plan type is USER.
        extensionDialPlanRange:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 50
          example:
          - 30000:30100
          - 8000000:9000000
          description: Extension dial plan ranges. Allowed to be set only if voice plan type is USER.
        reasonCodeNotReadyRange:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 5
          example:
          - '1:9'
          description: Aux reason code ranges. Allowed to be set only if voice plan type is SYSTEM.
        reasonCodeLogOutRange:
          type: array
          maxItems: 50
          items:
            type: string
            maxLength: 3
          example:
          - '1:9'
          description: Logout reason code ranges. Allowed to be set only if voice plan type is SYSTEM.
        status:
          type: string
          description: Status code of the voice plan. A voice plan with status code PROFILE_NOT_ASSIGNED indicates that it
            is in error state and Profile associated with it is been deleted.
          enum:
          - PROFILE_NOT_ASSIGNED
          - SUCCESS
      required:
      - name
      - type
    HybridCloudGateways:
      title: HybridCloudGateways
      type: object
      description: List of Hybrid Cloud Gateways
      properties:
        resources:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/HybridCloudGatewayResponse'
    HybridCloudGateway:
      title: HybridCloudGateway
      type: object
      description: Avaya Hybrid Cloud Gateway acts as a gateway to Avaya Aura clients and applications utilizing WebRTC signaling
        and media.
      properties:
        id:
          type: string
          description: The unique id of Avaya Hybrid Cloud Gateway
          readOnly: true
          format: uuid
          example: 41c6ef0d-5470-406e-ace2-6dc442b99318
        name:
          type: string
          example: AHCG123
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Avaya Hybrid Cloud Gateway
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        systemId:
          type: string
          description: System-Id of Avaya Hybrid Cloud Gateway
          format: uuid
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
        publicKey:
          type: string
          example: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
          description: Public key of the Avaya Hybrid Cloud Gateway.
          minLength: 1
          maxLength: 4096
        publicKeyAlgorithm:
          type: string
          description: Algorithm for the public key. This is a mandatory field for configuring a Hyrbid Cloud Gateway. Currently
            it is internally set to ES256, if not specified.
          enum:
          - ES256
          default: ES256
          example: ES256
        locationCode:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        sessionManagerFqdnList:
          type: array
          items:
            type: string
            maxLength: 255
            pattern: ^[a-zA-Z0-9\p{L}\-\_\/\:\.\ ]+$
          minItems: 1
          maxItems: 50
          description: List of Fully-Qualified Domain-Name (FQDN) of all the deployed Session Managers for the tenant.
          example:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
        isMediaLatchingEnable:
          type: boolean
          description: ''
          example: true
          default: true
        isTermsAndConditionsAccepted:
          type: boolean
          description: Avaya cloud solutions are designed to scale while maintaining deep security and high availability. This
            cloud solution supports secure media, which is recommended by Avaya. If secure media is disabled on your existing
            system, media traffic will flow on the internet and through Avaya servers unencrypted. The security benefits of
            encrypted traffic will not be available. For more information, please see https://www.avaya.com/en/trust-center-cloud-security/
          example: true
          default: false
      required:
      - name
      - systemId
      - publicKey
      - locationCode
      - sessionManagerFqdnList
      - isTermsAndConditionsAccepted
    UpdateHybridCloudGatewayRequest:
      title: UpdateHybridCloudGatewayRequest
      type: object
      description: Request object to update an Avaya Hybrid Cloud Gateway. Once a Hybrid Cloud Gateway element is created
        in NGM, it's systemId field isn't allowed to be updated. Hence the systemId field is excluded from this model.
      properties:
        id:
          type: string
          description: The unique id of Avaya Hybrid Cloud Gateway
          readOnly: true
          format: uuid
          example: 41c6ef0d-5470-406e-ace2-6dc442b99318
        name:
          type: string
          example: AHCG123
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Avaya Hybrid Cloud Gateway
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        publicKey:
          type: string
          example: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
          description: Public key of the Avaya Hybrid Cloud Gateway.
          minLength: 1
          maxLength: 4096
        publicKeyAlgorithm:
          type: string
          description: Algorithm for the public key. This is a mandatory field for configuring a Hyrbid Cloud Gateway. Currently
            it is internally set to ES256, if not specified.
          enum:
          - ES256
          default: ES256
          example: ES256
        locationCode:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        sessionManagerFqdnList:
          type: array
          items:
            type: string
            maxLength: 255
            pattern: ^[a-zA-Z0-9\p{L}\-\_\/\:\.\ ]+$
          minItems: 1
          maxItems: 50
          description: List of Fully-Qualified Domain-Name (FQDN) of all the deployed Session Managers for the tenant.
          example:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
        isMediaLatchingEnable:
          type: boolean
          example: true
          default: true
        isTermsAndConditionsAccepted:
          type: boolean
          description: Indicates if User agrees to terms and conditions.
          example: true
      required:
      - name
      - publicKey
      - locationCode
      - sessionManagerFqdnList
      - isTermsAndConditionsAccepted
    HybridCloudGatewayResponse:
      title: HybridCloudGatewayResponse
      type: object
      description: Represents the model used to get details of a single Avaya Hybrid Cloud Gateway.
      properties:
        id:
          type: string
          description: The unique id of Avaya Hybrid Cloud Gateway
          readOnly: true
          format: uuid
          example: 41c6ef0d-5470-406e-ace2-6dc442b99318
        name:
          type: string
          example: AHCG123
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Avaya Hybrid Cloud Gateway
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        systemId:
          type: string
          description: System-Id of Avaya Hybrid Cloud Gateway
          format: uuid
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
        publicKey:
          type: string
          example: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
          description: Public key of the Avaya Hybrid Cloud Gateway.
          minLength: 1
          maxLength: 4096
        publicKeyAlgorithm:
          type: string
          description: Algorithm for the public key. This is a mandatory field for configuring a Hyrbid Cloud Gateway. Currently
            it is internally set to ES256, if not specified.
          enum:
          - ES256
          default: ES256
          example: ES256
        locationCode:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        sessionManagerFqdnList:
          type: array
          items:
            type: string
            maxLength: 255
            pattern: ^[a-zA-Z0-9\p{L}\-\_\/\:\.\ ]+$
          minItems: 1
          maxItems: 50
          description: List of Fully-Qualified Domain-Name (FQDN) of all the deployed Session Managers for the tenant.
          example:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
        isMediaLatchingEnable:
          type: boolean
          description: ''
          example: true
          default: true
        isTermsAndConditionsAccepted:
          type: boolean
          description: Avaya cloud solutions are designed to scale while maintaining deep security and high availability. This
            cloud solution supports secure media, which is recommended by Avaya. If secure media is disabled on your existing
            system, media traffic will flow on the internet and through Avaya servers unencrypted. The security benefits of
            encrypted traffic will not be available. For more information, please see https://www.avaya.com/en/trust-center-cloud-security/
          example: true
          default: false
        status:
          type: string
          description: Status of the object under operation
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          example: IN_PROGRESS
    UpdateHybridCloudGatewaySystemConfig:
      title: UpdateHybridCloudGatewaySystemConfig
      type: object
      description: Request object to update an Avaya Hybrid Cloud Gateway Config.
      properties:
        publicKey:
          type: string
          example: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
          description: Public key of the Avaya Hybrid Cloud Gateway.
          minLength: 1
          maxLength: 4096
        publicKeyAlgorithm:
          type: string
          description: Algorithm for the public key. This is a mandatory field for configuring a Hyrbid Cloud Gateway. Currently
            it is internally set to ES256, if not specified.
          enum:
          - ES256
          default: ES256
          example: ES256
      required:
      - publicKey
    SystemManagers:
      title: SystemManagers
      type: object
      description: List of System Manager
      properties:
        resources:
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/SystemManagerResponse'
    SystemManager:
      title: SystemManager
      type: object
      description: System Manager is a central management system that delivers a set of shared management services and provides
        a common console for the Avaya Aura applications and systems.
      properties:
        id:
          type: string
          description: The unique id of System Manager
          readOnly: true
          format: uuid
          example: 7700d655-5807-4738-a868-712740a18199
        name:
          type: string
          example: SMGR123
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the System Manager
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        primaryHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc1-smgr96.avayacloud.stage
          minLength: 1
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        username:
          type: string
          example: dummyUser
          maxLength: 255
        password:
          type: string
          example: dummypassword
          maxLength: 255
        enrollmentPassword:
          type: string
          example: testpassword
          maxLength: 255
        secondaryHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc2-smgr97.avayacloud.stage
          minLength: 1
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        activeSystemManager:
          type: string
          description: This field represents which System Manager is active. If SECONDARY value is selected then secondaryHostname
            should have some valid value assigned.
          enum:
          - PRIMARY
          - SECONDARY
          default: PRIMARY
          example: PRIMARY
        useForCerts:
          type: boolean
          description: This field represents if the System Manager will be used for certificates.
          example: true
      required:
      - name
      - primaryHostname
      - username
      - password
      - useForCerts
    UpdateSystemManager:
      title: UpdateSystemManager
      type: object
      description: System Manager schema for update
      properties:
        name:
          type: string
          example: SMGR123
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the System Manager
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        primaryHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc1-smgr96.avayacloud.stage
          minLength: 1
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        username:
          type: string
          example: dummyUser
          maxLength: 255
        password:
          type: string
          example: dummypassword
          maxLength: 255
        enrollmentPassword:
          type: string
          example: testpassword
          maxLength: 255
        secondaryHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc2-smgr97.avayacloud.stage
          minLength: 1
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        activeSystemManager:
          type: string
          description: This field represents which System Manager is active. If SECONDARY value is selected then secondaryHostname
            should have some valid value assigned.
          enum:
          - PRIMARY
          - SECONDARY
          default: PRIMARY
          example: PRIMARY
        useForCerts:
          type: boolean
          description: This field represents if the System Manager will be used for certificates.
          example: true
      required:
      - name
      - primaryHostname
      - username
    SystemManagerResponse:
      title: SystemManagerResponse
      type: object
      description: Represents the model used to get details of a single System Manager.
      properties:
        id:
          type: string
          description: The unique id of System Manager
          readOnly: true
          format: uuid
          example: 7700d655-5807-4738-a868-712740a18199
        name:
          type: string
          example: SMGR123
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the System Manager
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        primaryHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc1-smgr96.avayacloud.stage
          minLength: 1
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        username:
          type: string
          example: dummyUser
          maxLength: 255
        password:
          type: string
          example: dummypassword
          maxLength: 255
        enrollmentPassword:
          type: string
          example: testpassword
          maxLength: 255
        secondaryHostname:
          type: string
          description: This is the Fully Qualified Domain Name (FQDN)
          example: dc2-smgr97.avayacloud.stage
          minLength: 1
          maxLength: 255
          pattern: (^(([a-zA-Z]|[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9])\.){1,}([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9]){1,}$)|((^\s*((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))\s*$)|(^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$))
        activeSystemManager:
          type: string
          description: This field represents which System Manager is active. If SECONDARY value is selected then secondaryHostname
            should have some valid value assigned.
          enum:
          - PRIMARY
          - SECONDARY
          default: PRIMARY
          example: PRIMARY
        useForCerts:
          type: boolean
          description: This field represents if the System Manager will be used for certificates.
          example: true
        status:
          type: string
          description: Status of the object under operation
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          example: IN_PROGRESS
    HybridCloudManager:
      type: object
      description: Hybrid Cloud Manager server.
      properties:
        hostname:
          type: string
          example: testhcm.avaya.com
          description: The hostname of Hybrid Cloud Manager
    GatewayConnectionManager:
      type: object
      description: Gateway Connection Manager Server details
      properties:
        hostname:
          type: string
          example: communication-services-candidate.avayacloud.com
          description: The hostname of Gateway Connection Manager
    ReasonCode:
      description: 'Reason codes are a set of codes that agents can select from agent desktop clients to further describe
        their current activity or state. Reason Codes consist of a unique codeName, codeNumber and codeType combination. This
        API is used to create, update, retrieve and delete NOT_READY, LOGOUT reason codes and CALL_WORK_CODE codes.

        '
      type: object
      required:
      - codeName
      - codeNumber
      - codeType
      properties:
        reasonCodeId:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          readOnly: true
          description: The unique 36 character internal id for the Reason Code
        codeName:
          type: string
          example: Lunch
          minLength: 1
          maxLength: 20
          pattern: ^[a-zA-Z\p{L}0-9]+([ ]*[a-zA-Z\p{L}0-9-\_\*\=\+\$\:\;\&\~\,\?\%\!\|\{\}\`\.\']+)*$
          description: The name of the Reason Code. If code type is NOT_READY or LOGOUT, code name length must be up to 16
            unicode characters and if code type is CALL_WORK_CODE, code name length must be up to 20 unicode characters.
        codeNumber:
          type: string
          example: '89'
          minLength: 1
          maxLength: 16
          pattern: ^[0-9][0-9]*$
          description: The number of the Reason Code. If code type is NOT_READY, code number must be between 1 to 99. If code
            type is LOGOUT, code number must be between 1 to 9 and if code type is CALL_WORK_CODE, code number must be of
            16 digits.
        codeType:
          type: string
          description: The type of the Reason Code
          enum:
          - NOT_READY
          - LOGOUT
          - CALL_WORK_CODE
          example: NOT_READY
        description:
          type: string
          example: Agent is on Lunch
          minLength: 0
          maxLength: 1024
          description: The description for the Reason Code
        isInterruptible:
          type: boolean
          description: Indicates if the Reason Code is interruptible. This is applicable to NOT READY Reason Codes.
          example: false
        systemDefinedAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ReasonCodeSystemAttributes'
          description: Indicates if the Reason Code has additional system defined behavior. This is applicable to NOT READY
            Reason Codes. Only one Not Ready Reason Code shall be allowed to be marked as 'Work on Digital'. If a Not Ready
            Reason Code is marked as 'Work on Digital', it cannot be assigned any other system-defined attribute. At least
            one Not Ready Reason Code needs to be marked as 'Work on Digital'.
          maxItems: 5
          example:
          - WORK_ON_DIGITAL
        organizationNodeId:
          type: string
          example: EXMPLE
          minLength: 6
          maxLength: 6
          pattern: ^[a-zA-Z]{6}$
          description: Unique Id for Account or Node where Reason Code gets created
    UpdateReasonCode:
      description: Represents the request body of an API to update a Reason Code.
      type: object
      properties:
        codeName:
          type: string
          example: Lunch
          minLength: 1
          maxLength: 20
          pattern: ^[a-zA-Z\p{L}0-9]+([ ]*[a-zA-Z\p{L}0-9-\_\*\=\+\$\:\;\&\~\,\?\%\!\|\{\}\`\.\']+)*$
          description: The name of the Reason Code. If code type is NOT_READY or LOGOUT, code name length must be up to 16
            unicode characters and if code type is CALL_WORK_CODE, code name length must be up to 20 unicode characters.
        codeNumber:
          type: string
          example: '89'
          minLength: 1
          maxLength: 16
          pattern: ^[0-9][0-9]*$
          description: The number of the Reason Code. If code type is NOT_READY, code number must be between 1 to 99. If code
            type is LOGOUT, code number must be between 1 to 9 and if code type is CALL_WORK_CODE, code number must be of
            16 digits.
        description:
          type: string
          example: Agent is on Lunch
          minLength: 0
          maxLength: 1024
          description: The description for the Reason Code
        isInterruptible:
          type: boolean
          description: Indicates if the Reason Code is interruptible. This is applicable to NOT READY Reason Codes.
          example: false
        systemDefinedAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ReasonCodeSystemAttributes'
          description: Indicates if the Reason Code has additional system defined behavior. This is applicable to NOT READY
            Reason Codes. Only one Not Ready Reason Code shall be allowed to be marked as 'Work on Digital'. If a Not Ready
            Reason Code is marked as 'Work on Digital', it cannot be assigned any other system-defined attribute. At least
            one Not Ready Reason Code needs to be marked as 'Work on Digital'.
          maxItems: 5
          example:
          - WORK_ON_DIGITAL
        organizationNodeId:
          type: string
          example: EXMPLE
          minLength: 6
          maxLength: 6
          pattern: ^[a-zA-Z]{6}$
          description: Unique Id for Account or Node where Reason Code gets created
      required:
      - codeName
    ReasonCodeResponse:
      description: 'Represents the model used to get details of a single Reason Code.

        '
      type: object
      properties:
        reasonCodeId:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
          readOnly: true
          description: The unique 36 character internal id for the Reason Code
        codeName:
          type: string
          example: Lunch
          minLength: 1
          maxLength: 20
          pattern: ^[a-zA-Z\p{L}0-9]+([ ]*[a-zA-Z\p{L}0-9-\_\*\=\+\$\:\;\&\~\,\?\%\!\|\{\}\`\.\']+)*$
          description: The name of the Reason Code. If code type is NOT_READY or LOGOUT, code name length must be up to 16
            unicode characters and if code type is CALL_WORK_CODE, code name length must be up to 20 unicode characters.
        codeNumber:
          type: string
          example: '89'
          minLength: 1
          maxLength: 16
          pattern: ^[0-9][0-9]*$
          description: The number of the Reason Code. If code type is NOT_READY, code number must be between 1 to 99. If code
            type is LOGOUT, code number must be between 1 to 9 and if code type is CALL_WORK_CODE, code number must be of
            16 digits.
        codeType:
          type: string
          description: The type of the Reason Code
          enum:
          - NOT_READY
          - LOGOUT
          - CALL_WORK_CODE
          example: NOT_READY
        description:
          type: string
          example: Agent is on Lunch
          minLength: 0
          maxLength: 1024
          description: The description for the Reason Code
        isInterruptible:
          type: boolean
          description: Indicates if the Reason Code is interruptible. This is applicable to NOT READY Reason Codes.
          example: false
        systemDefinedAttributes:
          type: array
          items:
            $ref: '#/components/schemas/ReasonCodeSystemAttributes'
          description: Indicates if the Reason Code has additional system defined behavior. This is applicable to NOT READY
            Reason Codes. Only one Not Ready Reason Code shall be allowed to be marked as 'Work on Digital'. If a Not Ready
            Reason Code is marked as 'Work on Digital', it cannot be assigned any other system-defined attribute. At least
            one Not Ready Reason Code needs to be marked as 'Work on Digital'.
          example:
          - WORK_ON_DIGITAL
        organizationNodeId:
          type: string
          example: EXMPLE
          minLength: 6
          maxLength: 6
          pattern: ^[a-zA-Z]{6}$
          description: Unique Id for Account or Node where Reason Code gets created
        status:
          type: string
          description: Status of the object under operation
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          example: IN_PROGRESS
    ReasonCodeSystemAttributes:
      type: string
      enum:
      - WORK_ON_DIGITAL
      - REDIRECTION_ON_OPTIM_FAILURE
      - REDIRECTION_ON_NO_ANSWER
      - SUPERVISOR_FORCED_NOT_READY
      - SUPERVISOR_FORCED_LOGOUT
      description: Indicates if the Reason Code has additional system defined behavior."
      example: WORK_ON_DIGITAL
    ReasonCodePage:
      title: ReasonCodePage
      type: object
      description: Reason Code filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ReasonCodeResponse'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/{accountId}/communication-managers/{communicationManagerId}/reason-codes?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/{accountId}/communication-managers/{communicationManagerId}/reason-codes?pageNumber=3&pageSize=10
    ACOElement:
      type: object
      description: 'Avaya Cloud Office Element Details

        '
      properties:
        elementId:
          type: string
          readOnly: true
          example: ce8042a2-12f8-406f-5fd3-86c1c16d3a77
        name:
          type: string
          example: Avaya Cloud Office
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        environment:
          type: string
          enum:
          - Production
          - Development
          example: Production
        description:
          type: string
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ ]+$)
        didNumbers:
          description: The did numbers in the E.164 format
          type: array
          maxItems: 2000
          items:
            type: string
            maxLength: 13
          example:
          - '+16062128688'
          - '+12702289911'
        isChatEnabled:
          type: boolean
          description: Indicates whether the chat is enabled for any given ACO element.
          default: true
          example: true
        isExtensionCalling:
          type: boolean
          description: Indicates whether the extension calling is disabled for any given ACO element.
          default: false
          example: false
        elementType:
          type: string
          readOnly: true
          example: ACO
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\_\.\ ]+$
        status:
          type: string
          description: "This field indicates the current status of an Element.\n\nAn explanation of the values is listed below:\n\
            \  * SUCCESS - An Element was created/updated successfully.\n  * FAILED - operation on Element was failed.\n \
            \ * IN_PROGRESS - operation performed on an Element is in progress.\n"
          enum:
          - SUCCESS
          - FAILED
          - IN_PROGRESS
        statusMessage:
          type: string
          readOnly: true
          example: cannot create element due to database failure
        presenceApplicationType:
          type: string
          enum:
          - AVAYA_CLOUD_OFFICE
          - AVAYA_CLOUD_PHONE
          x-enum-varnames:
          - AVAYA_CLOUD_OFFICE
          - AVAYA_CLOUD_PHONE
      required:
      - name
      - environment
    MSTeamsElement:
      title: MSTeamsElement
      type: object
      description: MS Teams Element Model
      properties:
        elementId:
          type: string
          readOnly: true
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
          description: Unique UUID for MS Teams Element
        name:
          type: string
          example: MS Teams Server
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
          description: Name of the MS Teams Element
        description:
          type: string
          example: MS Teams Server description
          maxLength: 1024
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ ]+$)
        didNumbers:
          description: The did numbers in the E.164 format
          type: array
          maxItems: 2000
          items:
            type: string
            maxLength: 13
          example:
          - '+16479308804'
          - '+16479308815'
        domain:
          type: string
          example: exchange.com
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          description: Domain name configured for the MS Teams Element
        elementType:
          type: string
          readOnly: true
          example: MSTeams
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\-\_\.\ ]+$
        status:
          type: string
          description: "This field indicates the current status of an Element.\n\nAn explanation of the values is listed below:\n\
            \  * SUCCESS - An Element was created/updated successfully.\n  * FAILED - Operation on Element was failed.\n \
            \ * IN_PROGRESS - Operation performed on an Element is in progress.\n"
          enum:
          - SUCCESS
          - FAILED
          - IN_PROGRESS
        statusMessage:
          type: string
          readOnly: true
          example: cannot create element due to database failure
        isChatEnabled:
          type: boolean
          description: Indicates whether the chat is enabled for any given MSTeams element.
          default: true
          example: true
        clientId:
          type: string
          example: bv347c9d-2a6c-1996-ff79-2e0e1ceae6d7
          description: The client id of the msteams client
          maxLength: 255
      required:
      - name
    MSTeamsSIPTrunkResponse:
      title: MSTeamsSIPTrunkResponse
      type: object
      description: Microsoft Teams SIP Trunk Element Model
      properties:
        elementId:
          type: string
          readOnly: true
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
          description: Unique UUID for Microsoft Teams SIP Trunk Element
        name:
          type: string
          example: MSTeams-Trunk-US
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
          description: Name of the Microsoft Teams SIP Trunk Element
        description:
          type: string
          example: Microsoft Teams SIP Trunk element description
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ ]+$)
        type:
          type: string
          readOnly: true
          example: MST
        provider:
          type: string
          readOnly: true
          example: MicrosoftTeams
        providerDomain:
          type: string
          example: exchange.com
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          description: Provider Domain name configured for the Microsoft Teams SIP Trunk Element
        inboundDomain:
          type: string
          example: msteams-tenant-trunk-id.companyABC.aco.com
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          description: The inbound domain name that can be configured for the MSTeams SIP Trunk Element
        preferredMediaLocation:
          type: string
          description: Preferred Media Processing Location set by tenant.
          example: US-LA
          minLength: 1
          maxLength: 7
        status:
          type: string
          description: "This field indicates the current status of an Element.\n\nAn explanation of the values is listed below:\n\
            \  * SUCCESS - An Element was created/updated successfully.\n  * FAILED - Operation on Element was failed.\n \
            \ * IN_PROGRESS - Operation performed on an Element is in progress.\n"
          enum:
          - SUCCESS
          - FAILED
          - IN_PROGRESS
        statusMessage:
          type: string
          readOnly: true
          example: cannot create element due to database failure
      required:
      - name
      - providerDomain
      - inboundDomain
      - preferredMediaLocation
    ACOSIPTrunkResponse:
      title: ACOSIPTrunkResponse
      type: object
      description: Avaya Cloud Office(ACO) SIP Trunk Element Response Model
      properties:
        elementId:
          type: string
          readOnly: true
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
          description: Unique UUID for ACO SIP Trunk Element
        name:
          type: string
          example: ACO-Trunk-US
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
          description: Name of the ACO SIP Trunk Element
        description:
          type: string
          example: ACO SIP Trunk element description
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ ]+$)
        type:
          type: string
          readOnly: true
          example: ACO
        provider:
          type: string
          readOnly: true
          example: RingCentral
        providerDomain:
          type: string
          example: exchange.com
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          description: Provider Domain name configured for the ACO SIP Trunk Element
        inboundDomain:
          type: string
          example: aco-tenant-trunk-id.companyABC.aco.com
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          description: The inbound domain name that can be configured for the ACO SIP Trunk Element
        preferredMediaLocation:
          type: string
          description: Preferred Media Processing Location set by tenant.
          example: US-LA
          minLength: 1
          maxLength: 7
        status:
          type: string
          description: "This field indicates the current status of an Element.\n\nAn explanation of the values is listed below:\n\
            \  * SUCCESS - An Element was created/updated successfully.\n  * FAILED - Operation on Element was failed.\n \
            \ * IN_PROGRESS - Operation performed on an Element is in progress.\n"
          enum:
          - SUCCESS
          - FAILED
          - IN_PROGRESS
        statusMessage:
          type: string
          readOnly: true
          example: cannot create element due to database failure
      required:
      - name
      - providerDomain
      - inboundDomain
      - preferredMediaLocation
    SipTrunkPage:
      title: SipTrunkPage
      type: object
      description: Sip Trunk filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        sipTrunks:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/SipTrunk'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/{accountId}/sip-trunks?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/{accountId}/sip-trunks?pageNumber=3&pageSize=10
    SipTrunk:
      title: SipTrunk
      type: object
      description: SIP Trunks Element Model
      properties:
        id:
          description: Unique UUID for SIP Trunk
          type: string
          readOnly: true
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
        type:
          description: Type of SIP Trunk
          type: string
          readOnly: true
          example: ACOSIPTrunk
        seqNumber:
          description: Incremental sequence number of domain name
          type: integer
          readOnly: true
          example: 1
        provider:
          description: Provider name of SIP Trunk
          type: string
          readOnly: true
          example: RingCentral
        providerDomain:
          description: Provider Domain name configured for the SIP Trunk
          type: string
          readOnly: true
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          example: exchange.com
        trunkName:
          description: Name of the SIP Trunk
          type: string
          readOnly: true
          minLength: 1
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
          example: ACO-Trunk-US
        inboundDomain:
          description: Inbound Domain name configured for the ACO SIP Trunk
          type: string
          readOnly: true
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          example: exchange.com
        outboundDomain:
          description: Outbound Domain name configured for the ACO SIP Trunk Element
          type: string
          readOnly: true
          minLength: 3
          maxLength: 255
          pattern: ^((?!-)[A-Za-z0-9\p{L}-]{1,63}(?<!-)\.)+[A-Za-z\p{L}]{2,63}$
          example: exchange.com
        releaseMediaAnchorDuringTransfer:
          type: boolean
          readOnly: true
          description: Release media anchor during transfer.
          example: true
        preferredMediaLocation:
          type: string
          readOnly: true
          description: Preferred Media Processing Location set by tenant.
          example: US-LA
          minLength: 1
          maxLength: 7
        callerId:
          description: Unique id of DNIS Details fetched from CPaas Server
          type: string
          readOnly: false
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
        isDefault:
          description: Default SIP trunk
          type: boolean
          readOnly: false
          default: false
          example: true
    Problem:
      type: object
      description: '<b>Problem Detail</b> as a way to carry machine-readable details of errors in a HTTP response to avoid
        the need to define new error response formats for HTTP APIs <a href="https://tools.ietf.org/html/rfc7807">RFC 7807</a>

        '
      properties:
        type:
          type: string
          format: uri
          description: 'An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable
            documentation for the problem type (e.g., using HTML).

            '
          default: about:blank
          example: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title:
          type: string
          description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited
            for non technical stakeholders and not localized).

            '
          example: Service Unavailable
          nullable: true
        status:
          type: integer
          format: int32
          description: 'The HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          maximum: 600
          exclusiveMaximum: true
          example: 503
          nullable: true
        detail:
          type: string
          description: 'A human readable explanation specific to this occurrence of the problem.

            '
          example: Connection to database timed out
          nullable: true
        instance:
          type: string
          format: uri
          description: 'An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further
            information if dereferenced.

            '
          nullable: true
        violations:
          type: array
          description: 'A list of violations that occurred as a result of invalid data provided as part of a request.

            '
          nullable: true
          items:
            type: object
            properties:
              field:
                type: string
                description: 'The name of the field in the request that caused the violation. This can be the name of a path
                  parameter, query parameter, or a field within the request body.

                  '
                example: accountId
              message:
                type: string
                description: 'A human readable explanation specific to this occurrence of the violation.

                  '
                example: must match "^[a-zA-Z]{6}$"
              code:
                type: integer
                format: int32
                description: 'The violation code generated by the server for this occurrence of the violation. Use this code
                  when implementing any error handling logic instead of the message, as the message can change.

                  '
                example: 20006
          example:
          - field: emailAddress
            message: must not be null
            code: 20002
          - field: accountId
            message: must match "^[a-zA-Z]{6}$"
            code: 20006
    PhoneNumberPage:
      description: Paginated Phone Numbers
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ABCDEF/phone-numbers?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ABCDEF/phone-numbers?pageNumber=3&pageSize=10
    PhoneNumber:
      type: object
      description: PhoneNumber of an Account.
      properties:
        phoneNumberId:
          type: string
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique 36 character internal id that represents the phone number.
          readOnly: true
        phoneNumber:
          type: string
          pattern: ^\+[1-9]\d{3,13}$
          description: The phone number in the E.164 format
          example: '+16479308804'
          minLength: 5
          maxLength: 15
        displayName:
          type: string
          maxLength: 255
          description: Domestic format version of the phone number or any suitable name that will identify the number easily.
          example: private Number
        countryCode:
          type: string
          description: ISO Country code for number.
          minLength: 2
          maxLength: 2
          pattern: ^[A-Z]{2}$
          example: US
        type:
          type: string
          description: Phone number type. Possible values are LOCAL, TOLLFREE and UNKNOWN (when status is INPROGRESS).
          example: LOCAL
          readOnly: true
        accountId:
          type: string
          description: accountId for which Number is assigned.
          example: ABCDEF
          readOnly: true
        isCallingPartyNumber:
          type: boolean
          description: Indicates whether the number is caller Id.
          example: true
        status:
          type: string
          description: Indicates that number is active or inactive
          example: INACTIVE
          enum:
          - ACTIVE
          - INACTIVE
          - INPROGRESS
          - DISABLED
          - FAILED
          readOnly: true
        statusMessage:
          type: string
          description: status message for INACTIVE Number.
          example: Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate it.
          readOnly: true
        preferredMediaLocation:
          type: string
          description: Preferred media location set by tenant instead of default coming from CPaaS.
          example: US-LA
          minLength: 1
          maxLength: 7
    PhoneNumberListRequest:
      title: PhoneNumberListRequest
      type: array
      description: List of Phone number Ids
      maxItems: 1000
      items:
        type: string
        description: The unique 36 character internal id that represents the phone number.
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    PhoneNumberListResponse:
      title: PhoneNumberListResponse
      type: array
      description: List of Phone Number Objects
      maxItems: 1000
      items:
        $ref: '#/components/schemas/PhoneNumber'
    PhoneNumberValidateRequest:
      title: PhoneNumberValidateRequest
      type: array
      description: List of Phone number Ids
      maxItems: 1000
      items:
        type: string
        description: The unique 36 character internal id that represents the phone number.
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    ValidatePhoneNumber:
      title: ValidatePhoneNumber
      type: object
      description: Phone Number Id with message
      properties:
        id:
          type: string
          description: Phone Number Id
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        message:
          type: string
          example: Doesn't exist in database
          description: short description about phone number if it is invalid
    PhoneNumberValidateResponse:
      title: PhoneNumberValidateResponse
      type: object
      description: Validate Phone Number Response
      properties:
        valid:
          type: array
          items:
            $ref: '#/components/schemas/ValidatePhoneNumber'
        invalid:
          type: array
          items:
            $ref: '#/components/schemas/ValidatePhoneNumber'
    PhoneNumbersDetailsRequest:
      title: PhoneNumbersDetailsRequest
      type: array
      description: List of Phone numbers
      maxItems: 1000
      items:
        type: string
        description: Actual phone number.
        example: '+168739874'
    OutboundRoutingRulePage:
      title: OutboundRoutingRulePage
      type: object
      description: Outbound Routing Rule filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        outboundRoutingRules:
          type: array
          maxItems: 50
          items:
            $ref: '#/components/schemas/OutboundRoutingRule'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ABCDEF/outbound-routing-rules?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ABCDEF/outbound-routing-rules?pageNumber=3&pageSize=10
    BulkUpdateOutboundRoutingRule:
      type: object
      description: Outbound Routing Rule Model.
      required:
      - id
      - type
      - priority
      - prefix
      - minLength
      - maxLength
      properties:
        id:
          type: string
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique 36 character internal id that represents the Outbound Routing Rule.
          readOnly: true
        type:
          type: string
          description: The Number type can be Phone Number.
          enum:
          - NUMBER_PREFIX
        priority:
          type: integer
          description: The priority for Outbound Routing Rule
          example: 1
        prefix:
          type: string
          description: The prefix for Outbound Routing Rule
          example: '+1'
          minLength: 1
          maxLength: 50
        minLength:
          type: integer
          description: The minimum String Length for Outbound Routing Rule
          example: '7'
          minimum: 1
          maximum: 50
        maxLength:
          type: integer
          description: The maximum String Length for Outbound Routing Rule
          example: '50'
          minimum: 1
          maximum: 50
        sipTrunkId:
          type: string
          maxLength: 50
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique uuid that represents the different type of SIP Trunk like MS Teams, ACO etc.
        callerId:
          type: string
          maxLength: 50
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique id of DNIS Details fetched from CPaas Server
        isoCountry:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        locationIds:
          type: array
          maxItems: 20
          items:
            type: string
          description: List of Agent Locations Id
          example:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
    UpdateOutboundRoutingRule:
      type: object
      description: Outbound Routing Rule Model.
      required:
      - type
      - priority
      - prefix
      - minLength
      - maxLength
      properties:
        id:
          type: string
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique 36 character internal id that represents the Outbound Routing Rule.
          readOnly: true
        type:
          type: string
          description: The Number type can be Phone Number.
          enum:
          - NUMBER_PREFIX
        priority:
          type: integer
          description: The priority for Outbound Routing Rule
          example: 1
        prefix:
          type: string
          description: The prefix for Outbound Routing Rule
          example: '+1'
          minLength: 1
          maxLength: 50
        minLength:
          type: integer
          description: The minimum String Length for Outbound Routing Rule
          example: '7'
          minimum: 1
          maximum: 50
        maxLength:
          type: integer
          description: The maximum String Length for Outbound Routing Rule
          example: '50'
          minimum: 1
          maximum: 50
        sipTrunkId:
          type: string
          maxLength: 50
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique uuid that represents the different type of SIP Trunk like MS Teams, ACO etc.
        callerId:
          type: string
          maxLength: 50
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique id of DNIS Details fetched from CPaas Server
        isoCountry:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        locationIds:
          type: array
          maxItems: 20
          items:
            type: string
          description: List of Agent Location Id
          example:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
    OutboundRoutingRule:
      type: object
      description: Outbound Routing Rule Model.
      required:
      - type
      - prefix
      - minLength
      - maxLength
      properties:
        id:
          type: string
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique 36 character internal id that represents the Outbound Routing Rule.
          readOnly: true
        type:
          type: string
          description: The Number type can be Phone Number.
          enum:
          - NUMBER_PREFIX
        priority:
          type: integer
          description: The priority for Outbound Routing Rule
          example: 1
        prefix:
          type: string
          description: The prefix for Outbound Routing Rule
          example: '+1'
          minLength: 1
          maxLength: 50
        minLength:
          type: integer
          description: The minimum String Length for Outbound Routing Rule
          example: '7'
          minimum: 1
          maximum: 50
        maxLength:
          type: integer
          description: The maximum String Length for Outbound Routing Rule
          example: '50'
          minimum: 1
          maximum: 50
        sipTrunkId:
          type: string
          maxLength: 50
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique uuid that represents the different type of SIP Trunk like MS Teams, ACO etc.
        callerId:
          type: string
          maxLength: 50
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The Unique id of DNIS Details fetched from CPaas Server
        isoCountry:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        locationIds:
          type: array
          maxItems: 20
          items:
            type: string
          description: List of Agent Location Id
          example:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
    AvailablePhoneNumberPage:
      description: Paginated Available Phone Numbers
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/AvailablePhoneNumber'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ABCDEF/available-phone-numbers?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ABCDEF/available-phone-numbers?pageNumber=3&pageSize=10
    AvailablePhoneNumber:
      type: object
      description: Available PhoneNumber to assign.
      properties:
        phoneNumber:
          type: string
          description: The phone number in the E.164 format
          example: '+16479308804'
          readOnly: true
        countryCode:
          type: string
          description: ISO Country code for number.
          example: US
          readOnly: true
        type:
          type: string
          description: Phone number type.
          readOnly: true
          enum:
          - LOCAL
          - TOLLFREE
        documentationRequired:
          type: boolean
          description: If true it indicates that additional documentation is required for phone number.
          readOnly: true
          example: true
    Pagination:
      type: object
      properties:
        pageNumber:
          type: integer
          description: The current page number.
        pageSize:
          type: integer
          description: The max number of records that can be retrieved on this page.
        total:
          type: integer
          description: The total number of records.
    Links:
      type: object
      properties:
        prev:
          type: string
          description: URL of the previous page. Blank if currently on the first page.
        next:
          type: string
          description: URL of the next page. Blank if currently on the last page.
    UpdatePhoneNumber:
      type: object
      description: PhoneNumber Update request.
      properties:
        displayName:
          type: string
          description: Domestic format version of the phone number or any suitable name that will identify the number easily.
          maxLength: 255
          example: private Number
        isCallingPartyNumber:
          type: boolean
          description: Indicates whether the number is caller Id.
          example: true
        preferredMediaLocation:
          type: string
          description: Preferred media location set by tenant instead of default coming from CPaaS.
          example: US-LA
          minLength: 1
          maxLength: 7
    Countries:
      description: List of country codes.
      type: array
      items:
        type: string
        description: Country codes in ISO 3166, Alpha-2 international standard.
        example: IE
      example:
      - IE
      - UK
    AuraSyncRequest:
      type: object
      description: Aura Synchronization request.
      required:
      - entities
      properties:
        entities:
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/AuraEntity'
        name:
          type: string
          example: FullSync_SYNC_Mon Feb 27 10:13:22 GMT 2023
          maxLength: 255
          description: The name of the job. If not provided, job name is set using pattern 'FullSync_{JOBTYPE}_{GMT_DateTime}'
    AuraEntity:
      type: string
      enum:
      - AGENT
      - EXTENSION
      - VDN
      - REASONCODE_AUX
      - REASONCODE_LOGOUT
      - SYSTEM_PARAMETER_FEATURES
      description: Name of entity that need to be synchronized from Communication Manager.
      example: AGENT
    AuraSyncResponse:
      description: Aura Synchronization response to notify that sync request accepted.
      type: object
      properties:
        jobId:
          description: An unique id mapped to each Aura Synchronization job.
          type: string
          example: 55b1dc7f-38c3-48cf-9146-8cbed5622735
          minLength: 36
          maxLength: 36
          pattern: ^[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}$
        url:
          description: Details of Aura Synchronization job
          type: string
          example: /api/admin/voice/v1/accounts/HGEOAV/communication-managers/90b1dc7f-38c3-98cf-8672-8cbed5698690/jobs/55b1dc7f-38c3-48cf-9146-8cbed5622735
          maxLength: 2048
      title: AuraSyncResponse
    Extension:
      type: object
      required:
      - displayName
      - number
      description: Extension number of an Account
      properties:
        id:
          type: string
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          description: The unique 36 character internal id that represents the extension id
          readOnly: true
          format: uuid
        number:
          type: string
          example: '914565637786'
          description: The extension number in non e164 format unique per tenant.
          minLength: 4
          maxLength: 16
          pattern: ^[0-9]{4,16}$
        displayName:
          type: string
          maxLength: 255
          description: suitable name that will identify the number easily unique per tenant.
          example: Jon Extension
    ExtensionNumberPage:
      description: Paginated Extension Numbers
      type: object
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        extensions:
          type: array
          items:
            $ref: '#/components/schemas/Extension'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ABCDEF/extensions?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ABCDEF/extensions?pageNumber=3&pageSize=10
    ExtensionPage:
      type: object
      description: Extension filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ExtensionResponse'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=2&pageSize=10
    ExtensionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique Extension uuid.
          example: 1f15835f-1365-4913-acf3-0ffd0767ad6e
          readOnly: true
        number:
          type: integer
          format: int64
          description: Extension number
          example: 50003456
          minimum: 1
          maximum: 10000000000000000
        name:
          type: string
          description: Extension name
          example: Jon Extension
          maxLength: 27
        loginId:
          type: array
          items:
            type: string
            description: Extension to user id association.
            example: user@avaya.com
    Job:
      type: object
      description: Details of a single job
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
          description: The unique id of the job.
        name:
          type: string
          example: FullSync_SYNC_Mon Feb 27 10:13:22 GMT 2023
          description: The name of the job. If not provided, job name is set using pattern 'FullSync_{JOBTYPE}_{GMT_DateTime}'
        type:
          type: string
          description: The type of job.
          enum:
          - SYNC
          - INCREMENTAL_SYNC
          example: SYNC
        statusCode:
          type: string
          description: Status code of the job
          enum:
          - QUEUED
          - IN_PROGRESS
          - COMPLETED
          - TIMEOUT_FAILED
          - FAILED
          - NEEDS_ACTION
          example: IN_PROGRESS
        statusMessage:
          type: string
          description: Success or Failure message of job
          example: Synchronization completed
        createdAt:
          type: string
          readOnly: true
          format: date-time
          description: Specifies the date-time in UTC format when the job was created
          example: 2020-04-21T17:40:28z
        updatedAt:
          type: string
          readOnly: true
          format: date-time
          description: Specifies the date-time in UTC format when the job was last updated
          example: 2020-04-21T17:40:28z
    JobDetails:
      type: object
      description: Details of a single job
      properties:
        jobEntityDetails:
          type: array
          items:
            $ref: '#/components/schemas/JobEntityDetails'
    JobEntityDetails:
      type: object
      description: Details of the entities pertaining to a job
      properties:
        entityType:
          type: string
          enum:
          - AGENT
          - EXTENSION
          - VDN
          - REASONCODE_AUX
          - REASONCODE_LOGOUT
          - SYSTEM_PARAMETER_FEATURES
          description: Name of job entity
          example: AGENT
        entityStatus:
          type: string
          enum:
          - COMPLETED
          - FAILED
          - IN_PROGRESS
          - CREATED
          - UPDATED
          - DELETED
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - DELETE_IN_PROGRESS
          - NEEDS_ACTION
          description: Status of job entity
          example: COMPLETED
        entitySyncDetails:
          type: array
          items:
            $ref: '#/components/schemas/SyncEntityDetails'
    SyncEntityDetails:
      type: object
      properties:
        entityCount:
          type: integer
          format: int64
          description: The total number of objects of an entity received in job response
          example: 20
        statusCode:
          type: string
          description: Status of the job entity
          enum:
          - IN_PROGRESS
          - FAILED
          - COMPLETED
          - CREATED
          - UPDATED
          - DELETED
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - NEEDS_ACTION
          example: COMPLETED
        statusMessage:
          type: string
          description: Success or Failure message of the job entity
          example: Synchronization completed
    SyncEntityDetailsPage:
      type: object
      description: List of sync entity details data
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        syncEntityDetails:
          type: array
          items:
            $ref: '#/components/schemas/SyncEntityData'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?entityType=AGENT&pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?entityType=AGENTpageNumber=3&pageSize=10
    SyncEntityData:
      type: object
      description: Details of sync entity data
      properties:
        id:
          type: string
          readOnly: true
        entityType:
          type: string
          enum:
          - AGENT
          - EXTENSION
          - REASONCODE
          - SYSTEM_PARAMETER_FEATURES
          readOnly: true
          description: Type of the entity
          example: AGENT
        entityData:
          $ref: '#/components/schemas/EntityData'
        createdAt:
          type: string
          readOnly: true
          format: date-time
          description: Specifies the date-time in UTC format when the job was created
          example: 2020-04-21T17:40:28z
        updateAt:
          type: string
          readOnly: true
          format: date-time
          description: Specifies the date-time in UTC format when the job was created
          example: 2020-04-21T17:42:28z
        statusCode:
          type: string
          description: Status of sync entity
          enum:
          - COMPLETED
          - FAILED
          - IN_PROGRESS
          - CREATED
          - UPDATED
          - DELETED
          - CREATE_IN_PROGRESS
          - UPDATE_IN_PROGRESS
          - NEEDS_ACTION
          example: COMPLETED
        statusMessage:
          type: string
          description: Message status of sync entity
          example: Successfully synced
    EntityData:
      type: object
      description: details for entity data
      properties:
        agent:
          $ref: '#/components/schemas/AgentSyncData'
        extension:
          $ref: '#/components/schemas/ExtensionSyncData'
        reasonCode:
          $ref: '#/components/schemas/ReasonCodeSyncData'
        systemParameterFeatures:
          $ref: '#/components/schemas/SystemParameterFeaturesSyncData'
    AgentSyncData:
      type: object
      properties:
        name:
          type: string
          description: Name of agent
          example: agent001
        number:
          type: string
          description: Number assigned to agent
          example: '101'
        loginId:
          type: string
          description: Login Id of the associated user
          example: user@avaya.com
    ExtensionSyncData:
      type: object
      properties:
        name:
          type: string
          description: Name of extention
          example: extention002
        number:
          type: string
          description: Number assigned to extention
          example: '102'
    ReasonCodeSyncData:
      type: object
      properties:
        name:
          type: string
          description: Name of reason code
          example: rc001
        number:
          type: string
          description: Number of the reason code
          example: '1'
    SystemParameterFeaturesSyncData:
      type: object
      properties:
        name:
          type: string
          description: Name of system parameter feature
          example: auxWorkResonCodeType
        value:
          type: string
          description: value of System parameter feature
          example: forced
    JobPage:
      type: object
      description: List of jobs for the Communication Manager
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?pageNumber=3&pageSize=10
    LocationProfile:
      description: Location Profile
      type: object
      properties:
        id:
          type: string
          description: The unique id of Location Profile
          readOnly: true
          format: uuid
          example: 41c6ef0d-5470-406e-ace2-6dc442b99318
        name:
          type: string
          example: Profile1
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Location Profile
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        locationCode:
          type: string
          example: IN-MH
          description: 'ISO 3166-2 location code for country and region. For various country and region codes, check : https://www.iso.org/obp/ui/#search'
          minLength: 1
          maxLength: 7
        isMediaLatchingEnabled:
          type: boolean
          description: It is an indicator to enable or disable media latching feature through NGM
          example: true
          default: true
        sipServerAddressList:
          type: array
          items:
            type: string
            maxLength: 255
            pattern: ^[a-zA-Z0-9\p{L}\-\_\/\:\.\ ]+$
          minItems: 0
          maxItems: 50
          description: List of Fully-Qualified Domain-Name (FQDN) of all the SIP Server Address.
          example:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
        status:
          type: string
          description: Status of the object under operation
          readOnly: true
          enum:
          - IN_PROGRESS
          - FAILED
          - SUCCESS
          - PENDING_DELETE
          example: IN_PROGRESS
      required:
      - name
      - locationCode
    LocationProfiles:
      type: object
      description: List of Location Profile
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/LocationProfile'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=1&pageSize=3
            next: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=3&pageSize=3
    AgentLocation:
      description: Agent Location
      type: object
      properties:
        id:
          type: string
          description: The unique Id of Agent Location
          readOnly: true
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          minLength: 36
          maxLength: 36
          pattern: ^[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}$
        name:
          type: string
          description: Agent Location Name
          example: uk-1-location-id
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Agent Location
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        isDialingRestrictionEnabled:
          type: boolean
          description: It is an indicator to enable or disable Dialing Restriction
          example: true
          default: false
        users:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AgentLocationUser'
        outboundRoutingRules:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/AgentLocationOutboundRoutingRule'
      required:
      - name
      - isDialingRestrictionEnabled
    ListAgentLocation:
      description: Agent Location
      type: object
      properties:
        id:
          type: string
          description: The unique Id of Agent Location
          readOnly: true
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          minLength: 36
          maxLength: 36
          pattern: ^[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}$
        name:
          type: string
          description: Agent Location Name
          example: uk-1-location-id
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        description:
          type: string
          example: Description of the Agent Location
          maxLength: 255
          pattern: (^$|^[a-zA-Z0-9\p{L}\(\)\-\_\.\ \n]+$)
        isDialingRestrictionEnabled:
          type: boolean
          description: It is an indicator to enable or disable Dialing Restriction
          example: true
          default: false
      required:
      - name
      - isDialingRestrictionEnabled
    AgentLocationUser:
      type: object
      description: List of Users associated with Agent Location
      properties:
        userId:
          type: string
          description: The unique Id of User
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          minLength: 36
          maxLength: 36
          pattern: ^[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}$
        loginId:
          type: string
          description: User Login Id
          example: user@avaya.com
    AgentLocationOutboundRoutingRule:
      type: object
      description: List of Users associated with Agent Location
      properties:
        id:
          type: string
          description: The unique Id of Outbound Routing Rule
          example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          minLength: 36
          maxLength: 36
          pattern: ^[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}$
        name:
          type: string
          description: Outbound Routing Rule Name
          example: uk-1-location-id
          minLength: 3
          maxLength: 255
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
    AgentLocations:
      type: object
      description: List of Agent Locations
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/AgentLocation'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/v1/accounts/ASDJGE/agent-locations?pageNumber=1&pageSize=3
            next: /api/admin/v1/accounts/ASDJGE/agent-locations?pageNumber=3&pageSize=3
    ListAgentLocations:
      type: object
      description: List of Agent Locations
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/ListAgentLocation'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/v1/accounts/ASDJGE/agent-locations?pageNumber=1&pageSize=3
            next: /api/admin/v1/accounts/ASDJGE/agent-locations?pageNumber=3&pageSize=3
    CreateHybridSkill:
      title: CreateHybridSkill
      type: object
      description: Hybrid Skill for specific account and communication manager server.
      properties:
        number:
          type: string
          example: '8000'
          description: The skill unique per communication manager.
          minLength: 1
          maxLength: 4
          pattern: ^[0-9]*$
        name:
          type: string
          example: French
          minLength: 1
          maxLength: 27
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        extension:
          type: string
          example: '914565637786'
          description: The extension number of skill unique per communication manager.
          minLength: 1
          maxLength: 16
          pattern: ^[1-9][0-9]*$
        agentAssistProfileId:
          type: string
          format: uuid
          description: Agent Assist Profile ID reterived from Agent Assist service.
          example: 36c707a7-7a29-4cd7-82c0-60a61346ed29
      required:
      - number
      - name
      - extension
    HybridSkill:
      title: HybridSkill
      type: object
      description: Hybrid Skill for specific account and communication manager server.
      properties:
        id:
          type: string
          description: The unique id of Skill
          readOnly: true
          format: uuid
          example: 7700d655-5807-4738-a868-712740a18199
        number:
          type: string
          example: '8000'
          description: The skill unique per communication manager.
          minLength: 1
          maxLength: 4
          pattern: ^[0-9]*$
        name:
          type: string
          example: French
          minLength: 1
          maxLength: 27
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        extension:
          type: string
          example: '914565637786'
          description: The extension number of skill unique per communication manager.
          minLength: 1
          maxLength: 16
          pattern: ^[1-9][0-9]*$
        agentAssistProfileId:
          type: string
          format: uuid
          description: Agent Assist Profile ID reterived from Agent Assist service.
          example: 36c707a7-7a29-4cd7-82c0-60a61346ed29
      required:
      - number
      - name
      - extension
    HybridSkillPage:
      title: HybridSkillPage
      type: object
      description: Hybrid Skill filtered response
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        skills:
          type: array
          items:
            $ref: '#/components/schemas/HybridSkillResponseWithoutAgentAssistProfileId'
        links:
          allOf:
          - $ref: '#/components/schemas/Links'
          example:
            prev: /api/admin/voice/v1/accounts/{accountId}/communication-managers/{communicationManagerId}/skills?pageNumber=1&pageSize=10
            next: /api/admin/voice/v1/accounts/{accountId}/communication-managers/{communicationManagerId}/skills?pageNumber=3&pageSize=10
    HybridSkillResponse:
      title: HybridSkillResponse
      type: object
      description: Represents the model used to get details of a single Skill.
      properties:
        id:
          type: string
          description: The unique id of Skill
          readOnly: true
          format: uuid
          example: 7700d655-5807-4738-a868-712740a18199
        name:
          type: string
          example: French
          minLength: 1
          maxLength: 27
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        number:
          type: string
          example: '8000'
          minLength: 1
          maxLength: 4
          pattern: ^[0-9]*$
        extension:
          type: string
          description: The extension number of skill unique per communication manager.
          example: '914565637786'
          minLength: 1
          maxLength: 16
          pattern: ^[1-9][0-9]*$
        agentAssistProfileId:
          type: string
          format: uuid
          description: Agent Assist Profile ID reterived from Agent Assist service.
          example: 36c707a7-7a29-4cd7-82c0-60a61346ed29
        errorMessage:
          type: string
          example: Failed to delete skill
          description: The error message in case of failure from agent assist API.
    HybridSkillResponseWithoutAgentAssistProfileId:
      title: HybridSkillResponseWithoutAgentAssistProfileId
      type: object
      description: Represents the model used to get details of a single Skill.
      properties:
        id:
          type: string
          description: The unique id of Skill
          readOnly: true
          format: uuid
          example: 7700d655-5807-4738-a868-712740a18199
        name:
          type: string
          example: French
          minLength: 1
          maxLength: 27
          pattern: ^[a-zA-Z0-9\p{L}\-\_\.\ ]+$
        number:
          type: string
          example: '8000'
          minLength: 1
          maxLength: 4
          pattern: ^[0-9]*$
        extension:
          type: string
          description: The extension number of skill unique per communication manager.
          example: '914565637786'
          minLength: 1
          maxLength: 16
          pattern: ^[1-9][0-9]*$
  parameters:
    accountId:
      name: accountId
      description: The unique 6 character internal id that represents the customer account.
      required: true
      in: path
      schema:
        type: string
        minLength: 6
        maxLength: 6
        pattern: ^[a-zA-Z]{6}$
        example: ABCDEF
    avayaAuraDeviceServiceId:
      name: avayaAuraDeviceServiceId
      description: The unique id of the element
      in: path
      required: true
      schema:
        type: string
        example: 2ec20580-d204-43f3-ae0b-34795439137f
        maxLength: 36
        minLength: 36
    communicationManagerId:
      name: communicationManagerId
      description: The unique id of the Communication Manager
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 2ec20580-d204-43f3-ae0b-34795439137f
    voicePlanId:
      name: voicePlanId
      in: path
      description: Id of existing voice plan
      required: true
      schema:
        type: string
        format: uuid
        example: b428d94e-d521-424f-92dc-c87cb28b6f6b
    hybridCloudGatewayId:
      name: hybridCloudGatewayId
      description: The unique id of the Hybrid Cloud Gateway server
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    systemManagerId:
      name: systemManagerId
      description: The unique id of the System Manager server
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    systemId:
      name: systemId
      description: The unique system id of the Hybrid Cloud Gateway
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    reasonCodeId:
      name: reasonCodeId
      in: path
      description: The unique 36 character internal id for the reason code
      required: true
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174000
    elementId:
      name: elementId
      in: path
      description: The unique 36 character internal id (uuid) that represents the Element.
      required: true
      schema:
        type: string
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        minLength: 36
        maxLength: 36
        pattern: ^[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}$
    sipTrunkId:
      name: sipTrunkId
      in: path
      description: The unique 36 character internal id (uuid) that represents the Element.
      required: true
      schema:
        type: string
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        minLength: 36
        maxLength: 36
        pattern: ^[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}$
    routingRuleId:
      name: routingRuleId
      in: path
      description: The unique 36 character internal id (uuid) that represents the Element.
      required: true
      schema:
        type: string
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        minLength: 36
        maxLength: 36
        pattern: ^[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}$
    type:
      name: type
      description: The type of phone number. Acceptable values are LOCAL or TOLLFREE.
      required: true
      in: query
      schema:
        type: string
        enum:
        - LOCAL
        - TOLLFREE
        example: LOCAL
    pageNumber:
      name: pageNumber
      in: query
      description: The page number of the records to retrieve. Default value is 1.
      required: false
      schema:
        type: integer
        format: int32
        example: 1
        default: 1
        minimum: 1
    pageSize:
      name: pageSize
      in: query
      description: The max number of records to retrieve per page. Default value is 5, Any value like 5,10,15,20,25,30 is
        allowed. If value comes more than 1000 then max 1000 records will be returned.
      required: false
      schema:
        type: integer
        format: int32
        example: 5
        default: 5
        minimum: 1
        maximum: 50
    phoneNumberId:
      name: phoneNumberId
      description: The unique 36 character internal id that represents the phone number.
      required: true
      in: path
      schema:
        type: string
        minLength: 36
        maxLength: 36
        pattern: ^[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}$
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    extensionId:
      name: extensionId
      in: path
      description: The unique 36 character internal id for the extension
      required: true
      schema:
        type: string
        format: uuid
        example: 123e4567-e89b-12d3-a456-426614174000
    jobId:
      name: jobId
      in: path
      description: The unique 36 character internal id of the Job
      required: true
      schema:
        type: string
        format: uuid
        example: a4c2c9b5-0e47-491d-b139-dc48cccdea72
    locationProfileId:
      name: locationProfileId
      description: The unique id of the location Profile
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    locationId:
      name: locationId
      description: The unique Id of the Agent Location
      in: path
      required: true
      schema:
        type: string
        minLength: 36
        maxLength: 36
        pattern: ^[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}$
        example: c8c2909d-75e9-484a-94c0-b7e8d29771fe
    skillId:
      name: skillId
      in: path
      description: Id of existing skill
      required: true
      schema:
        type: string
        format: uuid
        example: 1f15835f-1365-4913-acf3-0ffd0767ad6e
    forceDelete:
      name: forceDelete
      description: To delete forcefully, set this parameter to true
      required: false
      in: query
      schema:
        type: boolean
        example: true
    orderBy:
      name: orderBy
      in: query
      required: false
      description: "Field name on which ordering needs to be performed. The default order is ascending.\n\nThe possible fields\
        \ that can be ordered on are:\n  * name\n\nField Names are case-senstive (should be written as it is in description).\n\
        \nTo specify descending order, a suffix \" desc\" should be added. For example, \"name\" for ascending or \"name desc\"\
        \ for descending\".\n"
      schema:
        type: string
        maxLength: 255
      examples:
        ascending:
          value: name
        descending:
          value: name desc
    filter:
      name: filter
      in: query
      required: false
      description: "Specifies details of a row filter.\n\n The possible fields that can be filtered on are:\n  * name\n\n\
        The allowed format:\n  - Begins with the column name to be filtered, followed by a colon, then:\n    - Either an exact\
        \ string to match, or\n    - A string expression including the * wildcard character\n      - :{PREFIX}* will be used\
        \ to find out word start with.\n      - :*{POSTFIX} will be used to find out word end with\n      - : will be used\
        \ to match exact word\n  - Begin with column name to be filtered, followed by a = operator. (this will be used to\
        \ match exact string)\n"
      schema:
        type: string
        maxLength: 255
      examples:
        exact:
          description: Example of filtering based on an exact string.
          value: name=Abc123
        prefix:
          description: Example of filtering based on a prefix string.
          value: name:AB*
        postfix:
          description: Example of filtering based on a postfix string.
          value: name:*C123
  examples:
    AvayaAuraDeviceServiceReq:
      description: Avaya Aura Device Service request model
      value:
        name: AADS
        description: AADS server for testing
        hostname: dev-11.avaya.com
        port: 443
    AvayaAuraDeviceServiceRes:
      description: A HATEOAS url response that is a reference to the created or updated AADS Element
      value:
        url: /api/admin/voice/v1/accounts/ABCDEF/avaya-aura-device-services/63c6ff9d-3370-090e-bkb2-7gh442b99985
    AvayaAuraDeviceServiceObj:
      description: Avaya Aura Device Service model
      value:
        id: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
        name: AADS
        description: AADS server for testing
        hostname: aadsserver.avaya.com
        port: 443
        openIDConnectDiscovery: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
        status: SUCCESS
    AvayaAuraDeviceServicesRes:
      description: Avaya Aura Device Services model
      value:
        resources:
        - id: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
          name: AADS
          description: AADS server for testing
          hostname: dev-11.avaya.com
          port: 443
          openIDConnectDiscovery: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
          status: SUCCESS
    OpenIDConnectDiscoveryRes:
      description: Open ID Connect Discovery model
      value:
        openIDConnectDiscovery: https://dev-11.ixcc-sandbox.avayacloud.com/auth/realms/YOPXPM/.well-known/openid-configuration
    VoicePlanPage:
      description: List of all Voice Plans
      value:
        pagination:
          pageNumber: 1
          pageSize: 10
          total: 2
        resources:
        - voicePlanId: 46a99207-a5ac-4968-b488-9c078193eba1
          name: User Voice Plan for Production
          type: USER
          userProfileId: ASEDFG
          description: User Voice plan for production Communication Manager
          agentDialPlanRange:
          - 20000:20100
          extensionDialPlanRange:
          - 30000:30100
          - 8000000:9000000
        - voicePlanId: a5ed735d-0688-47c5-872d-366a84b23536
          name: System Range for Production
          type: SYSTEM
          userProfileId: ASEDFG
          description: System Range for production Communication Manager
          reasonCodeNotReadyRange:
          - '1:20'
          - 50:99
          reasonCodeLogOutRange:
          - '1:9'
        links:
          next: /api/admin/voice/v1/accounts/GHFDWE/communication-managers/18e4f754-5e42-4387-ae13-e9b4fe4aed29/voice-plans?pageNumber=3&pageSize=10
          previous: /api/admin/voice/v1/accounts/GHFDWE/communication-managers/18e4f754-5e42-4387-ae13-e9b4fe4aed29/voice-plans?pageNumber=1&pageSize=10
    UserVoicePlanRequest:
      description: Model for a User Voice Plan
      value:
        name: User Voice Plan
        type: USER
        userProfileId: ASEDFG
        description: User Voice plan for Communication Manager
        agentDialPlanRange:
        - 20000:20100
        extensionDialPlanRange:
        - 30000:30100
        - 8000000:9000000
    SystemRangeRequest:
      description: Model for a System Range Plan model for System
      value:
        name: VoicePlan2
        type: SYSTEM
        userProfileId: ASEDFG
        description: Voice plan for Communication Manager
        reasonCodeNotReadyRange:
        - '1:20'
        - 50:99
        reasonCodeLogOutRange:
        - '1:9'
    UserVoicePlanResponse:
      description: Model for a User Voice Plan
      value:
        voicePlanId: a5ed735d-0688-47c5-872d-366a84b23536
        name: User Voice Plan
        type: USER
        userProfileId: ASEDFG
        description: User Voice plan for Communication Manager
        agentDialPlanRange:
        - 20000:20100
        extensionDialPlanRange:
        - 30000:30100
        - 8000000:9000000
    SystemRangeResponse:
      description: Model for a System Range Plan model for System
      value:
        voicePlanId: a5ed735d-0688-47c5-872d-366a84b23536
        name: VoicePlan2
        type: SYSTEM
        userProfileId: ASEDFG
        description: Voice plan for Communication Manager
        reasonCodeNotReadyRange:
        - '1:20'
        - 50:99
        reasonCodeLogOutRange:
        - '1:9'
    CommunicationManagerRequest:
      description: Request model for creating or updating a Communication Manager
      value:
        name: CM4696
        description: This is testing Communication Manager.
        hostname: dc1-cm96.avayacloud.stage
        port: '5022'
        alternateHostname: dc1-cm98.avayacloud.stage
        alternatePort: '5022'
        username: cust
        password: testpassword
        version: V10_X
        hybridCloudGatewayId: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
        enableIncrementalSync: 'true'
    CommunicationManagerAsyncResponse:
      description: A HATEOAS url that is a reference to the Communication Manager under operation.
      value:
        url: /api/admin/voice/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028
    CommunicationManagerResponse:
      description: Details of a single Communication Manager
      value:
        id: a5ed735d-0688-47c5-872d-366a84b23536
        name: CM4696
        description: This is testing Communication Manager.
        hostname: dc1-cm96.avayacloud.stage
        port: '5022'
        alternateHostname: dc1-cm98.avayacloud.stage
        alternatePort: '5022'
        username: cust
        password: testpassword
        version: V10_X
        hybridCloudGatewayId: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
        enableAutoIncrementalSync: 'true'
        status: SUCCESS
        lastOnPremChangeDetectedTime: 2020-04-21T17:40:28z
    CommunicationManagerPageResponse:
      description: List of all Communication Managers
      value:
        pagination:
          pageNumber: 1
          pageSize: 10
          total: 2
        resources:
        - id: a5ed735d-0688-47c5-872d-366a84b23536
          name: CM4696
          description: This is testing Communication Manager.
          hostname: dc1-cm96.avayacloud.stage
          port: '5022'
          alternateHostname: dc1-cm98.avayacloud.stage
          alternatePort: '5022'
          username: cust
          password: testpassword
          version: V10_X
          hybridCloudGatewayId: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
          enableAutoIncrementalSync: 'true'
          status: IN_PROGRESS
        - id: 8c21249d-b98d-408a-9537-c6141fdb57df
          name: CM132
          description: This is testing Communication Manager.
          hostname: dc3-cm32.avayacloud.stage
          port: '5022'
          username: cust
          password: testpassword
          version: V10_X
          hybridCloudGatewayId: b7f551d8-ed78-11ed-a05b-0242ac120003
          status: SUCCESS
        links:
          next: /api/admin/voice/v1/accounts/GHFDWE/communication-managers?pageNumber=3&pageSize=10
          previous: /api/admin/voice/v1/accounts/GHFDWE/communication-managers?pageNumber=1&pageSize=10
    HybridCloudGatewayRequest:
      description: Request model for creating an Avaya Hybrid Cloud Gateway
      value:
        name: AHCG123
        description: Description of the Avaya Hybrid Cloud Gateway
        systemId: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
        publicKey: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
        publicKeyAlgorithm: ES256
        locationCode: IN-MH
        sessionManagerFqdnList:
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        - sm_prod2201.avaya.com
        isMediaLatchingEnable: true
        isTermsAndConditionsAccepted: true
    AvayaHybridCloudGatewayAsyncResponse:
      description: A HATEOAS url that is a reference to the Avaya Hybrid Cloud Gateway under operation.
      value:
        url: /api/admin/voice/v1/accounts/NCWBNY/hybrid-cloud-gateways/5e9be49a-32d3-4927-83c7-7b0952798028
    HybridCloudGateways:
      description: List of all Avaya Hybrid Cloud Gateways
      value:
        resources:
        - id: 41c6ef0d-5470-406e-ace2-6dc442b99318
          name: AHCG123
          description: Description of the Avaya Hybrid Cloud Gateway
          systemId: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
          publicKey: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
          publicKeyAlgorithm: ES256
          locationCode: IN-MH
          sessionManagerFqdnList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnable: true
          isTermsAndConditionsAccepted: true
          status: SUCCESS
        - id: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
          name: HCG304
          description: Description of the Avaya Hybrid Cloud Gateway
          systemId: 04703a3a-3dfb-4606-ae79-fd0fe0be3e64
          publicKey: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
          publicKeyAlgorithm: ES256
          locationCode: IN-MH
          sessionManagerFqdnList:
          - smdev.avaya.com
          isMediaLatchingEnable: true
          isTermsAndConditionsAccepted: true
          status: IN_PROGRESS
    UpdateHybridCloudGatewayRequest:
      description: Request model for updating an Avaya Hybrid Cloud Gateway
      value:
        name: AHCG123
        description: Description of the Avaya Hybrid Cloud Gateway
        publicKey: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
        publicKeyAlgorithm: ES256
        locationCode: IN-MH
        sessionManagerFqdnList:
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        isMediaLatchingEnable: true
        isTermsAndConditionsAccepted: true
    HybridCloudGateway:
      description: Details of a single Avaya Hybrid Cloud Gateway
      value:
        id: 41c6ef0d-5470-406e-ace2-6dc442b99318
        name: AHCG123
        description: Description of the Avaya Hybrid Cloud Gateway
        systemId: fa703a3a-3dfb-4606-ae79-fd0fe0be3e64
        publicKey: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
        publicKeyAlgorithm: ES256
        locationCode: IN-MH
        sessionManagerFqdnList":
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        - sm_prod2201.avaya.com
        isMediaLatchingEnable: true
        isTermsAndConditionsAccepted: true
        status: IN_PROGRESS
    UpdateHybridCloudGatewaySystemConfig:
      description: Request model for updating an Avaya Hybrid Cloud Gateway Config
      value:
        publicKey: MIIBOgIBAAJBAKj34GkxFhD90vcNLYLInFEX6Ppy1tPf9Cnzj4p4WGeKLs1Pt8QuKUpRKfFLfRYC9AIKjbJTWit+CqvjWYzvQwECAwEAAQJAIJLixBy2qpFoS4DSmoEm
        publicKeyAlgorithm: ES256
    HybridCloudGatewaySystemResponse:
      description: Response model for updating an Avaya Hybrid Cloud Gateway Config
      value:
        status: SUCCESS
        message: Successfully updated the system configuration
    SystemManagerRequest:
      description: Request model for creating a System Manager.
      value:
        name: SMGR123
        description: Description of the System Manager
        primaryHostname: dc1-smgr96.avayacloud.stage
        username: dummyUser
        password: dummypassword
        enrollmentPassword: testpassword
        secondaryHostname: dc2-smgr97.avayacloud.stage
        activeSystemManager: PRIMARY
        useForCerts: true
    SystemManagerAsyncResponse:
      description: A HATEOAS url response that is a reference to the System Manager under operation.
      value:
        url: /api/admin/voice/v1/accounts/NCWBNY/system-managers/5e9be49a-32d3-4927-83c7-7b0952798028
    SystemManagers:
      description: Lists all System Managers
      value:
        resources:
        - id: 7700d655-5807-4738-a868-712740a18199
          name: SMGR123
          description: Description of the System Manager
          primaryHostname: dc1-smgr96.avayacloud.stage
          username: dummyUser
          password: dummypassword
          enrollmentPassword: testpassword
          secondaryHostname: dc2-smgr97.avayacloud.stage
          activeSystemManager: PRIMARY
          useForCerts: true
          status: IN_PROGRESS
        - id: 8b2ae74d-61e5-48df-8b32-81a7bc726495
          name: SmgrTest
          description: Description of the System Manager
          primaryHostname: dc2-smgr105.avayacloud.stage
          username: dummyUser
          password: dummypassword
          enrollmentPassword: testpassword
          secondaryHostname: dc1-smgr98.avayacloud.stage
          activeSystemManager: PRIMARY
          useForCerts: true
          status: SUCCESS
    UpdateSystemManagerRequest:
      description: Request model for updating a System Manager.
      value:
        name: SMGR123
        description: Description of the System Manager
        primaryHostname: dc1-smgr96.avayacloud.stage
        username: dummyUser
        password: dummypassword
        enrollmentPassword: testpassword
        secondaryHostname: dc2-smgr97.avayacloud.stage
        activeSystemManager: PRIMARY
    SystemManagerResponse:
      description: Details of single System Manager
      value:
        id: 7700d655-5807-4738-a868-712740a18199
        name: SmgrTest
        description: Description of the System Manager
        primaryHostname: dc2-smgr105.avayacloud.stage
        username: dummyUser
        password: dummypassword
        enrollmentPassword: testpassword
        secondaryHostname: dc1-smgr98.avayacloud.stage
        activeSystemManager: PRIMARY
        useForCerts: true
        status: SUCCESS
    HybridCloudManagerResponse:
      description: Hybrid Cloud Manager hostname.
      value:
        hostname: testhcm.avaya.com
    GatewayConnectionManagerResponse:
      description: 'Response model for Gateway connection manager '
      value:
        hostname: communication-services-candidate.avayacloud.com
    ErrorUnauthorized:
      description: Unauthorized
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#unauthorized
        title: Unauthorized
        status: 401
        detail: This operation requires authentication. See https://developers.avayacloud.com/onecloud-ccaas/docs/how-to-authenticate-with-ccaas-apis
    ErrorForbidden:
      description: Forbidden
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#forbidden
        title: Forbidden
        status: 403
        detail: According to the access control policy the current user does not have permission to access this resource.
    ErrorNotFound:
      description: Not Found
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found
        title: Resource Not Found
        status: 404
        detail: Either there is no API method associated with the URL path of the request, or the request refers to one or
          more resources that were not found.
    ErrorInternalServerError:
      description: Server Error
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#server-error
        title: Server Error
        status: 500
        detail: An internal server error was encountered.
    ErrorConstraintViolation:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#constraint-violation
        title: Constraint Violation
        status: 400
        detail: A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process
          this request until the client resolves the semantic errors described in the violations section.
        violations:
        - field: accountId
          message: must match "^[a-zA-Z]{6}$"
          code: 20006
    ErrorConflict:
      description: Conflict
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: Communication Manager with same name already exists.
        - field: hostname
          message: Communication Manager with same hostname already exists.
    ErrorMethodNotAllowed:
      description: Method not allowed
      value:
        title: Method not allowed
        status: 405
        detail: The request calls an HTTP method that is not supported at the resource.
    NotReadyCreateRequest:
      description: Request model for creating a Not Ready Reason Code.
      value:
        codeName: Lunch
        codeNumber: '21'
        codeType: NOT_READY
        description: Agent is on Lunch.
        isInterruptible: true
        systemDefinedAttributes:
        - WORK_ON_DIGITAL
        organizationNodeId: EXMPLE
    LogoutCreateRequest:
      description: Request model for creating a Logout Reason Code.
      value:
        codeName: Out of Office
        codeNumber: '8'
        codeType: LOGOUT
        description: Agent is out of office.
        organizationNodeId: EXMPLE
    CallWorkCodeCreateRequest:
      description: Request model for creating a Call Work Code.
      value:
        codeName: Special Sale
        codeNumber: '7345290'
        codeType: CALL_WORK_CODE
        description: Tracking sale of special items.
        organizationNodeId: EXMPLE
    NotReadyUpdateRequest:
      description: Request model for updating a Not Ready Reason Code.
      value:
        codeName: Lunch
        codeNumber: '21'
        description: Agent is on Lunch.
        isInterruptible: true
        systemDefinedAttributes:
        - WORK_ON_DIGITAL
        organizationNodeId: EXMPLE
    LogoutUpdateRequest:
      description: Request model for updating a Logout Reason Code.
      value:
        codeName: Out of Office
        codeNumber: '8'
        description: Agent is out of office.
        organizationNodeId: EXMPLE
    CallWorkCodeUpdateRequest:
      description: Request model for updating a Call Work Code.
      value:
        codeName: Special Sale
        codeNumber: '7345290'
        description: Tracking sale of special items.
        organizationNodeId: EXMPLE
    ReasonCodeAsyncResponse:
      description: A HATEOAS url response that is a reference to the Reason Code under operation.
      value:
        url: /api/admin/voice/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/reason-codes/ee2d131e-772d-4a51-acba-841f967fb9f3
    ReasonCodePageResponse:
      description: Lists all Reason Codes belonging to a particular type.
      value:
        pagination:
          pageNumber: 2
          pageSize: 10
          total: 20
        resources:
        - reasonCodeId: 123e4567-e89b-12d3-a456-426614174000
          codeName: Work on Digital
          codeNumber: '89'
          codeType: NOT_READY
          isInterruptible: true
          systemDefinedAttributes:
          - WORK_ON_DIGITAL
          organizationNodeId: EXMPLE
          status: SUCCESS
        - reasonCodeId: 8b2ae74d-61e5-48df-8b32-81a7bc726495
          codeName: Unreachable
          codeNumber: '88'
          codeType: NOT_READY
          description: Agent is unreachable
          isInterruptible: false
          systemDefinedAttributes:
          - REDIRECTION_ON_OPTIM_FAILURE
          organizationNodeId: EXMPLE
          status: SUCCESS
        links:
          prev: /api/admin/voice/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/reason-codes?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/reason-codes?pageNumber=3&pageSize=10
    ReasonCodeResponse:
      description: Details of a single Reason Code
      value:
        reasonCodeId: 8b2ae74d-61e5-48df-8b32-81a7bc726495
        codeName: Unreachable
        codeNumber: '88'
        codeType: NOT_READY
        description: Agent is unreachable
        isInterruptible: false
        systemDefinedAttributes:
        - REDIRECTION_ON_OPTIM_FAILURE
        organizationNodeId: EXMPLE
        status: SUCCESS
    ACORequest:
      value:
        name: Avaya Cloud Office
        environment: Production
        description: Avaya Cloud Office Description
        didNumbers:
        - '+16062128688'
        - '+12702289911'
        isChatEnabled: true
        isExtensionCalling: false
        presenceApplicationType: AVAYA_CLOUD_OFFICE
    ACOResponse:
      value:
        elementId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        name: Avaya Cloud Office
        environment: Production
        description: Avaya Cloud Office Description
        didNumbers:
        - '+16062128688'
        - '+12702289911'
        isChatEnabled: true
        isExtensionCalling: false
        elementType: ACO
        status: SUCCESS
        presenceApplicationType: AVAYA_CLOUD_OFFICE
    ACOSIPTrunkResponse:
      value:
        elementId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        name: ACO-Trunk-US
        type: ACO
        provider: RingCentral
        description: Avaya Cloud Office(ACO) SIP Trunk description
        providerDomain: exchange.com
        inboundDomain: inbound.companyXYZ.com
        preferredMediaLocation: US-LA
        status: SUCCESS
    MSTeamsRequest:
      value:
        name: MS Teams Server
        description: MS Teams Server description
        didNumbers:
        - '+16062128688'
        - '+12702289911'
        domain: exchange.com
        isChatEnabled: false
        clientId: bv34503f-543e-232a-43ac-77e2b25797ea
    MSTeamsResponse:
      value:
        elementId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        name: MS Teams Server
        description: MS Teams Server description
        didNumbers:
        - '+16062128688'
        - '+12702289911'
        domain: exchange.com
        elementType: MSTeams
        status: SUCCESS
        isChatEnabled: false
        clientId: bv34503f-543e-232a-43ac-77e2b25797ea
    MSTeamsSIPTrunkResponse:
      value:
        elementId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        name: MSTeams-Trunk-US
        description: Microsoft Teams SIP Trunk description
        type: MST
        provider: MicrosoftTeams
        providerDomain: exchange.com
        inboundDomain: inbound.companyXYZ.com
        preferredMediaLocation: US-LA
        status: SUCCESS
    MSTeamsSIPTrunkAsyncResponse:
      description: A HATEOAS url response that is a reference to the Microsoft Teams SIP Trunk under operation.
      value:
        url: /v1/accounts/NCWBNY/msteams-sip-trunk-elements/5e9be49a-32d3-4927-83c7-7b0952798028
    ErrorACOExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: An Avaya Cloud Office with this name already exists
    ErrorMSTeamsExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: name
          message: A MS Teams with this name already exists
    AvailableCountries:
      description: Available Countries response
      value:
      - IE
      - UK
    PhoneNumberRequest:
      description: PhoneNumber create request
      value:
        phoneNumber: '+16479308804'
        displayName: private Number
        countryCode: US
        isCallingPartyNumber: true
    PhoneNumberUpdateRequest:
      description: PhoneNumber update request
      value:
        displayName: private Number
        isCallingPartyNumber: true
        preferredMediaLocation: US-LA
    PhoneNumberUpdateResponse:
      description: PhoneNumber update response
      value:
        phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        countryCode: US
        type: LOCAL
        isCallingPartyNumber: true
        accountId: ABCDEF
        status: INACTIVE
        statusMessage: Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate it.
        preferredMediaLocation: US-LA
    PhoneNumberInProgressResponse:
      description: PhoneNumber InProgress Response
      value:
        phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: UNKNOWN
        accountId: ABCDEF
        status: INPROGRESS
    PhoneNumberFailedResponse:
      description: PhoneNumber Failed Response
      value:
        phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: LOCAL
        accountId: ABCDEF
        status: FAILED
        statusMessage: Internal Server Error
        preferredMediaLocation: US-LA
    PhoneNumberInActiveResponse:
      description: PhoneNumber InActive Response
      value:
        phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: LOCAL
        accountId: ABCDEF
        status: INACTIVE
        statusMessage: Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate it.
        preferredMediaLocation: US-LA
    PhoneNumberActiveResponse:
      description: PhoneNumber Active Response
      value:
        phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: LOCAL
        accountId: ABCDEF
        status: ACTIVE
        preferredMediaLocation: US-LA
    PhoneNumberDisabledResponse:
      description: PhoneNumber Disabled Response
      value:
        phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: LOCAL
        accountId: ABCDEF
        status: DISABLED
        preferredMediaLocation: US-LA
    UpdateOutboundRoutingRule:
      description: Outbound Number Routing Rule Request
      value:
        type: NUMBER_PREFIX
        priority: 5
        prefix: '+44'
        minLength: 1
        maxLength: 50
        sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        isoCountry: IN-MH
        locationIds:
        - c8c2909d-75e9-484a-94c0-b7e8d29771fe
    OutboundRoutingRuleResponse:
      value:
        id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        type: NUMBER_PREFIX
        priority: 1
        prefix: '+1'
        minLength: 1
        maxLength: 50
        sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        isoCountry: IN-MH
        locationIds:
        - c8c2909d-75e9-484a-94c0-b7e8d29771fe
    OutboundRoutingRules:
      value:
        type: NUMBER_PREFIX
        priority: 1
        prefix: '+1'
        minLength: 1
        maxLength: 50
        sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        isoCountry: IN-MH
        locationIds:
        - c8c2909d-75e9-484a-94c0-b7e8d29771fe
    OutboundRoutingRulePageResponse:
      value:
        pagination:
          pageNumber: 1
          pageSize: 3
          total: 10
        outboundRoutingRules:
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          type: NUMBER_PREFIX
          priority: 1
          prefix: '+1'
          minLength: 1
          maxLength: 50
          sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          isoCountry: IN-MH
          locationIds:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771ff
          type: NUMBER_PREFIX
          priority: 2
          prefix: '+1'
          minLength: 1
          maxLength: 50
          sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771ff
          callerId: c8c2909d-75e9-484a-94c0-b7e8d29771ff
          isoCountry: IN-MH
          locationIds:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771fg
          type: NUMBER_PREFIX
          priority: 3
          prefix: '+1'
          minLength: 1
          maxLength: 50
          sipTrunkId: c8c2909d-75e9-484a-94c0-b7e8d29771fg
          callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fg
          isoCountry: IN-MH
          locationIds:
          - c8c2909d-75e9-484a-94c0-b7e8d29771fe
        links:
          prev: /api/admin/v1/accounts/ASDJGE/outbound-routing-rules?pageNumber=1&pageSize=3
          next: /api/admin/v1/accounts/ASDJGE/outbound-routing-rules?pageNumber=3&pageSize=3
    AvailablePhoneNumberPage:
      description: "Paginated Phone Number Data\n Notice from response, the field documentationRequired indicates if the activation\
        \ of this number will be required. If required, you should send necessary documents to siptrunksupport@avaya.com to\
        \ activate it.\n"
      value:
        pagination:
          pageNumber: 2
          pageSize: 10
          total: 45
        phoneNumbers:
        - phoneNumber: '+16479308804'
          countryCode: US
          type: LOCAL
          documentationRequired: true
        links:
          prev: /api/admin/voice/v1/accounts/ABCDEF/available-phone-numbers?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/ABCDEF/available-phone-numbers?pageNumber=3&pageSize=10
    PhoneNumberPage:
      description: Paginated Phone Number Data
      value:
        pagination:
          pageNumber: 2
          pageSize: 10
          total: 45
        phoneNumbers:
        - phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          phoneNumber: '+16479308804'
          displayName: private Number
          isCallingPartyNumber: true
          countryCode: US
          type: LOCAL
          accountId: ABCDEF
          status: INACTIVE
          statusMessage: Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate
            it.
          preferredMediaLocation: US-LA
        links:
          prev: /api/admin/voice/v1/accounts/ABCDEF/phone-numbers?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/ABCDEF/phone-numbers?pageNumber=3&pageSize=10
    ErrorPhoneNumberExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: phoneNumber
          message: Number already exists
    ErrorOutboundDuplicatePriorityExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: priority
          message: Priority already exists
    AuraSyncRequest:
      description: 'Aura Synchronization request example

        '
      value:
        entities:
        - AGENT
        name: Test_Full_Sync
    AuraSyncResponse:
      description: 'Aura Sync response example

        '
      value:
        jobId: 55b1dc7f-38c3-48cf-9146-8cbed5622735
        url: /api/admin/voice/v1/accounts/HGEOAV/communication-managers/90b1dc7f-38c3-98cf-8672-8cbed5698690/jobs/55b1dc7f-38c3-48cf-9146-8cbed5622735
    ExtensionPage:
      description: 'Paginated extension response

        '
      value:
        pagination:
          pageNumber: 1
          pageSize: 10
          total: 40
        resources:
        - id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
          number: 50003456
          name: Jon Extension
          loginId:
          - user@avaya.com
        links:
          prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/extensions?pageNumber=2&pageSize=10
    JobDetailsResponse:
      description: Details of a single job
      value:
        jobEntityDetails:
        - entityType: AGENT
          entityStatus: COMPLETED
          entitySyncDetails:
          - entityCount: 20
            statusCode: COMPLETED
            statusMessage: Synchronization completed successfully
          - entityCount: 2
            statusCode: FAILED
            statusMessage: Synchronization failed because of incorrect domain name.
          - entityCount: 5
            statusCode: IN_PROGRESS
            statusMessage: Synchronization is in progress.
          - entityCount: 5
            statusCode: CREATED
            statusMessage: Synchronization completed successfully
          - entityCount: 5
            statusCode: UPDATED
            statusMessage: Synchronization completed successfully
          - entityCount: 5
            statusCode: CREATE_IN_PROGRESS
            statusMessage: Synchronization create is in progress.
          - entityCount: 5
            statusCode: UPDATE_IN_PROGRESS
            statusMessage: Synchronization update is in progress.
          - entityCount: 5
            statusCode: DELETED
            statusMessage: Synchronization completed successfully
          - entityCount: 5
            statusCode: NEEDS_ACTION
            statusMessage: Synchronization needs action.
    SyncEntityDetailsResponse:
      description: Details of a sync entity data
      value:
        pagination:
          pageNumber: 2
          pageSize: 2
          total: 3
        syncEntityDetails:
        - id: fa703a3a-3dfb-4606-ae79-fd0fe0df3e64
          createdAt: 2020-04-21T17:40:28z
          updateAt: 2020-04-21T17:40:29z
          entityType: AGENT
          entityData:
            agent:
              name: agent101
              number: '101'
              loginId: user@avaya.com
          statusCode: COMPLETED
          statusMessage: Synchronized successfully
        - id: pk703a3a-3dfb-4606-ae79-fd0fe0be3e98
          createdAt: 2020-04-21T17:40:45z
          updateAt: 2020-04-21T17:40:56z
          entityType: AGENT
          entityData:
            agent:
              name: agent101
              number: '101'
              loginId: user@avaya.com
          statusCode: COMPLETED
          statusMessage: Synchronized successfully
        links:
          prev: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?entityType?AGENT&pageNumber=1&pageSize=2
          next: /api/admin/voice/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?entityType?AGENT&pageNumber=3&pageSize=2
    JobResponse:
      description: Single job response
      value:
        id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
        name: FullSync_SYNC_Mon Feb 27 10:13:22 GMT 2023
        type: SYNC
        statusCode: COMPLETED
        statusMessage: Synchronization completed
        createdAt: 2020-04-21T17:40:28z
        updatedAt: 2020-04-21T18:30:28z
    JobPageResponse:
      description: Jobs List Example
      value:
        pagination:
          pageNumber: 2
          pageSize: 2
          total: 3
        jobs:
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          name: FullSync_SYNC_Mon Feb 27 10:13:22 GMT 2023
          type: SYNC
          statusCode: COMPLETED
          statusMessage: Synchronization completed
          createdAt: 2020-04-21T17:40:28z
          updatedAt: 2020-04-21T18:30:28z
        links:
          prev: /api/admin/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?pageNumber=1&pageSize=2
          next: /api/admin/v1/accounts/ASDJGE/communication-managers/a4c2c9b5-0e47-491d-b139-dc48cccdea72/jobs?pageNumber=3&pageSize=2
    LocationProfileRequest:
      description: Request model for creating and Updating an Location Profile
      value:
        name: Location Profile US
        description: Location Profile for US
        locationCode: IN-MH
        sipServerAddressList:
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        - sm_prod2201.avaya.com
        isMediaLatchingEnabled: true
    LocationProfileResponse:
      description: Response model for get an Location Profile
      value:
        id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
        name: Location Profile US
        description: Location Profile for US
        locationCode: IN-MH
        sipServerAddressList:
        - sm1906.avaya.com
        - sm-stage224.avaya.com
        - sm_prod2201.avaya.com
        isMediaLatchingEnabled: true
        status: FAILED
    LocationProfileAsyncResponse:
      description: A url response that is a reference to the Location Profile under operation.
      value:
        url: /api/admin/voice/v1/accounts/NCWBNY/location-profiles/5e9be49a-32d3-4927-83c7-7b0952798028
    LocationProfiles:
      description: Location Profiles List Example
      value:
        pagination:
          pageNumber: 2
          pageSize: 3
          total: 10
        profiles:
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          name: Location Profile1
          description: Location Profile 1
          locationCode: IN-MH
          sipServerAddressList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnabled: true
          status: SUCCESS
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed30
          name: Location Profile2
          description: Location Profile 2
          locationCode: IN-MH
          sipServerAddressList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnabled: true
          status: IN_PROGRESS
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed31
          name: Location Profile3
          description: Location Profile 3
          locationCode: IN-MH
          sipServerAddressList:
          - sm1906.avaya.com
          - sm-stage224.avaya.com
          - sm_prod2201.avaya.com
          isMediaLatchingEnabled: false
          status: FAILED
        links:
          prev: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=1&pageSize=3
          next: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=3&pageSize=3
    AgentLocationRequest:
      description: Request model for creating and Updating an Agent Location
      value:
        name: uk-1-location-id
        description: UK Agent Location 1
        isDialingRestrictionEnabled: true
        users:
        - userId: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          loginId: johndoe1@test.com
        - userId: 18e4f754-5e42-4387-ae13-e9b4fe4aed30
          loginId: johndoe2@test.com
        outboundRoutingRules:
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          name: Outbound Rule
    AgentLocationResponse:
      description: Response model for get an Agent Location
      value:
        id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
        name: uk-1-location-id
        description: UK Agent Location 1
        isDialingRestrictionEnabled: true
        users:
        - userId: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          loginId: johndoe1@test.com
        - userId: 18e4f754-5e42-4387-ae13-e9b4fe4aed30
          loginId: johndoe2@test.com
        outboundRoutingRules:
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          name: Outbound Rule
    AgentLocations:
      description: Agent Locations List Example
      value:
        pagination:
          pageNumber: 2
          pageSize: 3
          total: 10
        locations:
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
          name: uk-1-location-id
          description: UK Agent Location 1
          isDialingRestrictionEnabled: true
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed30
          name: france-location-id
          description: France Agent Location 1
          isDialingRestrictionEnabled: false
        - id: 18e4f754-5e42-4387-ae13-e9b4fe4aed31
          name: uk-2-location-id
          description: UK Agent Location 2
          isDialingRestrictionEnabled: true
        links:
          prev: /api/admin/v1/accounts/ASDJGE/agent-locations?pageNumber=1&pageSize=3
          next: /api/admin/v1/accounts/ASDJGE/agent-locations?pageNumber=3&pageSize=3
    SipTrunkPageResponse:
      value:
        pagination:
          pageNumber: 1
          pageSize: 3
          total: 10
        sipTrunks:
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          type: BYOC
          seqNumber: 1
          provider: umhgjt.eu.cc.avayacloud.com
          providerDomain: ringcentral.eu.cc.avayacloud.com
          trunkName: trunk1.umhgjt.eu.cc.avayacloud.com
          outboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
          inboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
          releaseMediaAnchorDuringTransfer: false
          preferredMediaLocation: AL-01
          callerId: c8c2909d-75e9-484a-94c0-b7e8d297735f
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          type: BYOC
          seqNumber: 1
          provider: umhgjt.eu.cc.avayacloud.com
          providerDomain: ringcentral.eu.cc.avayacloud.com
          trunkName: trunk1.umhgjt.eu.cc.avayacloud.com
          outboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
          inboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
          releaseMediaAnchorDuringTransfer: false
          preferredMediaLocation: AL-01
          callerId: c8c2909d-75e9-484a-94c0-b7e8d29771f8
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
          type: MSTEAMS_SIP_TRUNK
          provider: umhgjt.eu.cc.avayacloud.com
          providerDomain: ringcentral.eu.cc.avayacloud.com
          trunkName: trunk1.umhgjt.eu.cc.avayacloud.com
          outboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
          inboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
          preferredMediaLocation: AL-01
          callerId: c8c2909d-75e9-484a-94c0-b7e8d29771fg
        links:
          prev: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=1&pageSize=3
          next: /api/admin/v1/accounts/ASDJGE/location-profiles?pageNumber=3&pageSize=3
    SipTrunkUpdateRequest:
      value:
        callerId: c8c2909d-75e9-484a-94c0-b7e8d297735f
        isDefault: true
    SipTrunkUpdateResponse:
      value:
        id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        type: BYOC
        seqNumber: 1
        provider: umhgjt.eu.cc.avayacloud.com
        providerDomain: ringcentral.eu.cc.avayacloud.com
        trunkName: trunk1.umhgjt.eu.cc.avayacloud.com
        outboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
        inboundDomain: trunk1.umhgjt.eu.cc.avayacloud.com
        releaseMediaAnchorDuringTransfer: false
        preferredMediaLocation: AL-01
        callerId: c8c2909d-75e9-484a-94c0-b7e8d297735f
        isDefault: true
    ExtensionRequest:
      description: Request model for updating an Extension Number
      value:
        number: '914565637786'
        displayName: Jon Extension
    ExtensionResponse:
      description: Response model for updating an Extension Number
      value:
        id: 18e4f754-5e42-4387-ae13-e9b4fe4aed29
        number: '914565637786'
        displayName: Jon Extension
    ErrorExtensionExists:
      description: Constraint Violation
      value:
        type: https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#conflict
        title: Conflict
        status: 409
        detail: A resource with the same unique constraint values already exists.
        violations:
        - field: extension
          message: Extension already exists
    ExtensionNumberPage:
      description: Paginated Extension Number Data
      value:
        pagination:
          pageNumber: 2
          pageSize: 10
          total: 45
        extensions:
        - id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
          number: '914565637786'
          displayName: Jon Extension
        links:
          prev: /api/admin/voice/v1/accounts/ABCDEF/extensions?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/ABCDEF/extensions?pageNumber=3&pageSize=10
    PhoneNumberListRequest:
      description: Phone Number List Request
      value:
      - c8c2909d-75e9-484a-94c0-b7e8d29771fe
      - 1f15835f-1365-4913-acf3-0ffd0767ad6e
    PhoneNumberListResponse:
      description: Phone Number List Response
      value:
      - phoneNumberId: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        phoneNumber: '+16479308804'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: LOCAL
        accountId: ABCDEF
        status: INACTIVE
        statusMessage: Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate it.
        preferredMediaLocation: US-LA
      - phoneNumberId: 1f15835f-1365-4913-acf3-0ffd0767ad6e
        phoneNumber: '+16479902347'
        displayName: private Number
        isCallingPartyNumber: true
        countryCode: US
        type: LOCAL
        accountId: ABCDEF
        status: INACTIVE
        statusMessage: Verification needed. Please send the necessary documents to siptrunksupport@avaya.com to activate it.
        preferredMediaLocation: US-LA
    PhoneNumberValidateRequest:
      description: Phone Number List Request
      value:
      - c8c2909d-75e9-484a-94c0-b7e8d29771fe
      - 1f15835f-1365-4913-acf3-0ffd0767ad6e
      - 1d033683-f1cc-477d-a190-a6d10d8a686d
      - c96c4d34-57fa-4256-8dc3-5f66252acb99
    PhoneNumberValidateResponse:
      value:
        valid:
        - id: c8c2909d-75e9-484a-94c0-b7e8d29771fe
        - id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
        invalid:
        - id: 1d033683-f1cc-477d-a190-a6d10d8a686d
          message: Phone number doesn't exist or disabled
        - id: c96c4d34-57fa-4256-8dc3-5f66252acb99
          message: Phone number doesn't exist or disabled
    PhoneNumbersDetailsRequest:
      description: Get By Phone Numbers Request
      value:
      - '+1675904984'
      - '+1923678899'
    HybridSkillRequest:
      description: Request model for creating a Skill.
      value:
        name: French
        number: '1'
        extension: '253647784'
        agentAssistProfileId: 1f15835f-1365-4913-acf3-0ffd0767ad6e
    HybridSkillResponse:
      description: Single skill response
      value:
        id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
        number: '8000'
        name: French
        extension: '253647784'
        agentAssistProfileId: 6a305019-a43c-4ed4-8dab-324d82dd9d55
    UpdateHybridSkillRequest:
      description: Request model for updating a Skill.
      value:
        name: French
        number: '1'
        extension: '253647784'
        agentAssistProfileId: 1f15835f-1365-4913-acf3-0ffd0767ad6e
    HybridSkillPageResponse:
      description: Lists all Skills.
      value:
        pagination:
          pageNumber: 2
          pageSize: 10
          total: 20
        skills:
        - id: 7700d655-5807-4738-a868-712740a18199
          name: French
          number: '11'
          extension: '253647784'
        - id: 8b2ae74d-61e5-48df-8b32-81a7bc726495
          name: English
          number: '12'
          extension: '253647784'
        links:
          prev: /api/admin/voice/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/skills?pageNumber=1&pageSize=10
          next: /api/admin/voice/v1/accounts/NCWBNY/communication-managers/5e9be49a-32d3-4927-83c7-7b0952798028/skills?pageNumber=3&pageSize=10
    HybridSkill:
      description: Single skill response
      value:
        id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
        number: '8000'
        name: French
        extension: '253647784'
        agentAssistProfileId: 6a305019-a43c-4ed4-8dab-324d82dd9d55
        errorMessage: ''
    HybridSkillResponsePartial:
      description: Single skill response
      value:
        id: 1f15835f-1365-4913-acf3-0ffd0767ad6e
        number: '8000'
        name: French
        extension: '253647784'
        agentAssistProfileId: 6a305019-a43c-4ed4-8dab-324d82dd9d55
        errorMessage: Failure in agent assist API while skill creation