@azure-tools/communication-toll-free-verification 1.0.0-alpha.20241111.2 → 1.0.0-alpha.20241113.1

package/dist/commonjs/generated/src/models/index.d.ts

@@ -0,0 +1,283 @@
+import * as coreClient from "@azure/core-client";
+export 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;
+}
+/** Holds a note about a Campaign Brief that has gone thru stages of review process. */
+export 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 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 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;
+}
+export interface BusinessInformation {
+    /** Business Name. */
+    companyName?: string;
+    /** Url of corporate website. */
+    companyUrl?: string;
+    address?: Address;
+}
+export 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;
+}
+/** A summary of Campaign Brief File Attachment data */
+export 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;
+}
+export interface OptInDetails {
+    description?: string;
+    options?: Option[];
+}
+export interface Option {
+    type: Type;
+    imageUrls?: string[];
+}
+/** The Communication Services error. */
+export interface CommunicationErrorResponse {
+    /** The Communication Services error. */
+    error: CommunicationError;
+}
+/** The Communication Services error. */
+export interface CommunicationError {
+    /** The error code. */
+    code: string;
+    /** The error message. */
+    message: string;
+    /**
+     * The error target.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly target?: string;
+    /**
+     * Further details about specific errors that led to this error.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly details?: CommunicationError[];
+    /**
+     * The inner error if any.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly innerError?: CommunicationError;
+}
+/** A wrapper for a list of CampaignBrief entities. */
+export interface CampaignBriefs {
+    /** List of Campaign Briefs. */
+    campaignBriefs?: CampaignBrief[];
+    /** Represents the URL link to the next page. */
+    nextLink?: string;
+}
+/** A wrapper for a list of CampaignBriefSummary entities. */
+export 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 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[];
+}
+/** A File Attachment for a Campaign Brief */
+export 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 interface CampaignBriefAttachments {
+    /** List of Campaign Brief attachments. */
+    attachments?: CampaignBriefAttachment[];
+    /** Represents the URL link to the next page. */
+    nextLink?: string;
+}
+/** Defines values for CampaignBriefStatus. */
+export type CampaignBriefStatus = "submitted" | "approved" | "updateRequested" | "draft" | "cancelled" | "denied";
+/** Defines values for CampaignBriefUseCaseType. */
+export 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 type EstimatedMonthlyVolume = "V10" | "V100" | "V1000" | "V10000" | "V100000" | "V250000" | "V500000" | "V750000" | "V1000000" | "V5000000" | "V10000000OrMore";
+/** Defines values for AttachmentType. */
+export type AttachmentType = "optInSmsKeyword" | "optInIVR" | "optInPointOfSale" | "optInWebsite" | "optInPaperForm" | "optInOther" | "optInDescription";
+/** Defines values for Type. */
+export type Type = "keywordSMS" | "website" | "interactiveVoiceResponse" | "pointOfSale" | "paperForm" | "other";
+/** Defines values for FileType. */
+export type FileType = "png" | "jpg" | "jpeg" | "pdf";
+/** Optional parameters. */
+export 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 type TollFreeVerificationUpsertCampaignBriefResponse = CampaignBrief;
+/** Optional parameters. */
+export interface TollFreeVerificationDeleteCampaignBriefOptionalParams extends coreClient.OperationOptions {
+}
+/** Optional parameters. */
+export interface TollFreeVerificationGetCampaignBriefOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getCampaignBrief operation. */
+export type TollFreeVerificationGetCampaignBriefResponse = CampaignBrief;
+/** Optional parameters. */
+export interface TollFreeVerificationSubmitCampaignBriefOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the submitCampaignBrief operation. */
+export type TollFreeVerificationSubmitCampaignBriefResponse = CampaignBrief;
+/** Optional parameters. */
+export 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;
+}
+/** Contains response data for the getAllCampaignBriefsByCountryCode operation. */
+export type TollFreeVerificationGetAllCampaignBriefsByCountryCodeResponse = CampaignBriefs;
+/** Optional parameters. */
+export 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;
+}
+/** Contains response data for the getAllCampaignBriefSummaries operation. */
+export type TollFreeVerificationGetAllCampaignBriefSummariesResponse = CampaignBriefSummaries;
+/** Optional parameters. */
+export interface TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+    /** File size in bytes. */
+    fileSizeInBytes?: number;
+}
+/** Contains response data for the createOrReplaceCampaignBriefAttachment operation. */
+export type TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentResponse = CampaignBriefAttachment;
+/** Optional parameters. */
+export interface TollFreeVerificationDeleteCampaignBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+}
+/** Optional parameters. */
+export interface TollFreeVerificationGetCampaignBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getCampaignBriefAttachment operation. */
+export type TollFreeVerificationGetCampaignBriefAttachmentResponse = CampaignBriefAttachment;
+/** Optional parameters. */
+export 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;
+}
+/** Contains response data for the getCampaignBriefAttachments operation. */
+export type TollFreeVerificationGetCampaignBriefAttachmentsResponse = CampaignBriefAttachments;
+/** Optional parameters. */
+export interface TollFreeVerificationGetAllCampaignBriefsByCountryCodeNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getAllCampaignBriefsByCountryCodeNext operation. */
+export type TollFreeVerificationGetAllCampaignBriefsByCountryCodeNextResponse = CampaignBriefs;
+/** Optional parameters. */
+export interface TollFreeVerificationGetAllCampaignBriefSummariesNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getAllCampaignBriefSummariesNext operation. */
+export type TollFreeVerificationGetAllCampaignBriefSummariesNextResponse = CampaignBriefSummaries;
+/** Optional parameters. */
+export interface TollFreeVerificationGetCampaignBriefAttachmentsNextOptionalParams extends coreClient.OperationOptions {
+}
+/** Contains response data for the getCampaignBriefAttachmentsNext operation. */
+export type TollFreeVerificationGetCampaignBriefAttachmentsNextResponse = CampaignBriefAttachments;
+/** Optional parameters. */
+export interface TollFreeVerificationClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** Api Version */
+    apiVersion?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/generated/src/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/models/index.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,2DAA2D;IAC3D,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,qEAAqE;IACrE,iBAAiB,CAAC,EAAE,IAAI,CAAC;IACzB,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAChD,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,0CAA0C;IAC1C,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAChD,iFAAiF;IACjF,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,qFAAqF;IACrF,WAAW,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAC/C,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC;AAED,uFAAuF;AACvF,MAAM,WAAW,UAAU;IACzB,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,mEAAmE;IACnE,IAAI,CAAC,EAAE,IAAI,CAAC;CACb;AAED,MAAM,WAAW,sBAAsB;IACrC,iDAAiD;IACjD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4CAA4C;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,OAAO;IACtB,sBAAsB;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,0EAA0E;IAC1E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0FAA0F;IAC1F,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,mBAAmB;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,eAAe;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,qBAAqB;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,iEAAiE;IACjE,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,yFAAyF;IACzF,OAAO,CAAC,EAAE,wBAAwB,CAAC;IACnC,+DAA+D;IAC/D,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,uDAAuD;AACvD,MAAM,WAAW,8BAA8B;IAC7C,oCAAoC;IACpC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,YAAY;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,wCAAwC;AACxC,MAAM,WAAW,0BAA0B;IACzC,wCAAwC;IACxC,KAAK,EAAE,kBAAkB,CAAC;CAC3B;AAED,wCAAwC;AACxC,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;IACxC;;;OAGG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,kBAAkB,CAAC;CAC1C;AAED,sDAAsD;AACtD,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,6DAA6D;AAC7D,MAAM,WAAW,sBAAsB;IACrC,wCAAwC;IACxC,sBAAsB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAChD,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,uCAAuC;AACvC,MAAM,WAAW,oBAAoB;IACnC,yBAAyB;IACzB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yCAAyC;IACzC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uDAAuD;IACvD,SAAS,CAAC,EAAE,sBAAsB,CAAC;IACnC,8DAA8D;IAC9D,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,6CAA6C;AAC7C,MAAM,WAAW,uBAAuB;IACtC,oCAAoC;IACpC,EAAE,EAAE,MAAM,CAAC;IACX;;;OAGG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB,0BAA0B;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB,6CAA6C;IAC7C,iBAAiB,EAAE,MAAM,CAAC;CAC3B;AAED,gEAAgE;AAChE,MAAM,WAAW,wBAAwB;IACvC,0CAA0C;IAC1C,WAAW,CAAC,EAAE,uBAAuB,EAAE,CAAC;IACxC,gDAAgD;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,8CAA8C;AAC9C,MAAM,MAAM,mBAAmB,GAC3B,WAAW,GACX,UAAU,GACV,iBAAiB,GACjB,OAAO,GACP,WAAW,GACX,QAAQ,CAAC;AACb,mDAAmD;AACnD,MAAM,MAAM,wBAAwB,GAChC,yBAAyB,GACzB,kBAAkB,GAClB,cAAc,GACd,UAAU,GACV,oBAAoB,GACpB,eAAe,GACf,SAAS,GACT,sBAAsB,GACtB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,wBAAwB,GACxB,8BAA8B,GAC9B,eAAe,GACf,iBAAiB,GACjB,mBAAmB,GACnB,mBAAmB,GACnB,aAAa,GACb,aAAa,GACb,kBAAkB,GAClB,sBAAsB,GACtB,kBAAkB,GAClB,yBAAyB,GACzB,cAAc,GACd,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,OAAO,GACP,uBAAuB,GACvB,qBAAqB,GACrB,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,oBAAoB,GACpB,mBAAmB,GACnB,4BAA4B,GAC5B,gBAAgB,GAChB,SAAS,GACT,cAAc,GACd,iBAAiB,GACjB,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,OAAO,CAAC;AACZ,iDAAiD;AACjD,MAAM,MAAM,sBAAsB,GAC9B,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,UAAU,GACV,UAAU,GACV,iBAAiB,CAAC;AACtB,yCAAyC;AACzC,MAAM,MAAM,cAAc,GACtB,iBAAiB,GACjB,UAAU,GACV,kBAAkB,GAClB,cAAc,GACd,gBAAgB,GAChB,YAAY,GACZ,kBAAkB,CAAC;AACvB,+BAA+B;AAC/B,MAAM,MAAM,IAAI,GACZ,YAAY,GACZ,SAAS,GACT,0BAA0B,GAC1B,aAAa,GACb,WAAW,GACX,OAAO,CAAC;AACZ,mCAAmC;AACnC,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;AAEtD,2BAA2B;AAC3B,MAAM,WAAW,qDACf,SAAQ,UAAU,CAAC,gBAAgB;IACnC,yFAAyF;IACzF,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AAED,oEAAoE;AACpE,MAAM,MAAM,+CAA+C,GAAG,aAAa,CAAC;AAE5E,2BAA2B;AAC3B,MAAM,WAAW,qDACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,2BAA2B;AAC3B,MAAM,WAAW,kDACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,iEAAiE;AACjE,MAAM,MAAM,4CAA4C,GAAG,aAAa,CAAC;AAEzE,2BAA2B;AAC3B,MAAM,WAAW,qDACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,oEAAoE;AACpE,MAAM,MAAM,+CAA+C,GAAG,aAAa,CAAC;AAE5E,2BAA2B;AAC3B,MAAM,WAAW,mEACf,SAAQ,UAAU,CAAC,gBAAgB;IACnC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qFAAqF;IACrF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,kFAAkF;AAClF,MAAM,MAAM,6DAA6D,GACvE,cAAc,CAAC;AAEjB,2BAA2B;AAC3B,MAAM,WAAW,8DACf,SAAQ,UAAU,CAAC,gBAAgB;IACnC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qFAAqF;IACrF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,6EAA6E;AAC7E,MAAM,MAAM,wDAAwD,GAClE,sBAAsB,CAAC;AAEzB,2BAA2B;AAC3B,MAAM,WAAW,wEACf,SAAQ,UAAU,CAAC,gBAAgB;IACnC,0BAA0B;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,uFAAuF;AACvF,MAAM,MAAM,kEAAkE,GAC5E,uBAAuB,CAAC;AAE1B,2BAA2B;AAC3B,MAAM,WAAW,+DACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,2BAA2B;AAC3B,MAAM,WAAW,4DACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,2EAA2E;AAC3E,MAAM,MAAM,sDAAsD,GAChE,uBAAuB,CAAC;AAE1B,2BAA2B;AAC3B,MAAM,WAAW,6DACf,SAAQ,UAAU,CAAC,gBAAgB;IACnC,mFAAmF;IACnF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qFAAqF;IACrF,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,4EAA4E;AAC5E,MAAM,MAAM,uDAAuD,GACjE,wBAAwB,CAAC;AAE3B,2BAA2B;AAC3B,MAAM,WAAW,uEACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,sFAAsF;AACtF,MAAM,MAAM,iEAAiE,GAC3E,cAAc,CAAC;AAEjB,2BAA2B;AAC3B,MAAM,WAAW,kEACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,iFAAiF;AACjF,MAAM,MAAM,4DAA4D,GACtE,sBAAsB,CAAC;AAEzB,2BAA2B;AAC3B,MAAM,WAAW,iEACf,SAAQ,UAAU,CAAC,gBAAgB;CAAG;AAExC,gFAAgF;AAChF,MAAM,MAAM,2DAA2D,GACrE,wBAAwB,CAAC;AAE3B,2BAA2B;AAC3B,MAAM,WAAW,wCACf,SAAQ,UAAU,CAAC,oBAAoB;IACvC,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/commonjs/generated/src/models/index.js

