/** * Bandwidth * Bandwidth\'s Communication APIs * * The version of the OpenAPI document: 1.0.0 * Contact: letstalk@bandwidth.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { TfvStatus } from '../models'; import type { TfvSubmissionWrapper } from '../models'; import type { VerificationRequest } from '../models'; import type { WebhookSubscription } from '../models'; import type { WebhookSubscriptionRequestSchema } from '../models'; import type { WebhookSubscriptionsListBody } from '../models'; /** * TollFreeVerificationApi - axios parameter creator */ export declare const TollFreeVerificationApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time. * @summary Create Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookSubscription: (accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) => Promise; /** * Delete a toll-free verification submission for a toll-free number. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVerificationRequest: (accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig) => Promise; /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookSubscription: (accountId: string, id: string, options?: RawAxiosRequestConfig) => Promise; /** * Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available. * @summary Get Toll-Free Verification Status * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTollFreeVerificationStatus: (accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists valid toll-free use cases. * @summary List Toll-Free Use Cases * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTollFreeUseCases: (options?: RawAxiosRequestConfig) => Promise; /** * Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null). * @summary List Webhook Subscriptions * @param {string} accountId Your Bandwidth Account ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookSubscriptions: (accountId: string, options?: RawAxiosRequestConfig) => Promise; /** * Submit a request for verification of a toll-free phone number. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ requestTollFreeVerification: (accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTollFreeVerificationRequest: (accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig) => Promise; /** * Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated). * @summary Update Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookSubscription: (accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig) => Promise; }; /** * TollFreeVerificationApi - functional programming interface */ export declare const TollFreeVerificationApiFp: (configuration?: Configuration) => { /** * Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time. * @summary Create Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a toll-free verification submission for a toll-free number. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available. * @summary Get Toll-Free Verification Status * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists valid toll-free use cases. * @summary List Toll-Free Use Cases * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTollFreeUseCases(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null). * @summary List Webhook Subscriptions * @param {string} accountId Your Bandwidth Account ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Submit a request for verification of a toll-free phone number. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated). * @summary Update Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * TollFreeVerificationApi - factory interface */ export declare const TollFreeVerificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time. * @summary Create Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a toll-free verification submission for a toll-free number. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available. * @summary Get Toll-Free Verification Status * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists valid toll-free use cases. * @summary List Toll-Free Use Cases * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTollFreeUseCases(options?: RawAxiosRequestConfig): AxiosPromise>; /** * Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null). * @summary List Webhook Subscriptions * @param {string} accountId Your Bandwidth Account ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Submit a request for verification of a toll-free phone number. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig): AxiosPromise; /** * Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated). * @summary Update Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * TollFreeVerificationApi - object-oriented interface */ export declare class TollFreeVerificationApi extends BaseAPI { /** * Create a new webhook subscription (this webhook will be called for every update on every submission). In addition to a `callbackUrl`, this subscription can provide optional HTTP basic authentication credentials (a username and a password). The returned subscription object will contain an ID that can be used to modify or delete the subscription at a later time. * @summary Create Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhookSubscription(accountId: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise>; /** * Delete a toll-free verification submission for a toll-free number. * @summary Delete a Toll-Free Verification Submission * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteVerificationRequest(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise>; /** * Delete a webhook subscription by ID. * @summary Delete Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhookSubscription(accountId: string, id: string, options?: RawAxiosRequestConfig): Promise>; /** * Gets the verification status for a phone number that is provisioned to your account. Submission information will be appended to the response if it is available. * @summary Get Toll-Free Verification Status * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTollFreeVerificationStatus(accountId: string, phoneNumber: string, options?: RawAxiosRequestConfig): Promise>; /** * Lists valid toll-free use cases. * @summary List Toll-Free Use Cases * @param {*} [options] Override http request option. * @throws {RequiredError} */ listTollFreeUseCases(options?: RawAxiosRequestConfig): Promise>; /** * Lists all webhook subscriptions that are registered to receive status updates for the toll-free verification requests submitted under this account (password will not be returned through this API If `basicAuthentication` is defined, the `password` property of that object will be null). * @summary List Webhook Subscriptions * @param {string} accountId Your Bandwidth Account ID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhookSubscriptions(accountId: string, options?: RawAxiosRequestConfig): Promise>; /** * Submit a request for verification of a toll-free phone number. * @summary Request Toll-Free Verification * @param {string} accountId Your Bandwidth Account ID. * @param {VerificationRequest} verificationRequest Request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ requestTollFreeVerification(accountId: string, verificationRequest: VerificationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates a toll-free verification request. Submissions are only eligible for resubmission for 7 days within being processed and if resubmission is allowed (resubmitAllowed field is true). * @summary Update Toll-Free Verification Request * @param {string} accountId Your Bandwidth Account ID. * @param {string} phoneNumber Valid Toll-Free telephone number in E.164 format. * @param {TfvSubmissionWrapper} tfvSubmissionWrapper Update a request for verification of a toll-free phone number. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTollFreeVerificationRequest(accountId: string, phoneNumber: string, tfvSubmissionWrapper: TfvSubmissionWrapper, options?: RawAxiosRequestConfig): Promise>; /** * Update an existing webhook subscription (`callbackUrl` and `basicAuthentication` can be updated). * @summary Update Webhook Subscription * @param {string} accountId Your Bandwidth Account ID. * @param {string} id Webhook subscription ID * @param {WebhookSubscriptionRequestSchema} webhookSubscriptionRequestSchema Information about a webhook that Bandwidth should send upon the completion of event customer is trying to subscribe to. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhookSubscription(accountId: string, id: string, webhookSubscriptionRequestSchema: WebhookSubscriptionRequestSchema, options?: RawAxiosRequestConfig): Promise>; }