Service enfonica.numbering.v1beta1.RegulatoryListings¶
Methods¶
| CreateRegulatoryListing |
|---|
| rpc CreateRegulatoryListing(CreateRegulatoryListingRequest) returns (RegulatoryListing) Creates a regulatory listing. By creating a regulatory listing, you acknowledge that the person or entity located at the specified address is the only party that will be utilizing phone numbers associated with this regulatory listing. You acknowledge that Enfonica may process the information provided for the purpose of identity verification, and will share this information with local telecommunications providers or authorities where required by local law. You understand that Enfonica phone numbers may be taken out of service if inaccurate or false information has been provided. The caller must have numbering.regulatoryListings.create permission on the project. |
| DeleteRegulatoryListing |
|---|
| rpc DeleteRegulatoryListing(DeleteRegulatoryListingRequest) returns (google.protobuf.Empty) Deletes a regulatory listing. Regulatory listings that are associated with an active phone number instance cannot be deleted. The caller must have numbering.regulatoryListings.delete permission on the project. |
| GetRegulatoryListing |
|---|
| rpc GetRegulatoryListing(GetRegulatoryListingRequest) returns (RegulatoryListing) Retrieves a regulatory listing. The caller must have numbering.regulatoryListings.get permission on the project. |
| ListRegulatoryListings |
|---|
| rpc ListRegulatoryListings(ListRegulatoryListingsRequest) returns (ListRegulatoryListingsResponse) Lists all regulatory listings. List returns regulatory listings sorted by create_time descending.The caller must have numbering.regulatoryListings.list permission on the project. |
| SearchRegulatoryListings |
|---|
| rpc SearchRegulatoryListings(SearchRegulatoryListingsRequest) returns (SearchRegulatoryListingsResponse) Searches all usable regulatory listings with the specified number type. List returns regulatory listings sorted by create_time descending.The caller must have numbering.regulatoryListings.list permission on the project. |
| UpdateRegulatoryListing |
|---|
| rpc UpdateRegulatoryListing(UpdateRegulatoryListingRequest) returns (RegulatoryListing) Updates a regulatory listing. The caller must have numbering.regulatoryListings.update permission on the project. |
Resource: RegulatoryListing¶
The regulatory listing resource.
| Fields | |
|---|---|
| name | string Resource name of the regulatory listing. It must match the pattern projects/*/regulatoryListings/* |
| display_name | string The display name of the regulatory listing. Max length 100 characters. |
| address | GenericAddress Immutable. The address of this regulatory listing. |
| person | PersonDetails Immutable. The person associated with the listing. |
| business | BusinessDetails Immutable. The business or corporation associated with the listing. |
| create_time | google.protobuf.Timestamp Output only. The creation time of the regulatory listing. |
| valid | boolean Output only. Whether this regulatory listing is considered valid. This state may change after manual review. |
| verified | boolean Output only. Whether this regulatory listing has been verified. Verification is only required for some types of phone numbers, and is performed at request by Enfonica. |
BusinessDetails¶
The details of a business or corporation.
| Fields | |
|---|---|
| business | string Required. The full legal name of the business. Maximum length 200 characters. |
GenericAddress¶
An address in a generic format.
The validation of some fields varies based on region_code. For example: - AU/NZ: locality (city) required, adminsitrative_area (city) required, postal_code required with 4 digits. - US: locality (city) required, adminsitrative_area (city) required, postal_code required with 5 digits.
| Fields | |
|---|---|
| address_lines[] | string Required. The address lines. Maximum length of each line is 200 characters. Must specify 1 or 2 lines. |
| locality | string Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines. |
| administrative_area | string Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated. |
| postal_code | string The postal code. Maximum 16 characters. |
| region_code | string Required. The alpha-2 country code (capitalized). |
PersonDetails¶
The details of a person.
| Fields | |
|---|---|
| given_name | string Required. The given name of the person. Maximum length 100 characters. |
| family_name | string Required. The family name of the person. Maximum length 100 characters. |
CreateRegulatoryListingRequest¶
Request to create a new regulatory listing.
| Fields | |
|---|---|
| parent | string Required. The project under which to create the regulatory listing in the form projects/*. |
| regulatory_listing | RegulatoryListing Required. The resource to be created. |
GetRegulatoryListingRequest¶
The GetRegulatoryListing request message.
| Fields | |
|---|---|
| name | string Required. The resource name of the regulatory listing to retrieve. Must be of the form projects/*/regulatoryListings/*. |
ListRegulatoryListingsRequest¶
The ListRegulatoryListings request.
| Fields | |
|---|---|
| parent | string Required. The project under which to list regulatory listing, in the form projects/*. |
| page_size | int32 The maximum number of regulatory listing to return in the response. Default value of 10 and maximum value of 100. |
| page_token | string A pagination token returned from a previous call to ListRegulatoryListings that indicates where this listing should continue from. |
ListRegulatoryListingsResponse¶
The ListRegulatoryListings response.
| Fields | |
|---|---|
| regulatory_listings[] | RegulatoryListing A possibly paginated list of regulatory listing that are direct descendants of the specified parent resource. |
| next_page_token | string A pagination token returned from a previous call to ListRegulatoryListings that indicates from where listing should continue. |
UpdateRegulatoryListingRequest¶
The UpdateRegulatoryListing request message.
| Fields | |
|---|---|
| regulatory_listing | RegulatoryListing Required. The updated definition of the RegulatoryListing. |
| update_mask | google.protobuf.FieldMask Fields to be updated. |
DeleteRegulatoryListingRequest¶
The DeleteRegulatoryListing request message.
| Fields | |
|---|---|
| name | string Required. The resource name of the regulatory listing to be deleted. Must be of the form projects/*/regulatoryListings/*. |
SearchRegulatoryListingsRequest¶
The SearchRegulatoryListings request.
| Fields | |
|---|---|
| parent | string Required. The project under which to list regulatory listing, in the form projects/*. |
| page_size | int32 The maximum number of regulatory listing to return in the response. Default value of 10 and maximum value of 100. |
| page_token | string A pagination token returned from a previous call to ListRegulatoryListings that indicates where this listing should continue from. |
| region_code | string Required. The region code of the number that the regulatory listing must be usable with. |
| number_type | PhoneNumber.PhoneNumberType Required. The type of number that the regulatory listing must be usable with. |
SearchRegulatoryListingsResponse¶
The SearchRegulatoryListings response.
| Fields | |
|---|---|
| regulatory_listings[] | RegulatoryListing A possibly paginated list of regulatory listing that are direct descendants of the specified parent resource. |
| next_page_token | string A pagination token returned from a previous call to ListRegulatoryListings that indicates from where listing should continue. |