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

Telstra SDK Messaging

import { HttpClient, IAuthConfigProps } from '@telstra/core';
import { TCreateReport, TReport } from '../types/index.js';
export declare class Reports extends HttpClient {
    authConfig?: IAuthConfigProps | undefined;
    constructor(authConfig?: IAuthConfigProps | undefined);
    private validateReportIdParam;
    private validateReportDates;
    /**
       * Fetch details of all reports recently generated for your account.
       * Use it to check the status of a report, plus fetch the report ID,
       * status, report type and expiry date.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Fetchallreports
       * @example
          ```typescript
          import { Report } from '@telstra/messaging'
  
          const report = new Report();
  
          report.getAll()
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    getAll(): Promise<TReport[]>;
    /**
       * Use the reportId to fetch a download link for a report generated.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#FetchaReport
       * @example
          ```typescript
          import { Report } from '@telstra/messaging'
  
          const report = new Report();
  
          report.get('6940c774-4335-4d2b-b758-4ecb19412e85')
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    get(reportId: string): Promise<TReport>;
    /**
       * Request a CSV report of messages (both incoming and outgoing) that have been sent to/from your account within the last three months.
       * @param createReport.startDate
       * @param createReport.endDate
       * @param createReport.reportCallbackUrl
       * @param createReport.filter
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Submitarequestforamessagesreport
       * @example
          ```typescript
          import { Report } from '@telstra/messaging'
  
          const report = new Report();
  
          report.create({
              startDate: '2023-03-15',
              endDate: '2023-03-30',
              filter: '0412345678'
          })
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    create(createReport: TCreateReport): Promise<TReport>;
    /**
       * Request a CSV report of messages (both incoming and outgoing) that have been sent to/from your account within the last three months.
       * @param createReport.startDate
       * @param createReport.endDate
       * @param createReport.reportCallbackUrl
       * @param createReport.filter
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#Submitarequestforamessagesreport
       * @example
          ```typescript
          import { Report } from '@telstra/messaging'
  
          const report = new Report();
  
          report.create({
              startDate: '2023-03-15',
              endDate: '2023-03-30',
              filter: '0412345678'
          })
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    createDailySummary(createReport: TCreateReport): Promise<TReport>;
}