@azure-tools/communication-short-codes 1.0.0-beta.2 → 1.0.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/communication-short-codes",
-  "version": "1.0.0-beta.2",
+  "version": "1.0.0-beta.3",
   "description": "SDK for Azure Communication Services which facilitates short code management.",
   "sdk-type": "client",
   "main": "dist/index.js",
@@ -20,18 +20,18 @@
     "execute:samples": "dev-tool samples run samples-dev",
     "extract-api": "tsc -p . && api-extractor run --local",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
-    "integration-test:browser": "karma start --single-run",
-    "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 300000  dist-esm/test/public/*.spec.js dist-esm/test/public/node/*.spec.js",
+    "integration-test:browser": "dev-tool run test:browser",
+    "integration-test:node": "dev-tool run test:node-js-input -- --timeout 300000 'dist-esm/test/public/*.spec.js'",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
-    "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
-    "lint": "eslint package.json api-extractor.json src test --ext .ts",
+    "lint:fix": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js --fix --fix-type [problem,suggestion]",
+    "lint": "eslint package.json api-extractor.json README.md src test --ext .ts,.javascript,.js",
     "pack": "npm pack 2>&1",
     "test": "rimraf dist-test && npm run build:test && npm run unit-test && npm run integration-test",
     "test:browser": "npm run build:test && npm run unit-test:browser && npm run integration-test:browser",
     "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
     "test:watch": "npm run test -- --watch --reporter min",
