Locations

SDK Reference · Resource

Locations

Browse locations, networks, and providers available for proxy targeting.

listAsns()listCities()getCity()listContinents()getContinent()listCountries()getCountry()listIsps()listRegions()getRegion()

method

listAsns()

List available autonomous systems

Returns targetable ASNs for the selected package. Geo-scoped records include the country, region, or city where the ASN can be selected.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.listAsns(options: LocationsListAsnsOptions): Promise<LocationsListAsnsResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
global	boolean	Optional	Set to true to return only globally targetable ASNs.
limit	number	Optional	Number of results to return per page.
name	string	Optional	—
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across ASN fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.listAsns({
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedLocationASNRecordList

The operation completed successfully.

typePaginatedLocationASNRecordList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

LocationASNRecord[]

Required

—

typeLocationASNRecord3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

geo

LocationASNGeoItem[]

Optional

—

typeLocationASNGeoItem3fields

FieldTypeRequirementDescription

country

LocationCodeName

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

region

LocationCodeName

Optional

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

city

LocationCodeName

Optional

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.listAsnsWithResponse(options): Promise<ApiResponse<LocationsListAsnsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.list_asns(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, global_: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedLocationASNRecordList

Asyncawait async_client.locations.list_asns(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, global_: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedLocationASNRecordList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
country_code	str	Optional	—
global	bool	Optional	Set to true to return only globally targetable ASNs.
limit	int	Optional	Number of results to return per page.
name	str	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Required	Package whose targeting availability should be returned.
search	str	Optional	Case-insensitive partial search across ASN fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.list_asns(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.list_asns(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedLocationASNRecordList

The operation completed successfully.

classPaginatedLocationASNRecordList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[LocationASNRecord]

Required

—

classLocationASNRecord3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

geo

list[LocationASNGeoItem]

Optional

—

classLocationASNGeoItem3fields

FieldTypeRequirementDescription

country

LocationCodeName

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

region

LocationCodeName

Optional

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

city

LocationCodeName

Optional

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.list_asns_with_response(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, global_: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedLocationASNRecordList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->listAsns($packageId, $code = null, $countryCode = null, $global = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listAsns'][0])

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
global	bool	Optional	Set to true to return only globally targetable ASNs.
limit	int	Optional	Number of results to return per page.
name	string	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across ASN fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->listAsns(
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedLocationASNRecordList

The operation completed successfully.

classPaginatedLocationASNRecordList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[LocationASNRecord[]](LocationASNRecord.md)

Required

|

classLocationASNRecord3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

geo

[LocationASNGeoItem[]](LocationASNGeoItem.md)

Required

| [optional]

classLocationASNGeoItem3fields

FieldTypeRequirementDescription

country

LocationCodeName

Required

|

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

region

LocationCodeName

Required

| [optional]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

city

LocationCodeName

Required

| [optional]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->listAsnsWithResponse($packageId, $code = null, $countryCode = null, $global = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listAsns'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->listAsnsWithHttpInfo($packageId, $code = null, $countryCode = null, $global = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listAsns'][0])

  Returns the OpenAPI Generator response tuple.

• $client->locations()->listAsnsAsync($packageId, $code = null, $countryCode = null, $global = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listAsns'][0])

  Returns a Guzzle promise for the decoded result.

• $client->locations()->listAsnsAsyncWithHttpInfo($packageId, $code = null, $countryCode = null, $global = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listAsns'][0])

  Returns a Guzzle promise for the response tuple.

• $client->locations()->listAsnsRequest($packageId, $code = null, $countryCode = null, $global = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listAsns'][0])

  Builds the PSR-7 request without sending it.

method

listCities()

List available cities

Returns cities supported by the selected package, country, and region, including targetable ISPs. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.listCities(options: LocationsListCitiesOptions): Promise<LocationsListCitiesResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
includeAsns	boolean	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	number	Optional	Number of results to return per page.
name	string	Optional	—
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
regionCode	string	Optional	—
search	string	Optional	Case-insensitive partial search across City fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.listCities({
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedCityList

The operation completed successfully.

typePaginatedCityList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

City[]

Required

—

typeCity7fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Raw city code as it appears in the source data. los_angeles paris

name

string

Required

English display name of the city used across the admin and API responses.

country

LocationCountrySummary

Required

—

typeLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

original_name

string

Optional

—

region

LocationRegionSummary

Required

—

typeLocationRegionSummary3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

original_name

string

Optional

—

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.listCitiesWithResponse(options): Promise<ApiResponse<LocationsListCitiesResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.list_cities(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, region_code: str | Unset=UNSET, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCityList

Asyncawait async_client.locations.list_cities(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, region_code: str | Unset=UNSET, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCityList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
country_code	str	Optional	—
include_asns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	int	Optional	Number of results to return per page.
name	str	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Required	Package whose targeting availability should be returned.
region_code	str	Optional	—
search	str	Optional	Case-insensitive partial search across City fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.list_cities(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.list_cities(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedCityList

The operation completed successfully.

classPaginatedCityList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[City]

Required

—

classCity7fields

FieldTypeRequirementDescription

code

str

Required

Raw city code as it appears in the source data. los_angeles paris

name

str

Required

English display name of the city used across the admin and API responses.

country

LocationCountrySummary

Required

—

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

original_name

str

Optional

—

region

LocationRegionSummary

Required

—

classLocationRegionSummary3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

original_name

str

Optional

—

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.list_cities_with_response(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, region_code: str | Unset=UNSET, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedCityList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->listCities($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $regionCode = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCities'][0], $includeAsns = null)

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
includeAsns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	int	Optional	Number of results to return per page.
name	string	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
regionCode	string	Optional	—
search	string	Optional	Case-insensitive partial search across City fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->listCities(
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedCityList

The operation completed successfully.

classPaginatedCityList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[City[]](City.md)

Required

|

classCity7fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Raw city code as it appears in the source data. los_angeles paris |

name

string

Required

English display name of the city used across the admin and API responses. |

country

LocationCountrySummary

Required

| [readonly]

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

originalName

string

Required

| [optional]

region

LocationRegionSummary

Required

| [readonly]

classLocationRegionSummary3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

originalName

string

Required

| [optional]

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->listCitiesWithResponse($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $regionCode = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCities'][0], $includeAsns = null): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->listCitiesWithHttpInfo($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $regionCode = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCities'][0], $includeAsns = null)

  Returns the OpenAPI Generator response tuple.

• $client->locations()->listCitiesAsync($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $regionCode = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCities'][0], $includeAsns = null)

  Returns a Guzzle promise for the decoded result.

• $client->locations()->listCitiesAsyncWithHttpInfo($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $regionCode = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCities'][0], $includeAsns = null)

  Returns a Guzzle promise for the response tuple.

• $client->locations()->listCitiesRequest($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $regionCode = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCities'][0], $includeAsns = null)

  Builds the PSR-7 request without sending it.

method

getCity()

Get a city

Returns one city and its available network targeting options. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.getCity(options: LocationsGetCityOptions): Promise<LocationsGetCityResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	—
includeAsns	boolean	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.getCity({
  id: "550e8400-e29b-41d4-a716-446655440000",
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

City

The operation completed successfully.

typeCity7fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Raw city code as it appears in the source data. los_angeles paris

name

string

Required

English display name of the city used across the admin and API responses.

country

LocationCountrySummary

Required

—

typeLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

original_name

string

Optional

—

region

LocationRegionSummary

Required

—

typeLocationRegionSummary3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

original_name

string

Optional

—

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.getCityWithResponse(options): Promise<ApiResponse<LocationsGetCityResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.get_city(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> City

Asyncawait async_client.locations.get_city(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> City

Parameters

Name	Type	Requirement	Description
id	str	Required	—
include_asns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
package_id	str	Required	Package whose targeting availability should be returned.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.get_city(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.get_city(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

City

The operation completed successfully.

classCity7fields

FieldTypeRequirementDescription

code

str

Required

Raw city code as it appears in the source data. los_angeles paris

name

str

Required

English display name of the city used across the admin and API responses.

country

LocationCountrySummary

Required

—

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

original_name

str

Optional

—

region

LocationRegionSummary

Required

—

classLocationRegionSummary3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

original_name

str

Optional

—

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.get_city_with_response(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> ApiResponse[City]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->getCity($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCity'][0], $includeAsns = null)

Parameters

Name	Type	Requirement	Description
id	string	Required	—
includeAsns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->getCity(
    id: '550e8400-e29b-41d4-a716-446655440000',
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

City

The operation completed successfully.

classCity7fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Raw city code as it appears in the source data. los_angeles paris |

name

string

Required

English display name of the city used across the admin and API responses. |

country

LocationCountrySummary

Required

| [readonly]

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

originalName

string

Required

| [optional]

region

LocationRegionSummary

Required

| [readonly]

classLocationRegionSummary3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

originalName

string

Required

| [optional]

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->getCityWithResponse($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCity'][0], $includeAsns = null): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->getCityWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCity'][0], $includeAsns = null)

  Returns the OpenAPI Generator response tuple.

• $client->locations()->getCityAsync($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCity'][0], $includeAsns = null)

  Returns a Guzzle promise for the decoded result.

• $client->locations()->getCityAsyncWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCity'][0], $includeAsns = null)

  Returns a Guzzle promise for the response tuple.

• $client->locations()->getCityRequest($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCity'][0], $includeAsns = null)

  Builds the PSR-7 request without sending it.

method

listContinents()

List available continents

Returns continents containing at least one country supported by the selected package's active proxy providers.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.listContinents(options: LocationsListContinentsOptions): Promise<LocationsListContinentsResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
limit	number	Optional	Number of results to return per page.
name	string	Optional	—
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across Continent fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.listContinents({
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedContinentList

The operation completed successfully.

typePaginatedContinentList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Continent[]

Required

—

typeContinent3fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.listContinentsWithResponse(options): Promise<ApiResponse<LocationsListContinentsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.list_continents(*, code: str | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedContinentList

Asyncawait async_client.locations.list_continents(*, code: str | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedContinentList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
limit	int	Optional	Number of results to return per page.
name	str	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Required	Package whose targeting availability should be returned.
search	str	Optional	Case-insensitive partial search across Continent fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.list_continents(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.list_continents(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedContinentList

The operation completed successfully.

classPaginatedContinentList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Continent]

Required

—

classContinent3fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

id

str

Optional

—

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.list_continents_with_response(*, code: str | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedContinentList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->listContinents($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listContinents'][0])

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
limit	int	Optional	Number of results to return per page.
name	string	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across Continent fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->listContinents(
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedContinentList

The operation completed successfully.

classPaginatedContinentList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Continent[]](Continent.md)

Required

|

classContinent3fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->listContinentsWithResponse($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listContinents'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->listContinentsWithHttpInfo($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listContinents'][0])

  Returns the OpenAPI Generator response tuple.

• $client->locations()->listContinentsAsync($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listContinents'][0])

  Returns a Guzzle promise for the decoded result.

• $client->locations()->listContinentsAsyncWithHttpInfo($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listContinents'][0])

  Returns a Guzzle promise for the response tuple.

• $client->locations()->listContinentsRequest($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listContinents'][0])

  Builds the PSR-7 request without sending it.

method

getContinent()

Get a continent

Returns one continent from the proxy targeting dictionary.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.getContinent(options: LocationsGetContinentOptions): Promise<LocationsGetContinentResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	—
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.getContinent({
  id: "550e8400-e29b-41d4-a716-446655440000",
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

Continent

The operation completed successfully.

typeContinent3fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.getContinentWithResponse(options): Promise<ApiResponse<LocationsGetContinentResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.get_continent(id: str, *, package_id: UUID, accept_language: str | Unset=UNSET) -> Continent

Asyncawait async_client.locations.get_continent(id: str, *, package_id: UUID, accept_language: str | Unset=UNSET) -> Continent

Parameters

Name	Type	Requirement	Description
id	str	Required	—
package_id	str	Required	Package whose targeting availability should be returned.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.get_continent(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.get_continent(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

Continent

The operation completed successfully.

classContinent3fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

id

str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.get_continent_with_response(id: str, *, package_id: UUID, accept_language: str | Unset=UNSET) -> ApiResponse[Continent]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->getContinent($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getContinent'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	—
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->getContinent(
    id: '550e8400-e29b-41d4-a716-446655440000',
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

Continent

The operation completed successfully.

classContinent3fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->getContinentWithResponse($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getContinent'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->getContinentWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getContinent'][0])

  Returns the OpenAPI Generator response tuple.

• $client->locations()->getContinentAsync($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getContinent'][0])

  Returns a Guzzle promise for the decoded result.

• $client->locations()->getContinentAsyncWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getContinent'][0])

  Returns a Guzzle promise for the response tuple.

• $client->locations()->getContinentRequest($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getContinent'][0])

  Builds the PSR-7 request without sending it.

method

listCountries()

List available countries

Returns countries supported by the selected package, including targetable ISPs. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.listCountries(options: LocationsListCountriesOptions): Promise<LocationsListCountriesResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
includeAsns	boolean	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	number	Optional	Number of results to return per page.
name	string	Optional	—
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across Country fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.listCountries({
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedCountryList

The operation completed successfully.

typePaginatedCountryList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Country[]

Required

—

typeCountry6fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

original_name

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.listCountriesWithResponse(options): Promise<ApiResponse<LocationsListCountriesResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.list_countries(*, code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCountryList

Asyncawait async_client.locations.list_countries(*, code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCountryList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
include_asns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	int	Optional	Number of results to return per page.
name	str	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Required	Package whose targeting availability should be returned.
search	str	Optional	Case-insensitive partial search across Country fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.list_countries(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.list_countries(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedCountryList

The operation completed successfully.

classPaginatedCountryList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Country]

Required

—

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.list_countries_with_response(*, code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedCountryList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->listCountries($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCountries'][0], $includeAsns = null)

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
includeAsns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	int	Optional	Number of results to return per page.
name	string	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across Country fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->listCountries(
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedCountryList

The operation completed successfully.

classPaginatedCountryList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Country[]](Country.md)

Required

|

classCountry6fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

originalName

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->listCountriesWithResponse($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCountries'][0], $includeAsns = null): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->listCountriesWithHttpInfo($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCountries'][0], $includeAsns = null)

  Returns the OpenAPI Generator response tuple.

• $client->locations()->listCountriesAsync($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCountries'][0], $includeAsns = null)

  Returns a Guzzle promise for the decoded result.

• $client->locations()->listCountriesAsyncWithHttpInfo($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCountries'][0], $includeAsns = null)

  Returns a Guzzle promise for the response tuple.

• $client->locations()->listCountriesRequest($packageId, $code = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listCountries'][0], $includeAsns = null)

  Builds the PSR-7 request without sending it.

method

getCountry()

Get a country

Returns one country and its available network targeting options. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.getCountry(options: LocationsGetCountryOptions): Promise<LocationsGetCountryResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	—
includeAsns	boolean	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.getCountry({
  id: "550e8400-e29b-41d4-a716-446655440000",
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

Country

The operation completed successfully.

typeCountry6fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

original_name

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.getCountryWithResponse(options): Promise<ApiResponse<LocationsGetCountryResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.get_country(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> Country

Asyncawait async_client.locations.get_country(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> Country

Parameters

Name	Type	Requirement	Description
id	str	Required	—
include_asns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
package_id	str	Required	Package whose targeting availability should be returned.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.get_country(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.get_country(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

Country

The operation completed successfully.

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.get_country_with_response(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> ApiResponse[Country]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->getCountry($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCountry'][0], $includeAsns = null)

Parameters

Name	Type	Requirement	Description
id	string	Required	—
includeAsns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->getCountry(
    id: '550e8400-e29b-41d4-a716-446655440000',
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

Country

The operation completed successfully.

classCountry6fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

originalName

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->getCountryWithResponse($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCountry'][0], $includeAsns = null): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->getCountryWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCountry'][0], $includeAsns = null)

  Returns the OpenAPI Generator response tuple.

• $client->locations()->getCountryAsync($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCountry'][0], $includeAsns = null)

  Returns a Guzzle promise for the decoded result.

• $client->locations()->getCountryAsyncWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCountry'][0], $includeAsns = null)

  Returns a Guzzle promise for the response tuple.

• $client->locations()->getCountryRequest($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getCountry'][0], $includeAsns = null)

  Builds the PSR-7 request without sending it.

method

listIsps()

List available internet service providers

Returns ISPs that can be targeted by the selected package and location scope. Use country filters to narrow the result.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.listIsps(options: LocationsListIspsOptions): Promise<LocationsListIspsResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
limit	number	Optional	Number of results to return per page.
name	string	Optional	—
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across ISP fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.listIsps({
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedISPList

The operation completed successfully.

typePaginatedISPList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

ISP[]

Required

—

typeISP2fields

FieldTypeRequirementDescription

code

string

Required

Unique internal code used to identify this ISP in location vocabulary entries and provider routing rules. comcast att deutsche_telekom

name

string

Required

Full display name of the Internet Service Provider. Comcast Cable Communications AT&T Services

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.listIspsWithResponse(options): Promise<ApiResponse<LocationsListIspsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.list_isps(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedISPList

Asyncawait async_client.locations.list_isps(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedISPList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
country_code	str	Optional	—
limit	int	Optional	Number of results to return per page.
name	str	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Required	Package whose targeting availability should be returned.
search	str	Optional	Case-insensitive partial search across ISP fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.list_isps(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.list_isps(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedISPList

The operation completed successfully.

classPaginatedISPList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[ISP]

Required

—

classISP2fields

FieldTypeRequirementDescription

code

str

Required

Unique internal code used to identify this ISP in location vocabulary entries and provider routing rules. comcast att deutsche_telekom

name

str

Required

Full display name of the Internet Service Provider. Comcast Cable Communications AT&T Services

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.list_isps_with_response(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedISPList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->listIsps($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listIsps'][0])

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
limit	int	Optional	Number of results to return per page.
name	string	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across ISP fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->listIsps(
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedISPList

The operation completed successfully.

classPaginatedISPList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[ISP[]](ISP.md)

Required

|

classISP2fields

FieldTypeRequirementDescription

code

string

Required

Unique internal code used to identify this ISP in location vocabulary entries and provider routing rules. comcast att deutsche_telekom |

name

string

Required

Full display name of the Internet Service Provider. Comcast Cable Communications AT&T Services |

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->listIspsWithResponse($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listIsps'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->listIspsWithHttpInfo($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listIsps'][0])

  Returns the OpenAPI Generator response tuple.

• $client->locations()->listIspsAsync($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listIsps'][0])

  Returns a Guzzle promise for the decoded result.

• $client->locations()->listIspsAsyncWithHttpInfo($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listIsps'][0])

  Returns a Guzzle promise for the response tuple.

• $client->locations()->listIspsRequest($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listIsps'][0])

  Builds the PSR-7 request without sending it.

method

listRegions()

List available regions

Returns regions supported by the selected package and country, including targetable ISPs. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.listRegions(options: LocationsListRegionsOptions): Promise<LocationsListRegionsResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
includeAsns	boolean	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	number	Optional	Number of results to return per page.
name	string	Optional	—
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across Region fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.listRegions({
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedRegionList

The operation completed successfully.

typePaginatedRegionList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Region[]

Required

—

typeRegion8fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france

iso31662

string

Optional

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

name

string

Required

English display name of the region used across the admin and API responses.

original_name

string

Optional

Native-language name of the region as it appears in the source data.

country

LocationCountrySummary

Required

—

typeLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

original_name

string

Optional

—

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.listRegionsWithResponse(options): Promise<ApiResponse<LocationsListRegionsResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.list_regions(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedRegionList

Asyncawait async_client.locations.list_regions(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedRegionList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
country_code	str	Optional	—
include_asns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	int	Optional	Number of results to return per page.
name	str	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Required	Package whose targeting availability should be returned.
search	str	Optional	Case-insensitive partial search across Region fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.list_regions(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.list_regions(
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedRegionList

The operation completed successfully.

classPaginatedRegionList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Region]

Required

—

classRegion8fields

FieldTypeRequirementDescription

code

str

Required

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france

name

str

Required

English display name of the region used across the admin and API responses.

country

LocationCountrySummary

Required

—

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

original_name

str

Optional

—

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

iso31662

str

Optional

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

original_name

str

Optional

Native-language name of the region as it appears in the source data.

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.list_regions_with_response(*, code: str | Unset=UNSET, country_code: str | Unset=UNSET, include_asns: bool | Unset=UNSET, limit: int | Unset=UNSET, name: str | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID, search: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedRegionList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->listRegions($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRegions'][0], $includeAsns = null)

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
countryCode	string	Optional	—
includeAsns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
limit	int	Optional	Number of results to return per page.
name	string	Optional	—
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Required	Package whose targeting availability should be returned.
search	string	Optional	Case-insensitive partial search across Region fields: `code` and `name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->listRegions(
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedRegionList

The operation completed successfully.

classPaginatedRegionList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Region[]](Region.md)

Required

|

classRegion8fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france |

iso31662

string

Optional

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

name

string

Required

English display name of the region used across the admin and API responses. |

originalName

string

Optional

Native-language name of the region as it appears in the source data.

country

LocationCountrySummary

Required

| [readonly]

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

originalName

string

Required

| [optional]

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->listRegionsWithResponse($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRegions'][0], $includeAsns = null): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->listRegionsWithHttpInfo($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRegions'][0], $includeAsns = null)

  Returns the OpenAPI Generator response tuple.

• $client->locations()->listRegionsAsync($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRegions'][0], $includeAsns = null)

  Returns a Guzzle promise for the decoded result.

• $client->locations()->listRegionsAsyncWithHttpInfo($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRegions'][0], $includeAsns = null)

  Returns a Guzzle promise for the response tuple.

• $client->locations()->listRegionsRequest($packageId, $code = null, $countryCode = null, $limit = null, $name = null, $offset = null, $ordering = null, $search = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRegions'][0], $includeAsns = null)

  Builds the PSR-7 request without sending it.

method

getRegion()

Get a region

Returns one region and its available network targeting options. The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.locations.getRegion(options: LocationsGetRegionOptions): Promise<LocationsGetRegionResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	—
includeAsns	boolean	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.locations.getRegion({
  id: "550e8400-e29b-41d4-a716-446655440000",
  packageId: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

Region

The operation completed successfully.

typeRegion8fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france

iso31662

string

Optional

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

name

string

Required

English display name of the region used across the admin and API responses.

original_name

string

Optional

Native-language name of the region as it appears in the source data.

country

LocationCountrySummary

Required

—

typeLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

original_name

string

Optional

—

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.getRegionWithResponse(options): Promise<ApiResponse<LocationsGetRegionResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.locations.get_region(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> Region

Asyncawait async_client.locations.get_region(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> Region

Parameters

Name	Type	Requirement	Description
id	str	Required	—
include_asns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
package_id	str	Required	Package whose targeting availability should be returned.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.locations.get_region(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.locations.get_region(
        id='550e8400-e29b-41d4-a716-446655440000',
        package_id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

Region

The operation completed successfully.

classRegion8fields

FieldTypeRequirementDescription

code

str

Required

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france

name

str

Required

English display name of the region used across the admin and API responses.

country

LocationCountrySummary

Required

—

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

original_name

str

Optional

—

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

iso31662

str

Optional

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

original_name

str

Optional

Native-language name of the region as it appears in the source data.

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.locations.get_region_with_response(id: str, *, include_asns: bool | Unset=UNSET, package_id: UUID, accept_language: str | Unset=UNSET) -> ApiResponse[Region]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->locations()->getRegion($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getRegion'][0], $includeAsns = null)

Parameters

Name	Type	Requirement	Description
id	string	Required	—
includeAsns	bool	Optional	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
packageId	string	Required	Package whose targeting availability should be returned.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->locations()->getRegion(
    id: '550e8400-e29b-41d4-a716-446655440000',
    packageId: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

Region

The operation completed successfully.

classRegion8fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france |

iso31662

string

Optional

ISO 3166-2 subdivision code for this region. US-CA FR-IDF

name

string

Required

English display name of the region used across the admin and API responses. |

originalName

string

Optional

Native-language name of the region as it appears in the source data.

country

LocationCountrySummary

Required

| [readonly]

classLocationCountrySummary3fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

originalName

string

Required

| [optional]

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->locations()->getRegionWithResponse($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getRegion'][0], $includeAsns = null): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->locations()->getRegionWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getRegion'][0], $includeAsns = null)

  Returns the OpenAPI Generator response tuple.

• $client->locations()->getRegionAsync($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getRegion'][0], $includeAsns = null)

  Returns a Guzzle promise for the decoded result.

• $client->locations()->getRegionAsyncWithHttpInfo($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getRegion'][0], $includeAsns = null)

  Returns a Guzzle promise for the response tuple.

• $client->locations()->getRegionRequest($id, $packageId, $acceptLanguage = null, string $contentType = self::contentTypes['getRegion'][0], $includeAsns = null)

  Builds the PSR-7 request without sending it.