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

Telstra SDK Messaging

import { HttpClient, IAuthConfigProps } from '@telstra/core';
import { TFreeTrialNumbers } from '../types/index.js';
export declare class FreeTrialNumbers extends HttpClient {
    authConfig?: IAuthConfigProps | undefined;
    constructor(authConfig?: IAuthConfigProps | undefined);
    /**
       * Telstra offers a free trial for the messaging API to help you evaluate whether
       * it meets your needs. There are some restrictions that apply compared to the
       * full API, including a maximum number of messages that can be sent and requiring the
       * registration of a limited number of destinations before a message can be sent
       * to that destination.
       * @param data.freeTrialNumbers - A list of destinations, expected to be phone numbers of the form `04XXXXXXXX`.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#RegisteraFreeTrialNumber
       * @example
          ```typescript
          import { FreeTrialNumber } from '@telstra/messaging'
  
          const freeTrialNumber = new FreeTrialNumber();
  
          freeTrialNumber.create({
              freeTrialNumbers: [
                  "<MOBILE_NUMBER>"
              ]
          })
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    create(data: TFreeTrialNumbers): Promise<TFreeTrialNumbers>;
    /**
       * Fetch the Free Trial Number(s) currently assigned to your account.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchyourFreeTrialNumbers
       * @example
          ```typescript
          import { FreeTrialNumber } from '@telstra/messaging'
  
          const freeTrialNumber = new FreeTrialNumber();
  
          freeTrialNumber.getAll({ limit: 10, offset: 0, filter: 'V3' })
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    getAll(): Promise<TFreeTrialNumbers>;
}