-    "unit-test:browser": "karma start --single-run",
-    "unit-test:node": "mocha -r esm -r ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace --exclude \"test/**/browser/*.spec.ts\" \"test/**/*.spec.ts\"",
+    "unit-test:browser": "dev-tool run test:browser",
+    "unit-test:node": "dev-tool run test:node-ts-input -- --exclude 'test/**/browser/*.spec.ts' 'test/**/*.spec.ts'",
     "unit-test": "npm run unit-test:node && npm run unit-test:browser"
   },
   "files": [
@@ -72,12 +72,12 @@
     "tslib": "^2.2.0"
   },
   "devDependencies": {
-    "@azure-tools/test-recorder": "^1.0.0",
+    "@azure-tools/test-recorder": "^2.0.0",
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/identity": "^2.0.1",
     "@azure/test-utils": "^1.0.0",
-    "@microsoft/api-extractor": "^7.18.11",
+    "@microsoft/api-extractor": "7.18.11",
     "@types/chai": "^4.1.6",
     "@types/mocha": "^7.0.2",
     "@types/node": "^12.0.0",
@@ -85,7 +85,7 @@
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
     "dotenv": "^8.2.0",
-    "eslint": "^7.15.0",
+    "eslint": "^8.0.0",
     "inherits": "^2.0.3",
     "karma": "^6.2.0",
     "karma-chrome-launcher": "^3.0.0",
@@ -94,8 +94,6 @@
     "karma-env-preprocessor": "^0.1.1",
     "karma-firefox-launcher": "^1.1.0",
     "karma-ie-launcher": "^1.0.0",
-    "karma-json-preprocessor": "^0.3.3",
-    "karma-json-to-file-reporter": "^1.0.1",
     "karma-junit-reporter": "^2.0.1",
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",

package/types/communication-short-codes.d.ts

@@ -7,9 +7,15 @@ import { OperationOptions } from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { TokenCredential } from '@azure/core-auth';
 
+/** Defines values for AttachmentType. */
+export declare type AttachmentType = "callToAction" | "termsOfService" | "privacyPolicy" | "other";
+
 /** Defines values for BillingFrequency. */
 export declare type BillingFrequency = "monthly" | "once";
 
+/** Defines values for CallToActionType. */
+export declare type CallToActionType = "website" | "pointOfSale" | "sms" | "interactiveVoiceResponse";
+
 export declare interface CompanyInformation {
     /** Legal entity name for customer submitting Program Brief. */
     name?: string;
@@ -47,6 +53,9 @@ export declare interface CustomerCareInformation {
 export declare interface DeleteUSProgramBriefOptions extends OperationOptions {
 }
 
+/** Defines values for FileType. */
+export declare type FileType = "png" | "jpg" | "jpeg" | "pdf";
+
 /**
  * Additional options for the Get US Program Brief request.
  */
@@ -65,28 +74,28 @@ export declare interface ListShortCodesOptions extends ShortCodesGetShortCodesOp
 export declare interface ListUSProgramBriefsOptions extends OperationOptions {
 }
 
-/** Defines values for MessageContentCategory. */
-export declare type MessageContentCategory = "ringTones" | "smsChat" | "video" | "loyaltyProgramPointsPrizes" | "gifting" | "inApplicationBilling" | "textToScreen" | "games" | "audioChat" | "mmsPictures" | "sweepstakesContestAuction" | "financialBanking" | "premiumWap" | "queryService" | "wallpaperScreensaver" | "voting" | "application" | "mobileGivingDonations" | "coupons" | "loyaltyProgram" | "noPointsPrizes" | "informationalAlerts" | "microBilling" | "trivia" | "entertainmentAlerts" | "accountNotification" | "ageGatedContent" | "conversationalMessaging" | "deliveryNotification" | "education" | "emergencyAlerts" | "fraudAlerts" | "loanArrangement" | "onBehalfOfCarrier" | "political" | "promotionalMarketing" | "publicServiceAnnouncements" | "securityAlerts" | "socialMedia" | "twoFactorAuthentication" | "other";
+/** Defines values for MessageContentType. */
+export declare type MessageContentType = "accountNotificationInformationalAlerts" | "ageGatedContent" | "chatConversationalMessaging" | "deliveryNotification" | "donationsPledge" | "education" | "fraudAlerts" | "loanArrangement" | "loyaltyProgram" | "marketingAndPromotion" | "mmsPicture" | "mmsVideo" | "oneTimePasswordOrMultiFactorAuthentication" | "political" | "publicServiceAnnouncements" | "securityAlerts" | "socialMedia" | "sweepstakesOrContest" | "votingOrPolling" | "other";
 
 export declare interface MessageDetails {
-    /** Applicable message protocols used in the program e.g. SMS, MMS. */
-    supportedProtocols?: MessageProtocol[];
+    /** Applicable message protocol used in the program e.g. SMS or MMS. */
+    supportedProtocol?: MessageProtocol;
     /** Indicates the nature of the messaging associated with the program e.g. 'subscription', 'transaction'. */
     recurrence?: Recurrence;
     /**
      * Message text for mobile terminated message associated with HELP keyword
      * e.g 'This is the HELP message test.'.
      */
-    helpMessage?: string;
+    helpAnswerToUser?: string;
     /**
      * "Message text for mobile terminated message associated with STOP keyword
      * e.g. 'This is the STOP message test.'.
      */
-    optOutMessage?: string;
-    optInMessage?: string;
+    optOutAnswerToUser?: string;
+    optInMessageToUser?: string;
     /** Keyword used to confirm double Opt-In method e.g. 'JOIN'. */
-    optInReply?: string;
-    confirmationMessage?: string;
+    optInAnswerFromUser?: string;
+    optInConfirmationMessageToUser?: string;
     /** Describes directionality e.g. oneWay or twoWay */
     directionality?: MessageDirectionality;
     /** Provides message exchange examples from and to end user for each supported message content type. */
@@ -119,6 +128,47 @@ export declare type MessageProtocol = "sms" | "mms";
 /** Defines values for NumberType. */
 export declare type NumberType = "shortCode" | "alphaId";
 
+/** A File Attachment for a Program Brief */
+export declare interface ProgramBriefAttachment {
+    /** Program 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 summary of Program Brief File Attachment data */
+export declare interface ProgramBriefAttachmentSummary {
+    /** Program 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;
+}
+
 /** Defines values for ProgramBriefStatus. */
 export declare type ProgramBriefStatus = "submitted" | "approved" | "submitNewVanityNumbers" | "updateProgramBrief" | "draft" | "denied";
 
@@ -145,9 +195,11 @@ export declare interface ProgramDetails {
     /** URL for the program or company. */
     url?: string;
     /** Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'. */
-    signUpTypes?: ProgramSignUpType[];
+    callToActionTypes?: CallToActionType[];
     /** URL for "call to action" image for the program. */
-    signUpUrl?: string;
+    callToActionUrl?: string;
+    /** Call to action text. To be provided when InteractiveVoiceResponse is specified as call to action type */
+    callToAction?: string;
     /** URL for program terms of service. */
     termsOfServiceUrl?: string;
     /** URL for privacy policy. */
@@ -160,9 +212,6 @@ export declare interface ProgramDetails {
     expectedDateOfService?: Date;
 }
 
-/** Defines values for ProgramSignUpType. */
-export declare type ProgramSignUpType = "website" | "pointOfSale" | "sms" | "interactiveVoiceResponse";
-
 /** Defines values for Recurrence. */
 export declare type Recurrence = "subscription" | "transaction";
 
@@ -212,6 +261,10 @@ export declare class ShortCodesClient {
     getUSProgramBrief(programBriefId: string, options?: GetUSProgramBriefOptions): Promise<USProgramBrief>;
     listUSProgramBriefs(options?: ListUSProgramBriefsOptions): PagedAsyncIterableIterator<USProgramBrief>;
     submitUSProgramBrief(programBriefId: string, options?: SubmitUSProgramBriefOptions): Promise<USProgramBrief>;
+    getUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesGetUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>;
+    listUSProgramBriefAttachments(programBriefId: string, options?: ShortCodesGetUSProgramBriefAttachmentsOptionalParams): PagedAsyncIterableIterator<ProgramBriefAttachment>;
+    deleteUSProgramBriefAttachment(programBriefId: string, attachmentId: string, options?: ShortCodesDeleteUSProgramBriefAttachmentOptionalParams): Promise<void>;
+    createOrReplaceUSProgramBriefAttachment(programBriefId: string, attachmentId: string, fileName: string, fileType: FileType, fileContent: string, attachmentType: AttachmentType, options?: ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams): Promise<ProgramBriefAttachment>;
 }
 
 /**
@@ -220,6 +273,16 @@ export declare class ShortCodesClient {
 export declare interface ShortCodesClientOptions extends CommonClientOptions {
 }
 
+/** Optional parameters. */
+export declare interface ShortCodesCreateOrReplaceUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+    /** File size in bytes. */
+    fileSizeInBytes?: number;
+}
+
+/** Optional parameters. */
+export declare interface ShortCodesDeleteUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+}
+
 /** Optional parameters. */
 export declare interface ShortCodesGetShortCodesOptionalParams extends coreClient.OperationOptions {
     /** An optional parameter for how many entries to skip, for pagination purposes. */
@@ -228,6 +291,18 @@ export declare interface ShortCodesGetShortCodesOptionalParams extends coreClien
     top?: number;
 }
 
+/** Optional parameters. */
+export declare interface ShortCodesGetUSProgramBriefAttachmentOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface ShortCodesGetUSProgramBriefAttachmentsOptionalParams 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 ShortCodesUpsertUSProgramBriefOptionalParams extends coreClient.OperationOptions {
     /** Data to create new a Program Brief or fields to update an existing Program Brief */
@@ -260,8 +335,10 @@ export declare interface TrafficDetails {
 
 /** Describes a messaging use case for a given content type by providing example messages. */
 export declare interface UseCase {
-    /** Indicates the messaging content category used in the program e.g. 'ringTones', 'smsChat', 'video', 'loyaltyProgramPointsPrizes', 'gifting', 'inApplicationBilling', 'textToScreen'. */
-    contentCategory?: MessageContentCategory;
+    /** Indicates the messaging content type used in the program e.g. 'accountNotificationInformationalAlerts', 'chatConversationalMessaging', 'mmsVideo', 'socialMedia'. */
+    contentType?: MessageContentType;
+    /** Indicates the messaging content type used in the program whenever it is not any of the pre-defined content types */
+    customContentType?: string;
     /** Example messages to be sent to and from the end user for the indicated content type. */
     examples?: MessageExampleSequence[];
 }
@@ -293,6 +370,8 @@ export declare interface USProgramBrief {
     companyInformation?: CompanyInformation;
     messageDetails?: MessageDetails;
     trafficDetails?: TrafficDetails;
+    /** A list of summarized data of attachments currently added to the Program Brief */
+    attachments?: ProgramBriefAttachmentSummary[];
 }
 
 export { }

package/CHANGELOG.md

@@ -1,17 +0,0 @@
-# Release History
-
-## 1.0.0-beta.2 (2022-03-31)
-### Features Added
-- Migrated from using `@azure/core-http` to `@azure/core-rest-pipeline` for the handling of HTTP requests. See [Azure Core v1 vs v2](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/documentation/core2.md) for more on the difference and benefits of the move.
-
-### Breaking Changes
-- `ShortCodesClient.submitUSProgramBrief` no longer returns the generic `RestResponse` type, and instead returns the more specific `USProgramBrief`. Because of this, the `_response` property is no longer exposed in the returned object. However, in the operation options, it can take a callback (`onResponse`) to access the HTTP response. See https://github.com/Azure/autorest.typescript/wiki/%60core-http%60-dependency-migration-to-%60core-client%60-%60core-rest-pipeline%60#change-to-the-_response-property
-
-## 1.0.0-beta.1 (2021-11-05)
-
-The first preview of the Azure Communication Short Codes Client has the following features:
-
-- Management of US Program Briefs
-  - Create, Update, Get, List & Delete
-- US Program Brief submission for review to opt for a Short Code
-- List owned Short Codes