@telstra/messaging/dist/classes/VirtualNumbers.d.ts

Telstra SDK Messaging

import { HttpClient, IAuthConfigProps } from '@telstra/core';
import { TAssignVirtualNumberRequest, TGetAll, TRecipientOptouts, TUpdateVirtualNumberRequest, TVirtualNumber, TVirtualNumbers } from '../types/index.js';
export declare class VirtualNumbers extends HttpClient {
    authConfig?: IAuthConfigProps | undefined;
    constructor(authConfig?: IAuthConfigProps | undefined);
    /**
       * When a recipient receives your message, you can choose whether they'll see a privateNumber,
       * Virtual Number or senderName (paid plans only) in the from field.
       * If you want to use a Virtual Number, use this function to assign one.
       * @param data.replyCallbackUrl - (Optional) The URL that replies to the Virtual Number will be posted to.
       * @param data.tags - (Optional) Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints.
       * You can assign up to 10 tags per number.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#AssignaVirtualNumber
       * @example
          ```typescript
          import { VirtualNumber } from '@telstra/messaging'
  
          const virtualNumber = new VirtualNumber();
  
          virtualNumber.assign({ tags: ['V3','Batch1'] })
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    assign(data?: TAssignVirtualNumberRequest): Promise<TVirtualNumber>;
    /**
       * Fetch all Virtual Numbers currently assigned to your account.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchallVirtualNumbers
       * @example
          ```typescript
          import { VirtualNumber } from '@telstra/messaging'
  
          const virtualNumber = new VirtualNumber();
  
          virtualNumber.getAll()
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    getAll(data?: TGetAll): Promise<TVirtualNumbers>;
    /**
       * Fetch the tags, replyCallbackUrl and lastUse date for a Virtual Number.
       * @param virtualNumber - path param
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchaVirtualNumber
       * @example
          ```typescript
          import { VirtualNumber } from '@telstra/messaging'
  
          const virtualNumber = new VirtualNumber();
  
          virtualNumber.get('0401234567')
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    get(virtualNumber: string): Promise<TVirtualNumber>;
    /**
       * Update a virtual number attributes. For more information.
       * @param virtualNumber - path param
       * @param data.replyCallbackUrl - (Optional) The URL that replies to the Virtual Number will be posted to.
       * @param data.tags - (Optional) Create your own tags and use them to fetch, sort and report on your Virtual Numbers through our other endpoints.
       * You can assign up to 10 tags per number.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#UpdateaVirtualNumber>
       * @example
          ```typescript
          import { VirtualNumber } from '@telstra/messaging'
  
          const virtualNumber = new VirtualNumber();
  
          virtualNumber.update({virtualNumber: '0401234567', updateData: { tags: ['V3','Batch1'] }})
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    update(data: TUpdateVirtualNumberRequest): Promise<TVirtualNumber>;
    /**
       * Delete a mobile number subscription from an account
       * @param virtualNumber - path param
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#DeleteaVirtualNumber
       * @example
          ```typescript
          import { VirtualNumber } from '@telstra/messaging'
  
          const virtualNumber = new VirtualNumber();
  
          virtualNumber.delete('0401234567')
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    delete(virtualNumber: string): Promise<any>;
    /**
       * Fetch any mobile number(s) that have opted out of receiving messages from a Virtual Number assigned to your account.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Fetchallrecipientoptoutslist
       * @example
          ```typescript
          import { VirtualNumber } from '@telstra/messaging'
  
          const virtualNumber = new VirtualNumber();
  
          virtualNumber.getOptouts('0401234567')
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    getOptouts(virtualNumber: string): Promise<TRecipientOptouts>;
}