Class ServicesApi

Hierarchy

FaxDomainApi
- ServicesApi

Index

Methods

create delete get list listEmailsForNumber listNumbers setBasePath update

Methods

create

create(data: CreateServiceRequestData): Promise<ServiceResponse>
Create a service Creates a new service that you can use to set default configuration values.
Parameters
- data: CreateServiceRequestData
  The data to provide to the API call.
Returns Promise<ServiceResponse>

delete

delete(data: DeleteServiceRequestData): Promise<void>
Remove a service Removes a service from your project.
Parameters
- data: DeleteServiceRequestData
  The data to provide to the API call.
Returns Promise<void>

get

get(data: GetServiceRequestData): Promise<ServiceResponse>
Get a service Get a service resource.
Parameters
- data: GetServiceRequestData
  The data to provide to the API call.
Returns Promise<ServiceResponse>

list

list(data: ListServicesRequestData): ApiListPromise<ServiceResponse>
List services Get a list of services for a project.
Parameters
- data: ListServicesRequestData
  The data to provide to the API call.
Returns ApiListPromise<ServiceResponse>

listEmailsForNumber

listEmailsForNumber(
data: ListEmailsForNumberRequestData,
): ApiListPromise<string>
List emails for a number List any emails for a number.
Parameters
- data: ListEmailsForNumberRequestData
  The data to provide to the API call.
Returns ApiListPromise<string>
- The list of emails for a given number

listNumbers

listNumbers(
data: ListNumbersForServiceRequestData,
): ApiListPromise<ServicePhoneNumber>
List numbers for service List numbers for a service.
Parameters
- data: ListNumbersForServiceRequestData
  The data to provide to the API call.
Returns ApiListPromise<ServicePhoneNumber>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from FaxDomainApi.setBasePath

update

update(data: UpdateServiceRequestData): Promise<ServiceResponse>
Update a Service Update settings on the service.
Parameters
- data: UpdateServiceRequestData
  The data to provide to the API call.
Returns Promise<ServiceResponse>