@@ -0,0 +1,10 @@
+"use strict";
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/commonjs/generated/src/models/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/generated/src/models/index.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\n\nexport interface CampaignBrief {\n  /** Campaign Brief Id. */\n  id: string;\n  /** Campaign Brief status e.g. 'submitted', 'approved', etc */\n  status?: CampaignBriefStatus;\n  /**\n   * Notes added to the Campaign Brief after being reviewed to help customer understand\n   * review results and necessary follow up actions.\n   */\n  reviewNotes?: ReviewNote[];\n  /** Date and time when the Campaign Brief was submitted. */\n  submissionDate?: Date;\n  /** Last date and time when the Campaign Brief status was updated. */\n  statusUpdatedDate?: Date;\n  /** Country code of the Campaign Brief */\n  countryCode?: string;\n  businessPointOfContact?: BusinessPointOfContact;\n  businessInformation?: BusinessInformation;\n  useCaseInfo?: UseCaseInfo;\n  /** List of numbers provisioned for the Campaign e.g. 18881234567 */\n  phoneNumbers?: string[];\n  /** Estimated total messages per month. */\n  estimatedMonthlyVolume?: EstimatedMonthlyVolume;\n  /** Campaign opt in additional information - image URLs or opt in description. */\n  additionalInformation?: string;\n  /** A list of summarized data of attachments currently added to the Campaign Brief */\n  attachments?: CampaignBriefAttachmentSummary[];\n  optInDetails?: OptInDetails;\n  multipleNumbersJustification?: string;\n}\n\n/** Holds a note about a Campaign Brief that has gone thru stages of review process. */\nexport interface ReviewNote {\n  /** Note related to a Campaign Brief that may imply changes needed from the client. */\n  message?: string;\n  /** Date and time when the note was added to the Campaign Brief. */\n  date?: Date;\n}\n\nexport interface BusinessPointOfContact {\n  /** First name of the contact at the business. */\n  firstName?: string;\n  /** Last name of the contact at the business. */\n  lastName?: string;\n  /** Phone number of the contact at the business. */\n  phone?: string;\n  /** Email of the contact at the business. */\n  email?: string;\n  address?: Address;\n}\n\nexport interface Address {\n  /** Address line 1. */\n  addressLine1?: string;\n  /** Address line 2. */\n  addressLine2?: string;\n  /** The Locality. That would be the City for US addresses, for example. */\n  locality?: string;\n  /** The Administrative Division. That would be the State for US addresses, for example. */\n  administrativeDivision?: string;\n  /** Postal code. */\n  postalCode?: string;\n  /** Country. */\n  country?: string;\n}\n\nexport interface BusinessInformation {\n  /** Business Name. */\n  companyName?: string;\n  /** Url of corporate website. */\n  companyUrl?: string;\n  address?: Address;\n}\n\nexport interface UseCaseInfo {\n  /** Sample of messages that will be sent to customers via Sms. */\n  sampleMessages?: string[];\n  /** Use case the campaign will be sending messages for e.g. appointments, sweepstakes. */\n  useCase?: CampaignBriefUseCaseType;\n  /** Description of how the use case is used in the campaign. */\n  useCaseSummary?: string;\n}\n\n/** A summary of Campaign Brief File Attachment data */\nexport interface CampaignBriefAttachmentSummary {\n  /** Campaign Brief Attachment Id. */\n  id?: string;\n  /**\n   * Attachment type describing the purpose of the attachment\n   * e.g. 'callToAction', 'termsOfService'\n   */\n  type?: AttachmentType;\n  /**\n   * The name of the attached file\n   * e.g. 'myFile01'\n   */\n  fileName?: string;\n}\n\nexport interface OptInDetails {\n  description?: string;\n  options?: Option[];\n}\n\nexport interface Option {\n  type: Type;\n  imageUrls?: string[];\n}\n\n/** The Communication Services error. */\nexport interface CommunicationErrorResponse {\n  /** The Communication Services error. */\n  error: CommunicationError;\n}\n\n/** The Communication Services error. */\nexport interface CommunicationError {\n  /** The error code. */\n  code: string;\n  /** The error message. */\n  message: string;\n  /**\n   * The error target.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly target?: string;\n  /**\n   * Further details about specific errors that led to this error.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly details?: CommunicationError[];\n  /**\n   * The inner error if any.\n   * NOTE: This property will not be serialized. It can only be populated by the server.\n   */\n  readonly innerError?: CommunicationError;\n}\n\n/** A wrapper for a list of CampaignBrief entities. */\nexport interface CampaignBriefs {\n  /** List of Campaign Briefs. */\n  campaignBriefs?: CampaignBrief[];\n  /** Represents the URL link to the next page. */\n  nextLink?: string;\n}\n\n/** A wrapper for a list of CampaignBriefSummary entities. */\nexport interface CampaignBriefSummaries {\n  /** List of Campaign Brief Summaries. */\n  campaignBriefSummaries?: CampaignBriefSummary[];\n  /** Represents the URL link to the next page. */\n  nextLink?: string;\n}\n\n/** A summary of Campaign Brief data */\nexport interface CampaignBriefSummary {\n  /** Campaign Brief Id. */\n  id?: string;\n  /** Country code of the Campaign Brief */\n  countryCode?: string;\n  /** Campaign Brief types e.g. 'tollfreeVerification' */\n  briefType?: \"tollfreeVerification\";\n  /** Campaign Brief status e.g. 'submitted', 'approved', etc */\n  status?: CampaignBriefStatus;\n  /** List of numbers provisioned for the Campaign e.g. 18881234567 */\n  phoneNumbers?: string[];\n}\n\n/** A File Attachment for a Campaign Brief */\nexport interface CampaignBriefAttachment {\n  /** Campaign Brief Attachment Id. */\n  id: string;\n  /**\n   * Attachment type describing the purpose of the attachment\n   * e.g. 'callToAction', 'termsOfService'\n   */\n  type: AttachmentType;\n  /**\n   * The name of the file being attached\n   * e.g. 'myFile01'\n   */\n  fileName: string;\n  /** File size in bytes. */\n  fileSizeInBytes?: number;\n  /**\n   * The type of file being attached\n   * e.g. 'pdf', 'jpg', 'png'\n   */\n  fileType: FileType;\n  /** File content as base 64 encoded string */\n  fileContentBase64: string;\n}\n\n/** A wrapper for a list of CampaignBriefAttachment entities. */\nexport interface CampaignBriefAttachments {\n  /** List of Campaign Brief attachments. */\n  attachments?: CampaignBriefAttachment[];\n  /** Represents the URL link to the next page. */\n  nextLink?: string;\n}\n\n/** Defines values for CampaignBriefStatus. */\nexport type CampaignBriefStatus =\n  | \"submitted\"\n  | \"approved\"\n  | \"updateRequested\"\n  | \"draft\"\n  | \"cancelled\"\n  | \"denied\";\n/** Defines values for CampaignBriefUseCaseType. */\nexport type CampaignBriefUseCaseType =\n  | \"TwoFactorAuthentication\"\n  | \"AppNotifications\"\n  | \"Appointments\"\n  | \"Auctions\"\n  | \"AutoRepairServices\"\n  | \"BankTransfers\"\n  | \"Billing\"\n  | \"BookingConfirmations\"\n  | \"BusinessUpdates\"\n  | \"CareerTraining\"\n  | \"Chatbot\"\n  | \"ConversationalOrAlerts\"\n  | \"CourierServicesAndDeliveries\"\n  | \"COVID19Alerts\"\n  | \"EmergencyAlerts\"\n  | \"EventsAndPlanning\"\n  | \"FinancialServices\"\n  | \"FraudAlerts\"\n  | \"Fundraising\"\n  | \"GeneralMarketing\"\n  | \"GeneralSchoolUpdates\"\n  | \"HealthcareAlerts\"\n  | \"HousingCommunityUpdates\"\n  | \"HROrStaffing\"\n  | \"InsuranceServices\"\n  | \"JobDispatch\"\n  | \"LegalServices\"\n  | \"Mixed\"\n  | \"MotivationalReminders\"\n  | \"NotaryNotifications\"\n  | \"OrderNotifications\"\n  | \"Political\"\n  | \"Works\"\n  | \"RealEstateServices\"\n  | \"ReligiousServices\"\n  | \"RepairAndDiagnosticsAlerts\"\n  | \"RewardsProgram\"\n  | \"Surveys\"\n  | \"SystemAlerts\"\n  | \"VotingReminders\"\n  | \"WaitlistAlerts\"\n  | \"WebinarReminders\"\n  | \"WorkshopAlerts\"\n  | \"Other\";\n/** Defines values for EstimatedMonthlyVolume. */\nexport type EstimatedMonthlyVolume =\n  | \"V10\"\n  | \"V100\"\n  | \"V1000\"\n  | \"V10000\"\n  | \"V100000\"\n  | \"V250000\"\n  | \"V500000\"\n  | \"V750000\"\n  | \"V1000000\"\n  | \"V5000000\"\n  | \"V10000000OrMore\";\n/** Defines values for AttachmentType. */\nexport type AttachmentType =\n  | \"optInSmsKeyword\"\n  | \"optInIVR\"\n  | \"optInPointOfSale\"\n  | \"optInWebsite\"\n  | \"optInPaperForm\"\n  | \"optInOther\"\n  | \"optInDescription\";\n/** Defines values for Type. */\nexport type Type =\n  | \"keywordSMS\"\n  | \"website\"\n  | \"interactiveVoiceResponse\"\n  | \"pointOfSale\"\n  | \"paperForm\"\n  | \"other\";\n/** Defines values for FileType. */\nexport type FileType = \"png\" | \"jpg\" | \"jpeg\" | \"pdf\";\n\n/** Optional parameters. */\nexport interface TollFreeVerificationUpsertCampaignBriefOptionalParams\n  extends coreClient.OperationOptions {\n  /** Data to create new a Campaign Brief or fields to update an existing Campaign Brief */\n  body?: CampaignBrief;\n}\n\n/** Contains response data for the upsertCampaignBrief operation. */\nexport type TollFreeVerificationUpsertCampaignBriefResponse = CampaignBrief;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationDeleteCampaignBriefOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetCampaignBriefOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the getCampaignBrief operation. */\nexport type TollFreeVerificationGetCampaignBriefResponse = CampaignBrief;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationSubmitCampaignBriefOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the submitCampaignBrief operation. */\nexport type TollFreeVerificationSubmitCampaignBriefResponse = CampaignBrief;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetAllCampaignBriefsByCountryCodeOptionalParams\n  extends coreClient.OperationOptions {\n  /** An optional parameter for how many entries to skip, for pagination purposes. */\n  skip?: number;\n  /** An optional parameter for how many entries to return, for pagination purposes. */\n  top?: number;\n}\n\n/** Contains response data for the getAllCampaignBriefsByCountryCode operation. */\nexport type TollFreeVerificationGetAllCampaignBriefsByCountryCodeResponse =\n  CampaignBriefs;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetAllCampaignBriefSummariesOptionalParams\n  extends coreClient.OperationOptions {\n  /** An optional parameter for how many entries to skip, for pagination purposes. */\n  skip?: number;\n  /** An optional parameter for how many entries to return, for pagination purposes. */\n  top?: number;\n}\n\n/** Contains response data for the getAllCampaignBriefSummaries operation. */\nexport type TollFreeVerificationGetAllCampaignBriefSummariesResponse =\n  CampaignBriefSummaries;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentOptionalParams\n  extends coreClient.OperationOptions {\n  /** File size in bytes. */\n  fileSizeInBytes?: number;\n}\n\n/** Contains response data for the createOrReplaceCampaignBriefAttachment operation. */\nexport type TollFreeVerificationCreateOrReplaceCampaignBriefAttachmentResponse =\n  CampaignBriefAttachment;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationDeleteCampaignBriefAttachmentOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetCampaignBriefAttachmentOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the getCampaignBriefAttachment operation. */\nexport type TollFreeVerificationGetCampaignBriefAttachmentResponse =\n  CampaignBriefAttachment;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetCampaignBriefAttachmentsOptionalParams\n  extends coreClient.OperationOptions {\n  /** An optional parameter for how many entries to skip, for pagination purposes. */\n  skip?: number;\n  /** An optional parameter for how many entries to return, for pagination purposes. */\n  top?: number;\n}\n\n/** Contains response data for the getCampaignBriefAttachments operation. */\nexport type TollFreeVerificationGetCampaignBriefAttachmentsResponse =\n  CampaignBriefAttachments;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetAllCampaignBriefsByCountryCodeNextOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the getAllCampaignBriefsByCountryCodeNext operation. */\nexport type TollFreeVerificationGetAllCampaignBriefsByCountryCodeNextResponse =\n  CampaignBriefs;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetAllCampaignBriefSummariesNextOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the getAllCampaignBriefSummariesNext operation. */\nexport type TollFreeVerificationGetAllCampaignBriefSummariesNextResponse =\n  CampaignBriefSummaries;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationGetCampaignBriefAttachmentsNextOptionalParams\n  extends coreClient.OperationOptions {}\n\n/** Contains response data for the getCampaignBriefAttachmentsNext operation. */\nexport type TollFreeVerificationGetCampaignBriefAttachmentsNextResponse =\n  CampaignBriefAttachments;\n\n/** Optional parameters. */\nexport interface TollFreeVerificationClientOptionalParams\n  extends coreClient.ServiceClientOptions {\n  /** Api Version */\n  apiVersion?: string;\n  /** Overrides client endpoint. */\n  endpoint?: string;\n}\n"]}

