@azure-tools/communication-toll-free-verification 1.0.0-alpha.20241122.8 → 1.0.0-alpha.20241203.1

package/types/communication-toll-free-verification.d.ts

@@ -1,291 +0,0 @@
-import type { CommonClientOptions } from '@azure/core-client';
-import * as coreClient from '@azure/core-client';
-import type { KeyCredential } from '@azure/core-auth';
-import type { PagedAsyncIterableIterator } from '@azure/core-paging';
-import type { TokenCredential } from '@azure/core-auth';
-
-export declare interface Address {
-    /** Address line 1. */
-    addressLine1?: string;
-    /** Address line 2. */
-    addressLine2?: string;
-    /** The Locality. That would be the City for US addresses, for example. */
-    locality?: string;
-    /** The Administrative Division. That would be the State for US addresses, for example. */
-    administrativeDivision?: string;
-    /** Postal code. */
-    postalCode?: string;
-    /** Country. */
-    country?: string;
-}
-
-/** Defines values for AttachmentType. */
-export declare type AttachmentType = "optInSmsKeyword" | "optInIVR" | "optInPointOfSale" | "optInWebsite" | "optInPaperForm" | "optInOther" | "optInDescription";
-
-export declare interface BusinessInformation {
-    /** Business Name. */
-    companyName?: string;
-    /** Url of corporate website. */
-    companyUrl?: string;
-    address?: Address;
-}
-
-export declare const BusinessInformationMapper: coreClient.CompositeMapper;
-
-export declare interface BusinessPointOfContact {
-    /** First name of the contact at the business. */
-    firstName?: string;
-    /** Last name of the contact at the business. */
-    lastName?: string;
-    /** Phone number of the contact at the business. */
-    phone?: string;
-    /** Email of the contact at the business. */
-    email?: string;
-    address?: Address;
-}
-
-export declare const BusinessPointOfContactMapper: coreClient.CompositeMapper;
-
-export declare interface CampaignBrief {
-    /** Campaign Brief Id. */
-    id: string;
-    /** Campaign Brief status e.g. 'submitted', 'approved', etc */
-    status?: CampaignBriefStatus;
-    /**
-     * Notes added to the Campaign Brief after being reviewed to help customer understand
-     * review results and necessary follow up actions.
-     */
-    reviewNotes?: ReviewNote[];
-    /** Date and time when the Campaign Brief was submitted. */
-    submissionDate?: Date;
-    /** Last date and time when the Campaign Brief status was updated. */
-    statusUpdatedDate?: Date;
-    /** Country code of the Campaign Brief */
-    countryCode?: string;
-    businessPointOfContact?: BusinessPointOfContact;
-    businessInformation?: BusinessInformation;
-    useCaseInfo?: UseCaseInfo;
-    /** List of numbers provisioned for the Campaign e.g. 18881234567 */
-    phoneNumbers?: string[];
-    /** Estimated total messages per month. */
-    estimatedMonthlyVolume?: EstimatedMonthlyVolume;
-    /** Campaign opt in additional information - image URLs or opt in description. */
-    additionalInformation?: string;
-    /** A list of summarized data of attachments currently added to the Campaign Brief */
-    attachments?: CampaignBriefAttachmentSummary[];
-    optInDetails?: OptInDetails;
-    multipleNumbersJustification?: string;
-}
-
-/** A File Attachment for a Campaign Brief */
-export declare interface CampaignBriefAttachment {
-    /** Campaign Brief Attachment Id. */
-    id: string;
-    /**
-     * Attachment type describing the purpose of the attachment
-     * e.g. 'callToAction', 'termsOfService'
-     */
-    type: AttachmentType;
-    /**
-     * The name of the file being attached
-     * e.g. 'myFile01'
-     */
-    fileName: string;
-    /** File size in bytes. */
-    fileSizeInBytes?: number;
-    /**
-     * The type of file being attached
-     * e.g. 'pdf', 'jpg', 'png'
-     */
-    fileType: FileType;
-    /** File content as base 64 encoded string */
-    fileContentBase64: string;
-}
-
-/** A wrapper for a list of CampaignBriefAttachment entities. */
-export declare interface CampaignBriefAttachments {
-    /** List of Campaign Brief attachments. */
-    attachments?: CampaignBriefAttachment[];
-    /** Represents the URL link to the next page. */
-    nextLink?: string;
-}
-
-/** A summary of Campaign Brief File Attachment data */
-export declare interface CampaignBriefAttachmentSummary {
-    /** Campaign Brief Attachment Id. */
-    id?: string;
-    /**
-     * Attachment type describing the purpose of the attachment
-     * e.g. 'callToAction', 'termsOfService'
-     */
-    type?: AttachmentType;
-    /**
-     * The name of the attached file
-     * e.g. 'myFile01'
-     */
-    fileName?: string;
-}
-
-/** A wrapper for a list of CampaignBrief entities. */
-export declare interface CampaignBriefs {
-    /** List of Campaign Briefs. */
-    campaignBriefs?: CampaignBrief[];
-    /** Represents the URL link to the next page. */
-    nextLink?: string;
-}
-
-/** Defines values for CampaignBriefStatus. */
-export declare type CampaignBriefStatus = "submitted" | "approved" | "updateRequested" | "draft" | "cancelled" | "denied";
-
-/** A wrapper for a list of CampaignBriefSummary entities. */
-export declare interface CampaignBriefSummaries {
-    /** List of Campaign Brief Summaries. */
-    campaignBriefSummaries?: CampaignBriefSummary[];
-    /** Represents the URL link to the next page. */
-    nextLink?: string;
-}
-
-/** A summary of Campaign Brief data */
-export declare interface CampaignBriefSummary {
-    /** Campaign Brief Id. */
-    id?: string;
-    /** Country code of the Campaign Brief */
-    countryCode?: string;
-    /** Campaign Brief types e.g. 'tollfreeVerification' */
-    briefType?: "tollfreeVerification";
-    /** Campaign Brief status e.g. 'submitted', 'approved', etc */
-    status?: CampaignBriefStatus;
-    /** List of numbers provisioned for the Campaign e.g. 18881234567 */
-    phoneNumbers?: string[];
-}
-
-/** Defines values for CampaignBriefUseCaseType. */
-export declare type CampaignBriefUseCaseType = "TwoFactorAuthentication" | "AppNotifications" | "Appointments" | "Auctions" | "AutoRepairServices" | "BankTransfers" | "Billing" | "BookingConfirmations" | "BusinessUpdates" | "CareerTraining" | "Chatbot" | "ConversationalOrAlerts" | "CourierServicesAndDeliveries" | "COVID19Alerts" | "EmergencyAlerts" | "EventsAndPlanning" | "FinancialServices" | "FraudAlerts" | "Fundraising" | "GeneralMarketing" | "GeneralSchoolUpdates" | "HealthcareAlerts" | "HousingCommunityUpdates" | "HROrStaffing" | "InsuranceServices" | "JobDispatch" | "LegalServices" | "Mixed" | "MotivationalReminders" | "NotaryNotifications" | "OrderNotifications" | "Political" | "Works" | "RealEstateServices" | "ReligiousServices" | "RepairAndDiagnosticsAlerts" | "RewardsProgram" | "Surveys" | "SystemAlerts" | "VotingReminders" | "WaitlistAlerts" | "WebinarReminders" | "WorkshopAlerts" | "Other";
-
-/** Defines values for EstimatedMonthlyVolume. */
-export declare type EstimatedMonthlyVolume = "V10" | "V100" | "V1000" | "V10000" | "V100000" | "V250000" | "V500000" | "V750000" | "V1000000" | "V5000000" | "V10000000OrMore";
-
-/** Defines values for FileType. */
-export declare type FileType = "png" | "jpg" | "jpeg" | "pdf";
-
-export declare interface OptInDetails {
-    description?: string;
-    options?: Option[];
-}
-
-export declare interface Option {
-    type: Type;
-    imageUrls?: string[];
-}
-
-/** Holds a note about a Campaign Brief that has gone thru stages of review process. */
-export declare interface ReviewNote {
-    /** Note related to a Campaign Brief that may imply changes needed from the client. */
-    message?: string;
-    /** Date and time when the note was added to the Campaign Brief. */
-    date?: Date;
-}
-
-export declare class TollFreeVerificationClient {
-    /**
-     * A reference to the auto-generated Toll Free Verification HTTP client.
-     */
-    private readonly client;
-    constructor(connectionString: string, options?: TollFreeVerificationClientOptions);
-    constructor(endpoint: string, credential: KeyCredential, options?: TollFreeVerificationClientOptions);
-    constructor(endpoint: string, credential: TokenCredential, options?: TollFreeVerificationClientOptions);
-    getCampaignBrief(campaignBriefId: string, countryCode: string, options?: TollFreeVerificationGetCampaignBriefOptionalParams): Promise<CampaignBrief>;
-    listCampaignBriefs(options?: TollFreeVerificationGetAllCampaignBriefSummariesOptionalParams): PagedAsyncIterableIterator<CampaignBriefSummary>;
-    upsertCampaignBrief(campaignBriefId: string, countryCode: string, options?: TollFreeVerificationUpsertCampaignBriefOptionalParams): Promise<CampaignBrief>;
-    deleteCampaignBrief(campaignBriefId: string, countryCode: string, options?: TollFreeVerificationDeleteCampaignBriefOptionalParams): Promise<void>;
-    submitCampaignBrief(campaignBriefId: string, countryCode: string, options?: TollFreeVerificationSubmitCampaignBriefOptionalParams): Promise<TollFreeVerificationSubmitCampaignBriefResponse>;
-    upsertCampaignBriefAttachment(countryCode: string, campaignBriefId: string, attachmentId: string, attachmentType: AttachmentType, fileName: string, fileType: FileType, fileContentBase64: string, options?: TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentOptionalParams): Promise<CampaignBriefAttachment>;
-    deleteCampaignBriefAttachment(campaignBriefId: string, attachmentId: string, countryCode: string, options?: TollFreeVerificationDeleteCampaignBriefAttachmentOptionalParams): Promise<void>;
-    listCampaignBriefAttachments(countryCode: string, campaignBriefId: string, options?: TollFreeVerificationGetCampaignBriefAttachmentsOptionalParams): PagedAsyncIterableIterator<CampaignBrief>;
-    getCampaignBriefAttachment(countryCode: string, campaignBriefId: string, attachmentId: string, options?: TollFreeVerificationGetCampaignBriefAttachmentOptionalParams): Promise<CampaignBrief>;
-}
-
-/**
- * Client options used to configure the TollFreeVerificationClient API requests.
- */
-export declare interface TollFreeVerificationClientOptions extends CommonClientOptions {
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentOptionalParams extends coreClient.OperationOptions {
-    /** File size in bytes. */
-    fileSizeInBytes?: number;
-}
-
-/** Contains response data for the createOrReplaceCampaignBriefAttachment operation. */
-export declare type TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentResponse = CampaignBriefAttachment;
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationDeleteCampaignBriefAttachmentOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationDeleteCampaignBriefOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationGetAllCampaignBriefsByCountryCodeOptionalParams extends coreClient.OperationOptions {
-    /** An optional parameter for how many entries to skip, for pagination purposes. */
-    skip?: number;
-    /** An optional parameter for how many entries to return, for pagination purposes. */
-    top?: number;
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationGetAllCampaignBriefSummariesOptionalParams extends coreClient.OperationOptions {
-    /** An optional parameter for how many entries to skip, for pagination purposes. */
-    skip?: number;
-    /** An optional parameter for how many entries to return, for pagination purposes. */
-    top?: number;
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationGetCampaignBriefAttachmentOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationGetCampaignBriefAttachmentsOptionalParams extends coreClient.OperationOptions {
-    /** An optional parameter for how many entries to skip, for pagination purposes. */
-    skip?: number;
-    /** An optional parameter for how many entries to return, for pagination purposes. */
-    top?: number;
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationGetCampaignBriefOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationSubmitCampaignBriefOptionalParams extends coreClient.OperationOptions {
-}
-
-/** Contains response data for the submitCampaignBrief operation. */
-export declare type TollFreeVerificationSubmitCampaignBriefResponse = CampaignBrief;
-
-/** Optional parameters. */
-export declare interface TollFreeVerificationUpsertCampaignBriefOptionalParams extends coreClient.OperationOptions {
-    /** Data to create new a Campaign Brief or fields to update an existing Campaign Brief */
-    body?: CampaignBrief;
-}
-
-/** Contains response data for the upsertCampaignBrief operation. */
-export declare type TollFreeVerificationUpsertCampaignBriefResponse = CampaignBrief;
-
-/** Defines values for Type. */
-export declare type Type = "keywordSMS" | "website" | "interactiveVoiceResponse" | "pointOfSale" | "paperForm" | "other";
-
-export declare interface UseCaseInfo {
-    /** Sample of messages that will be sent to customers via Sms. */
-    sampleMessages?: string[];
-    /** Use case the campaign will be sending messages for e.g. appointments, sweepstakes. */
-    useCase?: CampaignBriefUseCaseType;
-    /** Description of how the use case is used in the campaign. */
-    useCaseSummary?: string;
-}
-
-export { }