From 175ad0a64daacfde52bb7ea20da88b25d2a94f19 Mon Sep 17 00:00:00 2001 From: Heli Wang Date: Fri, 2 Oct 2020 12:19:39 -0700 Subject: [PATCH] refresh swagger link and auto generated code (#14210) --- ..._number_administration_operations_async.py | 10 +- .../_phonenumber/_generated/models/_models.py | 8 +- .../_generated/models/_models_py3.py | 8 +- ..._phone_number_administration_operations.py | 10 +- .../swagger/PHONE_NUMBER_SWAGGER.md | 2 +- .../swagger/phone_number_swagger.json | 2056 ----------------- 6 files changed, 19 insertions(+), 2075 deletions(-) delete mode 100644 sdk/communication/azure-communication-administration/swagger/phone_number_swagger.json diff --git a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/aio/operations_async/_phone_number_administration_operations_async.py b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/aio/operations_async/_phone_number_administration_operations_async.py index ab0e61661d5c..2e4075a2f4bc 100644 --- a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/aio/operations_async/_phone_number_administration_operations_async.py +++ b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/aio/operations_async/_phone_number_administration_operations_async.py @@ -51,7 +51,7 @@ def get_all_phone_numbers( Gets the list of the acquired phone numbers. - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param skip: An optional parameter for how many entries to skip, for pagination purposes. :type skip: int @@ -331,7 +331,7 @@ def get_all_supported_countries( Gets a list of supported countries. - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param skip: An optional parameter for how many entries to skip, for pagination purposes. :type skip: int @@ -607,7 +607,7 @@ def get_phone_plan_groups( :param country_code: The ISO 3166-2 country code. :type country_code: str - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param include_rate_information: :type include_rate_information: bool @@ -704,7 +704,7 @@ def get_phone_plans( :type country_code: str :param phone_plan_group_id: :type phone_plan_group_id: str - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param skip: An optional parameter for how many entries to skip, for pagination purposes. :type skip: int @@ -800,7 +800,7 @@ async def get_phone_plan_location_options( :type phone_plan_group_id: str :param phone_plan_id: :type phone_plan_id: str - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :keyword callable cls: A custom type or function that will be passed the direct response :return: LocationOptionsResponse, or the result of cls(response) diff --git a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models.py b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models.py index fbee8df11556..0f9531291bae 100644 --- a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models.py +++ b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models.py @@ -281,7 +281,7 @@ def __init__( class LocationOptionsDetails(msrest.serialization.Model): - """Represents location options deatils. + """Represents location options details. :param name: The name of the location options. :type name: str @@ -527,7 +527,7 @@ def __init__( class PhoneNumberEntities(msrest.serialization.Model): - """Represents a list of searchs or releases, as part of the response when fetching all searches or releases. + """Represents a list of searches or releases, as part of the response when fetching all searches or releases. :param entities: The underlying list of entities. :type entities: list[~azure.communication.administration.models.PhoneNumberEntity] @@ -552,7 +552,7 @@ def __init__( class PhoneNumberEntity(msrest.serialization.Model): """Represents a phone number entity, as part of the response when calling get all searches or releases. - :param id: The id of the entity. It is the search id of a searc. It is the release id of a + :param id: The id of the entity. It is the search id of a search. It is the release id of a release. :type id: str :param created_at: Date and time the entity is created. @@ -1025,7 +1025,7 @@ def __init__( class UpdatePhoneNumberCapabilitiesResponse(msrest.serialization.Model): """Response for getting a phone number update capabilities. - :param capabilities_update_id: The id of the phone number capabilties update. + :param capabilities_update_id: The id of the phone number capabilities update. :type capabilities_update_id: str :param created_at: The time the capabilities update was created. :type created_at: ~datetime.datetime diff --git a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models_py3.py b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models_py3.py index b798bad2aceb..78a269c7f21c 100644 --- a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models_py3.py +++ b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/models/_models_py3.py @@ -321,7 +321,7 @@ def __init__( class LocationOptionsDetails(msrest.serialization.Model): - """Represents location options deatils. + """Represents location options details. :param name: The name of the location options. :type name: str @@ -594,7 +594,7 @@ def __init__( class PhoneNumberEntities(msrest.serialization.Model): - """Represents a list of searchs or releases, as part of the response when fetching all searches or releases. + """Represents a list of searches or releases, as part of the response when fetching all searches or releases. :param entities: The underlying list of entities. :type entities: list[~azure.communication.administration.models.PhoneNumberEntity] @@ -622,7 +622,7 @@ def __init__( class PhoneNumberEntity(msrest.serialization.Model): """Represents a phone number entity, as part of the response when calling get all searches or releases. - :param id: The id of the entity. It is the search id of a searc. It is the release id of a + :param id: The id of the entity. It is the search id of a search. It is the release id of a release. :type id: str :param created_at: Date and time the entity is created. @@ -1160,7 +1160,7 @@ def __init__( class UpdatePhoneNumberCapabilitiesResponse(msrest.serialization.Model): """Response for getting a phone number update capabilities. - :param capabilities_update_id: The id of the phone number capabilties update. + :param capabilities_update_id: The id of the phone number capabilities update. :type capabilities_update_id: str :param created_at: The time the capabilities update was created. :type created_at: ~datetime.datetime diff --git a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/operations/_phone_number_administration_operations.py b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/operations/_phone_number_administration_operations.py index f26cdc45f7fb..9357db8f9280 100644 --- a/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/operations/_phone_number_administration_operations.py +++ b/sdk/communication/azure-communication-administration/azure/communication/administration/_phonenumber/_generated/operations/_phone_number_administration_operations.py @@ -56,7 +56,7 @@ def get_all_phone_numbers( Gets the list of the acquired phone numbers. - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param skip: An optional parameter for how many entries to skip, for pagination purposes. :type skip: int @@ -340,7 +340,7 @@ def get_all_supported_countries( Gets a list of supported countries. - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param skip: An optional parameter for how many entries to skip, for pagination purposes. :type skip: int @@ -620,7 +620,7 @@ def get_phone_plan_groups( :param country_code: The ISO 3166-2 country code. :type country_code: str - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param include_rate_information: :type include_rate_information: bool @@ -718,7 +718,7 @@ def get_phone_plans( :type country_code: str :param phone_plan_group_id: :type phone_plan_group_id: str - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :param skip: An optional parameter for how many entries to skip, for pagination purposes. :type skip: int @@ -815,7 +815,7 @@ def get_phone_plan_location_options( :type phone_plan_group_id: str :param phone_plan_id: :type phone_plan_id: str - :param locale: A language-locale pairing which will be used to localise the names of countries. + :param locale: A language-locale pairing which will be used to localize the names of countries. :type locale: str :keyword callable cls: A custom type or function that will be passed the direct response :return: LocationOptionsResponse, or the result of cls(response) diff --git a/sdk/communication/azure-communication-administration/swagger/PHONE_NUMBER_SWAGGER.md b/sdk/communication/azure-communication-administration/swagger/PHONE_NUMBER_SWAGGER.md index 0948bd41e91b..328a5058cf13 100644 --- a/sdk/communication/azure-communication-administration/swagger/PHONE_NUMBER_SWAGGER.md +++ b/sdk/communication/azure-communication-administration/swagger/PHONE_NUMBER_SWAGGER.md @@ -10,7 +10,7 @@ autorest ./PHONE_NUMBER_SWAGGER.md ### Settings ``` yaml -input-file: ./phone_number_swagger.json +input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/257f060be8b60d8468584682aa2d71b1faa5f82c/specification/communication/data-plane/Microsoft.CommunicationServicesAdministration/preview/2020-07-20-preview1/communicationservicesadministration.json output-folder: ../azure/communication/administration/_phonenumber/_generated namespace: azure.communication.administration license-header: MICROSOFT_MIT_NO_VERSION diff --git a/sdk/communication/azure-communication-administration/swagger/phone_number_swagger.json b/sdk/communication/azure-communication-administration/swagger/phone_number_swagger.json deleted file mode 100644 index ef652de3adaa..000000000000 --- a/sdk/communication/azure-communication-administration/swagger/phone_number_swagger.json +++ /dev/null @@ -1,2056 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Phone Number Administration Service", - "description": "Phone Number Administration Service", - "contact": { - "email": "acsdevexdisc@microsoft.com" - }, - "version": "2020-07-20-preview1" - }, - "paths": { - "/administration/phonenumbers/phonenumbers": { - "get": { - "tags": [ - "AcquiredNumbers" - ], - "summary": "Gets the list of the acquired phone numbers.", - "operationId": "PhoneNumberAdministration_GetAllPhoneNumbers", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "locale", - "description": "A language-locale pairing which will be used to localise the names of countries", - "type": "string", - "default": "en-US" - }, - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "take", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AcquiredPhoneNumbers" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "phoneNumbers" - }, - "x-ms-examples": { - "List acquired phone numbers": { - "$ref": "./examples/GetAcquiredPhoneNumbersAsync.json" - } - } - } - }, - "/administration/phonenumbers/countries/{countryCode}/areacodes": { - "post": { - "tags": [ - "AreaCodes" - ], - "summary": "Gets a list of the supported area codes", - "operationId": "PhoneNumberAdministration_GetAllAreaCodes", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "locationType", - "description": "The type of location information required by the plan.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "countryCode", - "description": "The ISO 3166-2 country code", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "phonePlanId", - "description": "The plan id from which to search area codes.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Location options for when location type is selection.", - "schema": { - "$ref": "#/definitions/LocationOptionsQueries" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/AreaCodes" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get area codes": { - "$ref": "./examples/GetAreaCodesAsync.json" - } - } - } - }, - "/administration/phonenumbers/capabilities/{capabilitiesUpdateId}": { - "get": { - "tags": [ - "Capabilities" - ], - "summary": "Get capabilities by capabilities update id.", - "operationId": "PhoneNumberAdministration_GetCapabilitiesUpdate", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "capabilitiesUpdateId", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/UpdatePhoneNumberCapabilitiesResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get number capabilities update": { - "$ref": "./examples/GetNumberCapabilitiesUpdateAsync.json" - } - } - } - }, - "/administration/phonenumbers/capabilities": { - "post": { - "tags": [ - "Capabilities" - ], - "summary": "Adds or removes phone number capabilities", - "operationId": "PhoneNumberAdministration_UpdateCapabilities", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "", - "schema": { - "$ref": "#/definitions/UpdateNumberCapabilitiesRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/UpdateNumberCapabilitiesResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update number capabilities": { - "$ref": "./examples/UpdateNumberCapabilitiesAsync.json" - } - } - } - }, - "/administration/phonenumbers/countries": { - "get": { - "tags": [ - "Countries" - ], - "summary": "Gets a list of supported countries", - "operationId": "PhoneNumberAdministration_GetAllSupportedCountries", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "locale", - "description": "A language-locale pairing which will be used to localise the names of countries", - "type": "string", - "default": "en-US" - }, - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "take", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhoneNumberCountries" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "countries" - }, - "x-ms-examples": { - "Get countries": { - "$ref": "./examples/GetCountriesAsync.json" - } - } - } - }, - "/administration/phonenumbers/numberconfiguration": { - "post": { - "tags": [ - "NumberConfiguration" - ], - "summary": "Endpoint for getting number configurations", - "operationId": "PhoneNumberAdministration_GetNumberConfiguration", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The phone number whose configuration is to be fetched", - "schema": { - "$ref": "#/definitions/NumberConfigurationPhoneNumber" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/NumberConfigurationResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get number configuration for phone number": { - "$ref": "./examples/GetNumberConfigurationAsync.json" - } - } - } - }, - "/administration/phonenumbers/numberconfiguration/configure": { - "patch": { - "tags": [ - "NumberConfiguration" - ], - "summary": "Endpoint for configuring a pstn number", - "operationId": "PhoneNumberAdministration_ConfigureNumber", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Details of pstn number configuration of the given phoneNumber", - "schema": { - "$ref": "#/definitions/NumberConfiguration" - } - } - ], - "responses": { - "200": { - "description": "Success" - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Configure phone number": { - "$ref": "./examples/ConfigurePhoneNumberAsync.json" - } - } - } - }, - "/administration/phonenumbers/numberconfiguration/unconfigure": { - "patch": { - "tags": [ - "NumberConfiguration" - ], - "summary": "Endpoint for unconfiguring a pstn number by removing the configuration", - "operationId": "PhoneNumberAdministration_UnconfigureNumber", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "The phone number to un-configure", - "schema": { - "$ref": "#/definitions/NumberConfigurationPhoneNumber" - } - } - ], - "responses": { - "200": { - "description": "Success" - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Unconfigure phone number": { - "$ref": "./examples/UnconfigurePhoneNumberAsync.json" - } - } - } - }, - "/administration/phonenumbers/countries/{countryCode}/phoneplangroups": { - "get": { - "tags": [ - "Plans" - ], - "summary": "Gets a list of phone plan groups for the given country", - "operationId": "PhoneNumberAdministration_GetPhonePlanGroups", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "countryCode", - "description": "The ISO 3166-2 country code.", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "locale", - "description": "A language-locale pairing which will be used to localise the names of countries", - "type": "string", - "default": "en-US" - }, - { - "in": "query", - "name": "includeRateInformation", - "type": "boolean", - "default": false - }, - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "take", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhonePlanGroups" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "phonePlanGroups" - }, - "x-ms-examples": { - "Get plans": { - "$ref": "./examples/GetPhonePlanGroupsAsync.json" - } - } - } - }, - "/administration/phonenumbers/countries/{countryCode}/phoneplangroups/{phonePlanGroupId}/phoneplans": { - "get": { - "tags": [ - "Plans" - ], - "summary": "Gets a list of phone plans for a phone plan group", - "operationId": "PhoneNumberAdministration_GetPhonePlans", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "countryCode", - "description": "The ISO 3166-2 country code.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "phonePlanGroupId", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "locale", - "description": "A language-locale pairing which will be used to localise the names of countries", - "type": "string", - "default": "en-US" - }, - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "take", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhonePlansResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "phonePlans" - }, - "x-ms-examples": { - "Get plans": { - "$ref": "./examples/GetPhonePlansAsync.json" - } - } - } - }, - "/administration/phonenumbers/countries/{countryCode}/phoneplangroups/{phonePlanGroupId}/phoneplans/{phonePlanId}/locationoptions": { - "get": { - "tags": [ - "Plans" - ], - "summary": "Gets a list of location options for a phone plan", - "operationId": "PhoneNumberAdministration_GetPhonePlanLocationOptions", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "countryCode", - "description": "The ISO 3166-2 country code.", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "phonePlanGroupId", - "required": true, - "type": "string" - }, - { - "in": "path", - "name": "phonePlanId", - "required": true, - "type": "string" - }, - { - "in": "query", - "name": "locale", - "description": "A language-locale pairing which will be used to localise the names of countries", - "type": "string", - "default": "en-US" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/LocationOptionsResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get plans": { - "$ref": "./examples/GetLocationOptionsAsync.json" - } - } - } - }, - "/administration/phonenumbers/releases/{releaseId}": { - "get": { - "tags": [ - "Release" - ], - "summary": "Gets a release by a release id", - "operationId": "PhoneNumberAdministration_GetReleaseById", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "releaseId", - "description": "Represents the release id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhoneNumberRelease" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get release by id": { - "$ref": "./examples/GetReleaseByIdAsync.json" - } - } - } - }, - "/administration/phonenumbers/releases": { - "post": { - "tags": [ - "Release" - ], - "summary": "Creates a release for the given phone numbers", - "operationId": "PhoneNumberAdministration_ReleasePhoneNumbers", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Config api Release request", - "schema": { - "$ref": "#/definitions/ReleaseRequest" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ReleaseResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get release": { - "$ref": "./examples/CreateReleaseAsync.json" - } - } - }, - "get": { - "tags": [ - "Release" - ], - "summary": "Gets a list of all releases", - "operationId": "PhoneNumberAdministration_GetAllReleases", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "take", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhoneNumberEntities" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "entities" - }, - "x-ms-examples": { - "Get all releases": { - "$ref": "./examples/GetAllReleasesAsync.json" - } - } - } - }, - "/administration/phonenumbers/searches/{searchId}": { - "get": { - "tags": [ - "Search" - ], - "summary": "Get search by search id", - "operationId": "PhoneNumberAdministration_GetSearchById", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "searchId", - "description": "The search id to be searched for", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhoneNumberSearch" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get search by search id": { - "$ref": "./examples/GetSearchByIdAsync.json" - } - } - } - }, - "/administration/phonenumbers/searches": { - "post": { - "tags": [ - "Search" - ], - "summary": "Creates a phone number search", - "operationId": "PhoneNumberAdministration_CreateSearch", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Defines the search options", - "schema": { - "$ref": "#/definitions/CreateSearchOptions" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/CreateSearchResponse" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create search": { - "$ref": "./examples/CreateSearchAsync.json" - } - } - }, - "get": { - "tags": [ - "Search" - ], - "summary": "Gets a list of all searches", - "operationId": "PhoneNumberAdministration_GetAllSearches", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "take", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/PhoneNumberEntities" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "entities" - }, - "x-ms-examples": { - "Get all searches": { - "$ref": "./examples/GetAllSearchesAsync.json" - } - } - } - }, - "/administration/phonenumbers/searches/{searchId}/cancel": { - "post": { - "tags": [ - "Search" - ], - "summary": "Cancels the search. This means existing numbers in the search will be made available.", - "operationId": "PhoneNumberAdministration_CancelSearch", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "searchId", - "description": "The search id to be canceled", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Success" - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Cancel phone number search": { - "$ref": "./examples/CancelSearchAsync.json" - } - } - } - }, - "/administration/phonenumbers/searches/{searchId}/purchase": { - "post": { - "tags": [ - "Search" - ], - "summary": "Purchases the phone number search.", - "operationId": "PhoneNumberAdministration_PurchaseSearch", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "searchId", - "description": "The search id to be purchased", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Success" - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Purchase phone number search": { - "$ref": "./examples/PurchaseSearchAsync.json" - } - } - } - } - }, - "definitions": { - "AcquiredPhoneNumber": { - "description": "Represents an acquired phone number.", - "required": [ - "acquiredCapabilities", - "availableCapabilities", - "phoneNumber" - ], - "type": "object", - "properties": { - "phoneNumber": { - "description": "String of the E.164 format of the phone number", - "type": "string" - }, - "acquiredCapabilities": { - "description": "The set of all acquired capabilities of the phone number.", - "type": "array", - "items": { - "description": "Represents the capabilities of a phone number.", - "enum": [ - "UserAssignment", - "FirstPartyVoiceAppAssignment", - "ConferenceAssignment", - "P2PSmsEnabled", - "Geographic", - "NonGeographic", - "TollCalling", - "TollFreeCalling", - "Premium", - "P2PSmsCapable", - "A2PSmsCapable", - "A2PSmsEnabled", - "Calling", - "TollFree", - "FirstPartyAppAssignment", - "ThirdPartyAppAssignment", - "Azure", - "Office365", - "InboundCalling", - "OutboundCalling", - "InboundA2PSms", - "OutboundA2PSms", - "InboundP2PSms", - "OutboundP2PSms" - ], - "type": "string", - "x-ms-enum": { - "name": "Capability", - "modelAsString": true - } - } - }, - "availableCapabilities": { - "description": "The set of all available capabilities that can be acquired for this phone number.", - "type": "array", - "items": { - "description": "Represents the capabilities of a phone number.", - "enum": [ - "UserAssignment", - "FirstPartyVoiceAppAssignment", - "ConferenceAssignment", - "P2PSmsEnabled", - "Geographic", - "NonGeographic", - "TollCalling", - "TollFreeCalling", - "Premium", - "P2PSmsCapable", - "A2PSmsCapable", - "A2PSmsEnabled", - "Calling", - "TollFree", - "FirstPartyAppAssignment", - "ThirdPartyAppAssignment", - "Azure", - "Office365", - "InboundCalling", - "OutboundCalling", - "InboundA2PSms", - "OutboundA2PSms", - "InboundP2PSms", - "OutboundP2PSms" - ], - "type": "string", - "x-ms-enum": { - "name": "Capability", - "modelAsString": true - } - } - }, - "assignmentStatus": { - "description": "The assignment status of the phone number. Conveys what type of entity the number is assigned to.", - "enum": [ - "Unassigned", - "Unknown", - "UserAssigned", - "ConferenceAssigned", - "FirstPartyAppAssigned", - "ThirdPartyAppAssigned" - ], - "type": "string", - "x-ms-enum": { - "name": "AssignmentStatus", - "modelAsString": true - } - }, - "placeName": { - "description": "The name of the place of the phone number.", - "type": "string" - }, - "activationState": { - "description": "The activation state of the phone number. Can be \"Activated\", \"AssignmentPending\", \"AssignmentFailed\", \"UpdatePending\", \"UpdateFailed\"", - "enum": [ - "Activated", - "AssignmentPending", - "AssignmentFailed", - "UpdatePending", - "UpdateFailed" - ], - "type": "string", - "x-ms-enum": { - "name": "ActivationState", - "modelAsString": true - } - } - } - }, - "AcquiredPhoneNumbers": { - "description": "A wrapper of list of phone numbers", - "type": "object", - "properties": { - "phoneNumbers": { - "description": "Represents a list of phone numbers", - "type": "array", - "items": { - "$ref": "#/definitions/AcquiredPhoneNumber" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page", - "type": "string" - } - } - }, - "ErrorBody": { - "description": "Represents a service error response body.", - "type": "object", - "properties": { - "code": { - "description": "The error code in the error response.", - "type": "string" - }, - "message": { - "description": "The error message in the error response.", - "type": "string" - } - } - }, - "ErrorResponse": { - "description": "Represents a service error response.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ErrorBody" - } - } - }, - "LocationOptionsQuery": { - "description": "Represents a location options parameter, used for fetching area codes.", - "type": "object", - "properties": { - "labelId": { - "description": "Represents the location option label id, returned from the GetLocationOptions API.", - "type": "string" - }, - "optionsValue": { - "description": "Represents the location options value, returned from the GetLocationOptions API.", - "type": "string" - } - } - }, - "LocationOptionsQueries": { - "description": "Represents a list of location option queries, used for fetching area codes.", - "type": "object", - "properties": { - "locationOptions": { - "description": "Represents the underlying list of countries.", - "type": "array", - "items": { - "$ref": "#/definitions/LocationOptionsQuery" - } - } - } - }, - "AreaCodes": { - "description": "Represents a list of area codes.", - "type": "object", - "properties": { - "primaryAreaCodes": { - "description": "Represents the list of primary area codes.", - "type": "array", - "items": { - "type": "string" - } - }, - "secondaryAreaCodes": { - "description": "Represents the list of secondary area codes.", - "type": "array", - "items": { - "type": "string" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page", - "type": "string" - } - } - }, - "NumberUpdateCapabilities": { - "description": "Represents an individual number capabilities update request", - "type": "object", - "properties": { - "add": { - "description": "Capabilities to be added to a phone number", - "type": "array", - "items": { - "description": "Represents the capabilities of a phone number.", - "enum": [ - "UserAssignment", - "FirstPartyVoiceAppAssignment", - "ConferenceAssignment", - "P2PSmsEnabled", - "Geographic", - "NonGeographic", - "TollCalling", - "TollFreeCalling", - "Premium", - "P2PSmsCapable", - "A2PSmsCapable", - "A2PSmsEnabled", - "Calling", - "TollFree", - "FirstPartyAppAssignment", - "ThirdPartyAppAssignment", - "Azure", - "Office365", - "InboundCalling", - "OutboundCalling", - "InboundA2PSms", - "OutboundA2PSms", - "InboundP2PSms", - "OutboundP2PSms" - ], - "type": "string", - "x-ms-enum": { - "name": "Capability", - "modelAsString": true - } - } - }, - "remove": { - "description": "Capabilities to be removed from a phone number", - "type": "array", - "items": { - "description": "Represents the capabilities of a phone number.", - "enum": [ - "UserAssignment", - "FirstPartyVoiceAppAssignment", - "ConferenceAssignment", - "P2PSmsEnabled", - "Geographic", - "NonGeographic", - "TollCalling", - "TollFreeCalling", - "Premium", - "P2PSmsCapable", - "A2PSmsCapable", - "A2PSmsEnabled", - "Calling", - "TollFree", - "FirstPartyAppAssignment", - "ThirdPartyAppAssignment", - "Azure", - "Office365", - "InboundCalling", - "OutboundCalling", - "InboundA2PSms", - "OutboundA2PSms", - "InboundP2PSms", - "OutboundP2PSms" - ], - "type": "string", - "x-ms-enum": { - "name": "Capability", - "modelAsString": true - } - } - } - } - }, - "UpdatePhoneNumberCapabilitiesResponse": { - "description": "Response for getting a phone number update capabilities.", - "type": "object", - "properties": { - "capabilitiesUpdateId": { - "description": "The id of the phone number capabilties update", - "type": "string" - }, - "createdAt": { - "format": "date-time", - "description": "The time the capabilities update was created", - "type": "string" - }, - "capabilitiesUpdateStatus": { - "description": "Status of the capabilities update.", - "enum": [ - "Pending", - "InProgress", - "Complete", - "Error" - ], - "type": "string", - "x-ms-enum": { - "name": "CapabilitiesUpdateStatus", - "modelAsString": true - } - }, - "phoneNumberCapabilitiesUpdates": { - "description": "The capabilities update for each of a set of phone numbers.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/NumberUpdateCapabilities" - } - } - } - }, - "UpdateNumberCapabilitiesRequest": { - "description": "Represents a numbers capabilities update request", - "required": [ - "phoneNumberCapabilitiesUpdate" - ], - "type": "object", - "properties": { - "phoneNumberCapabilitiesUpdate": { - "description": "The map of phone numbers to the capabilities update applied to the phone number.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/NumberUpdateCapabilities" - } - } - } - }, - "UpdateNumberCapabilitiesResponse": { - "description": "Represents a number capability update response.", - "required": [ - "capabilitiesUpdateId" - ], - "type": "object", - "properties": { - "capabilitiesUpdateId": { - "description": "The capabilities id", - "type": "string" - } - } - }, - "PhoneNumberCountry": { - "description": "Represents a country.", - "required": [ - "countryCode", - "localizedName" - ], - "type": "object", - "properties": { - "localizedName": { - "description": "Represents the name of the country.", - "type": "string" - }, - "countryCode": { - "description": "Represents the abbreviated name of the country.", - "type": "string" - } - } - }, - "PhoneNumberCountries": { - "description": "Represents a wrapper around a list of countries.", - "type": "object", - "properties": { - "countries": { - "description": "Represents the underlying list of countries.", - "type": "array", - "items": { - "$ref": "#/definitions/PhoneNumberCountry" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page", - "type": "string" - } - } - }, - "NumberConfigurationPhoneNumber": { - "description": "The phone number wrapper representing a number configuration request", - "required": [ - "phoneNumber" - ], - "type": "object", - "properties": { - "phoneNumber": { - "description": "The phone number in the E.164 format", - "type": "string" - } - } - }, - "PstnConfiguration": { - "description": "Definition for pstn number configuration", - "required": [ - "callbackUrl" - ], - "type": "object", - "properties": { - "callbackUrl": { - "description": "The webhook URL on the phone number configuration.", - "type": "string" - }, - "applicationId": { - "description": "The application id of the application to which to configure", - "type": "string" - } - } - }, - "NumberConfigurationResponse": { - "description": "Definition for number configuration", - "required": [ - "pstnConfiguration" - ], - "type": "object", - "properties": { - "pstnConfiguration": { - "$ref": "#/definitions/PstnConfiguration" - } - } - }, - "NumberConfiguration": { - "description": "Definition for number configuration", - "required": [ - "phoneNumber", - "pstnConfiguration" - ], - "type": "object", - "properties": { - "pstnConfiguration": { - "$ref": "#/definitions/PstnConfiguration" - }, - "phoneNumber": { - "description": "The phone number to configure", - "type": "string" - } - } - }, - "CarrierDetails": { - "description": "Represents carrier details.", - "type": "object", - "properties": { - "name": { - "description": "Name of carrier details", - "type": "string" - }, - "localizedName": { - "description": "Display name of carrier details", - "type": "string" - } - } - }, - "RateInformation": { - "description": "Represents a wrapper of rate information", - "type": "object", - "properties": { - "monthlyRate": { - "format": "double", - "description": "The monthly rate of a phone plan group", - "type": "number" - }, - "currencyType": { - "description": "The currency of a phone plan group", - "enum": [ - "USD" - ], - "type": "string", - "x-ms-enum": { - "name": "CurrencyType", - "modelAsString": true - } - }, - "rateErrorMessage": { - "description": "The error code of a phone plan group", - "type": "string" - } - } - }, - "PhonePlanGroup": { - "description": "Represents a plan group.", - "required": [ - "localizedDescription", - "localizedName", - "phonePlanGroupId" - ], - "type": "object", - "properties": { - "phonePlanGroupId": { - "description": "The id of the plan group", - "type": "string" - }, - "phoneNumberType": { - "description": "The phone number type of the plan group", - "enum": [ - "Unknown", - "Geographic", - "TollFree", - "Indirect" - ], - "type": "string", - "x-ms-enum": { - "name": "PhoneNumberType", - "modelAsString": true - } - }, - "localizedName": { - "description": "The name of the plan group.", - "type": "string" - }, - "localizedDescription": { - "description": "The description of the plan group.", - "type": "string" - }, - "carrierDetails": { - "$ref": "#/definitions/CarrierDetails" - }, - "rateInformation": { - "$ref": "#/definitions/RateInformation" - } - } - }, - "PhonePlanGroups": { - "description": "Represents a wrapper of list of plan groups.", - "type": "object", - "properties": { - "phonePlanGroups": { - "description": "The underlying list of phone plan groups.", - "type": "array", - "items": { - "$ref": "#/definitions/PhonePlanGroup" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page", - "type": "string" - } - } - }, - "PhonePlan": { - "description": "Represents a phone plan.", - "required": [ - "localizedName", - "locationType", - "phonePlanId" - ], - "type": "object", - "properties": { - "phonePlanId": { - "description": "The phone plan id", - "type": "string" - }, - "localizedName": { - "description": "The name of the phone plan", - "type": "string" - }, - "locationType": { - "description": "The location type of the phone plan.", - "enum": [ - "CivicAddress", - "NotRequired", - "Selection" - ], - "type": "string", - "x-ms-enum": { - "name": "LocationType", - "modelAsString": true - } - }, - "areaCodes": { - "description": "The list of available area codes in the phone plan.", - "type": "array", - "items": { - "type": "string" - } - }, - "capabilities": { - "description": "Capabilities of the phone plan.", - "type": "array", - "items": { - "description": "Represents the capabilities of a phone number.", - "enum": [ - "UserAssignment", - "FirstPartyVoiceAppAssignment", - "ConferenceAssignment", - "P2PSmsEnabled", - "Geographic", - "NonGeographic", - "TollCalling", - "TollFreeCalling", - "Premium", - "P2PSmsCapable", - "A2PSmsCapable", - "A2PSmsEnabled", - "Calling", - "TollFree", - "FirstPartyAppAssignment", - "ThirdPartyAppAssignment", - "Azure", - "Office365", - "InboundCalling", - "OutboundCalling", - "InboundA2PSms", - "OutboundA2PSms", - "InboundP2PSms", - "OutboundP2PSms" - ], - "type": "string", - "x-ms-enum": { - "name": "Capability", - "modelAsString": true - } - } - }, - "maximumSearchSize": { - "format": "int32", - "description": "The maximum number of phone numbers one can acquire in a search in this phone plan.", - "type": "integer" - } - } - }, - "PhonePlansResponse": { - "description": "Represents a wrapper around a list of countries.", - "type": "object", - "properties": { - "phonePlans": { - "description": "Represents the underlying list of phone plans.", - "type": "array", - "items": { - "$ref": "#/definitions/PhonePlan" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page", - "type": "string" - } - } - }, - "LocationOptionsDetails": { - "description": "Represents location options deatils.", - "type": "object", - "properties": { - "name": { - "description": "The name of the location options", - "type": "string" - }, - "value": { - "description": "The abbreviated name of the location options", - "type": "string" - }, - "locationOptions": { - "description": "The underlying location options", - "type": "array", - "items": { - "$ref": "#/definitions/LocationOptions" - } - } - } - }, - "LocationOptions": { - "description": "Represents a location options.", - "type": "object", - "properties": { - "labelId": { - "description": "The label id of the location.", - "type": "string" - }, - "labelName": { - "description": "The display name of the location.", - "type": "string" - }, - "options": { - "description": "The underlying location option details.", - "type": "array", - "items": { - "$ref": "#/definitions/LocationOptionsDetails" - } - } - } - }, - "LocationOptionsResponse": { - "description": "Represents a wrapper around a list of location options.", - "type": "object", - "properties": { - "locationOptions": { - "$ref": "#/definitions/LocationOptions" - } - } - }, - "PhoneNumberReleaseDetails": { - "type": "object", - "properties": { - "status": { - "description": "The release status of a phone number.", - "enum": [ - "Pending", - "Success", - "Error", - "InProgress" - ], - "type": "string", - "x-ms-enum": { - "name": "PhoneNumberReleaseStatus", - "modelAsString": true - } - }, - "errorCode": { - "format": "int32", - "description": "The error code in the case the status is error.", - "type": "integer" - } - } - }, - "PhoneNumberRelease": { - "description": "Represents a release", - "type": "object", - "properties": { - "releaseId": { - "description": "The id of the release.", - "type": "string" - }, - "createdAt": { - "format": "date-time", - "description": "The creation time of the release.", - "type": "string" - }, - "status": { - "description": "The release status.", - "enum": [ - "Pending", - "InProgress", - "Complete", - "Failed", - "Expired" - ], - "type": "string", - "x-ms-enum": { - "name": "ReleaseStatus", - "modelAsString": true - } - }, - "errorMessage": { - "description": "The underlying error message of a release.", - "type": "string" - }, - "phoneNumberReleaseStatusDetails": { - "description": "The list of phone numbers in the release, mapped to its individual statuses.", - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/PhoneNumberReleaseDetails" - } - } - } - }, - "ReleaseRequest": { - "description": "Represents a release request.", - "required": [ - "phoneNumbers" - ], - "type": "object", - "properties": { - "phoneNumbers": { - "description": "The list of phone numbers in the release request.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ReleaseResponse": { - "description": "Represents a release response.", - "required": [ - "releaseId" - ], - "type": "object", - "properties": { - "releaseId": { - "description": "The release id of a created release.", - "type": "string" - } - } - }, - "PhoneNumberEntity": { - "description": "Represents a phone number entity, as part of the response when calling get all searches or releases.", - "type": "object", - "properties": { - "id": { - "description": "The id of the entity. It is the search id of a searc. It is the release id of a release.", - "type": "string" - }, - "createdAt": { - "format": "date-time", - "description": "Date and time the entity is created.", - "type": "string" - }, - "displayName": { - "description": "Name of the entity.", - "type": "string" - }, - "quantity": { - "format": "int32", - "description": "Quantity of requested phone numbers in the entity.", - "type": "integer" - }, - "quantityObtained": { - "format": "int32", - "description": "Quantity of acquired phone numbers in the entity.", - "type": "integer" - }, - "status": { - "description": "Status of the entity.", - "type": "string" - }, - "focDate": { - "format": "date-time", - "description": "The Firm Order Confirmation date of the phone number entity.", - "type": "string" - } - } - }, - "PhoneNumberEntities": { - "description": "Represents a list of searchs or releases, as part of the response when fetching all searches or releases.", - "type": "object", - "properties": { - "entities": { - "description": "The underlying list of entities.", - "type": "array", - "items": { - "$ref": "#/definitions/PhoneNumberEntity" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page", - "type": "string" - } - } - }, - "PhoneNumberSearch": { - "description": "Represents a phone number search", - "type": "object", - "properties": { - "searchId": { - "description": "The id of the search.", - "type": "string" - }, - "displayName": { - "description": "The name of the search.", - "type": "string" - }, - "createdAt": { - "format": "date-time", - "description": "The creation time of the search.", - "type": "string" - }, - "description": { - "description": "The description of the search.", - "type": "string" - }, - "phonePlanIds": { - "description": "The phone plan ids of the search.", - "type": "array", - "items": { - "type": "string" - } - }, - "areaCode": { - "description": "The area code of the search.", - "type": "string" - }, - "quantity": { - "format": "int32", - "description": "The quantity of phone numbers in the search.", - "type": "integer" - }, - "locationOptions": { - "description": "The location options of the search.", - "type": "array", - "items": { - "$ref": "#/definitions/LocationOptionsDetails" - } - }, - "status": { - "description": "The status of the search.", - "enum": [ - "Pending", - "InProgress", - "Reserved", - "Expired", - "Expiring", - "Completing", - "Refreshing", - "Success", - "Manual", - "Cancelled", - "Cancelling", - "Error", - "PurchasePending" - ], - "type": "string", - "x-ms-enum": { - "name": "SearchStatus", - "modelAsString": true - } - }, - "phoneNumbers": { - "description": "The list of phone numbers in the search, in the case the status is reserved or success.", - "type": "array", - "items": { - "type": "string" - } - }, - "reservationExpiryDate": { - "format": "date-time", - "description": "The date that search expires and the numbers become available.", - "type": "string" - }, - "errorCode": { - "format": "int32", - "description": "The error code of the search.", - "type": "integer" - } - } - }, - "CreateSearchOptions": { - "description": "Represents a search creation option.", - "required": [ - "areaCode", - "description", - "displayName", - "phonePlanIds" - ], - "type": "object", - "properties": { - "displayName": { - "description": "Display name of the search.", - "maxLength": 255, - "type": "string" - }, - "description": { - "description": "Description of the search.", - "maxLength": 255, - "type": "string" - }, - "phonePlanIds": { - "description": "The plan subtype ids from which to create the search.", - "type": "array", - "items": { - "type": "string" - } - }, - "areaCode": { - "description": "The area code from which to create the search.", - "type": "string" - }, - "quantity": { - "format": "int32", - "description": "The quantity of phone numbers to request.", - "maximum": 2147483647, - "minimum": 1, - "type": "integer" - }, - "locationOptions": { - "description": "The location options of the search.", - "type": "array", - "items": { - "$ref": "#/definitions/LocationOptionsDetails" - } - } - } - }, - "CreateSearchResponse": { - "description": "Represents a search creation response.", - "required": [ - "searchId" - ], - "type": "object", - "properties": { - "searchId": { - "description": "The search id of the search that was created.", - "type": "string" - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "in": "query", - "name": "api-version", - "description": "Version of API to invoke", - "required": true, - "type": "string" - }, - "Endpoint": { - "in": "path", - "name": "endpoint", - "description": "The endpoint of the Azure Communication resource.", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - } - } \ No newline at end of file