package/dist/commonjs/generated/src/models/mappers.d.ts

@@ -0,0 +1,18 @@
+import * as coreClient from "@azure/core-client";
+export declare const CampaignBrief: coreClient.CompositeMapper;
+export declare const ReviewNote: coreClient.CompositeMapper;
+export declare const BusinessPointOfContact: coreClient.CompositeMapper;
+export declare const Address: coreClient.CompositeMapper;
+export declare const BusinessInformation: coreClient.CompositeMapper;
+export declare const UseCaseInfo: coreClient.CompositeMapper;
+export declare const CampaignBriefAttachmentSummary: coreClient.CompositeMapper;
+export declare const OptInDetails: coreClient.CompositeMapper;
+export declare const Option: coreClient.CompositeMapper;
+export declare const CommunicationErrorResponse: coreClient.CompositeMapper;
+export declare const CommunicationError: coreClient.CompositeMapper;
+export declare const CampaignBriefs: coreClient.CompositeMapper;
+export declare const CampaignBriefSummaries: coreClient.CompositeMapper;
+export declare const CampaignBriefSummary: coreClient.CompositeMapper;
+export declare const CampaignBriefAttachment: coreClient.CompositeMapper;
+export declare const CampaignBriefAttachments: coreClient.CompositeMapper;
+//# sourceMappingURL=mappers.d.ts.map

package/dist/commonjs/generated/src/models/mappers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mappers.d.ts","sourceRoot":"","sources":["../../../../../src/generated/src/models/mappers.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAEjD,eAAO,MAAM,aAAa,EAAE,UAAU,CAAC,eAuHtC,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,UAAU,CAAC,eAmBnC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,UAAU,CAAC,eAsC/C,CAAC;AAEF,eAAO,MAAM,OAAO,EAAE,UAAU,CAAC,eA2ChC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,UAAU,CAAC,eA0B5C,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,UAAU,CAAC,eA8BpC,CAAC;AAEF,eAAO,MAAM,8BAA8B,EAAE,UAAU,CAAC,eAyBvD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,UAAU,CAAC,eAyBrC,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,UAAU,CAAC,eAyB/B,CAAC;AAEF,eAAO,MAAM,0BAA0B,EAAE,UAAU,CAAC,eAcnD,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,UAAU,CAAC,eAgD3C,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,UAAU,CAAC,eAyBvC,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,UAAU,CAAC,eAyB/C,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,UAAU,CAAC,eA4C7C,CAAC;AAEF,eAAO,MAAM,uBAAuB,EAAE,UAAU,CAAC,eAsDhD,CAAC;AAEF,eAAO,MAAM,wBAAwB,EAAE,UAAU,CAAC,eAyBjD,CAAC"}