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

package/README.md

@@ -7,7 +7,7 @@ The phone numbers library provides capabilities for short codes administration.
 ### Prerequisites
 
 - An [Azure subscription][azure_sub].
-- An existing Communication Services resource. If you need to create the resource, you can use the [Azure Portal][azure_portal], the[Azure PowerShell][azure_powershell], or the [Azure CLI][azure_cli].
+- An existing Communication Services resource. If you need to create the resource, you can use the [Azure Portal][azure_portal], the [Azure PowerShell][azure_powershell], or the [Azure CLI][azure_cli].
 
 ### Installing
 

package/dist/index.js

@@ -2,8 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var communicationCommon = require('@azure/communication-common');
 var coreAuth = require('@azure/core-auth');
+var communicationCommon = require('@azure/communication-common');
 var coreTracing = require('@azure/core-tracing');
 var logger$1 = require('@azure/logger');
 var coreClient = require('@azure/core-client');
@@ -274,6 +274,18 @@ const USProgramBrief = {
                     name: "Composite",
                     className: "TrafficDetails"
                 }
+            },
+            attachments: {
+                serializedName: "attachments",
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "ProgramBriefAttachmentSummary"
+                        }
+                    }
+                }
             }
         }
     }
@@ -379,8 +391,8 @@ const ProgramDetails = {
                     name: "String"
                 }
             },
-            signUpTypes: {
-                serializedName: "signUpTypes",
+            callToActionTypes: {
+                serializedName: "callToActionTypes",
                 type: {
                     name: "Sequence",
                     element: {
@@ -396,8 +408,14 @@ const ProgramDetails = {
                     }
                 }
             },
-            signUpUrl: {
-                serializedName: "signUpUrl",
+            callToActionUrl: {
+                serializedName: "callToActionUrl",
+                type: {
+                    name: "String"
+                }
+            },
+            callToAction: {
+                serializedName: "callToAction",
                 type: {
                     name: "String"
                 }
@@ -514,16 +532,10 @@ const MessageDetails = {
         name: "Composite",
         className: "MessageDetails",
         modelProperties: {
-            supportedProtocols: {
-                serializedName: "supportedProtocols",
+            supportedProtocol: {
+                serializedName: "supportedProtocol",
                 type: {
-                    name: "Sequence",
-                    element: {
-                        type: {
-                            name: "Enum",
-                            allowedValues: ["sms", "mms"]
-                        }
-                    }
+                    name: "String"
                 }
             },
             recurrence: {
@@ -532,32 +544,32 @@ const MessageDetails = {
                     name: "String"
                 }
             },
-            helpMessage: {
-                serializedName: "helpMessage",
+            helpAnswerToUser: {
+                serializedName: "helpAnswerToUser",
                 type: {
                     name: "String"
                 }
             },
-            optOutMessage: {
-                serializedName: "optOutMessage",
+            optOutAnswerToUser: {
+                serializedName: "optOutAnswerToUser",
                 type: {
                     name: "String"
                 }
             },
-            optInMessage: {
-                serializedName: "optInMessage",
+            optInMessageToUser: {
+                serializedName: "optInMessageToUser",
                 type: {
                     name: "String"
                 }
             },
-            optInReply: {
-                serializedName: "optInReply",
+            optInAnswerFromUser: {
+                serializedName: "optInAnswerFromUser",
                 type: {
                     name: "String"
                 }
             },
-            confirmationMessage: {
-                serializedName: "confirmationMessage",
+            optInConfirmationMessageToUser: {
+                serializedName: "optInConfirmationMessageToUser",
                 type: {
                     name: "String"
                 }
@@ -588,8 +600,14 @@ const UseCase = {
         name: "Composite",
         className: "UseCase",
         modelProperties: {
-            contentCategory: {
-                serializedName: "contentCategory",
+            contentType: {
+                serializedName: "contentType",
+                type: {
+                    name: "String"
+                }
+            },
+            customContentType: {
+                serializedName: "customContentType",
                 type: {
                     name: "String"
                 }
@@ -709,6 +727,32 @@ const TrafficDetails = {
         }
     }
 };
+const ProgramBriefAttachmentSummary = {
+    type: {
+        name: "Composite",
+        className: "ProgramBriefAttachmentSummary",
+        modelProperties: {
+            id: {
+                serializedName: "id",
+                type: {
+                    name: "Uuid"
+                }
+            },
+            type: {
+                serializedName: "type",
+                type: {
+                    name: "String"
+                }
+            },
+            fileName: {
+                serializedName: "fileName",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 const USProgramBriefs = {
     type: {
         name: "Composite",
@@ -735,6 +779,81 @@ const USProgramBriefs = {
         }
     }
 };
+const ProgramBriefAttachment = {
+    type: {
+        name: "Composite",
+        className: "ProgramBriefAttachment",
+        modelProperties: {
+            id: {
+                serializedName: "id",
+                required: true,
+                type: {
+                    name: "Uuid"
+                }
+            },
+            type: {
+                serializedName: "type",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            fileName: {
+                serializedName: "fileName",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            fileSizeInBytes: {
+                serializedName: "fileSizeInBytes",
+                type: {
+                    name: "Number"
+                }
+            },
+            fileType: {
+                serializedName: "fileType",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            },
+            fileContentBase64: {
+                serializedName: "fileContentBase64",
+                required: true,
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
+const ProgramBriefAttachments = {
+    type: {
+        name: "Composite",
+        className: "ProgramBriefAttachments",
+        modelProperties: {
+            attachments: {
+                serializedName: "attachments",
+                type: {
+                    name: "Sequence",
+                    element: {
+                        type: {
+                            name: "Composite",
+                            className: "ProgramBriefAttachment"
+                        }
+                    }
+                }
+            },
+            nextLink: {
+                serializedName: "nextLink",
+                type: {
+                    name: "String"
+                }
+            }
+        }
+    }
+};
 
 var Mappers = /*#__PURE__*/Object.freeze({
     __proto__: null,
@@ -754,7 +873,10 @@ var Mappers = /*#__PURE__*/Object.freeze({
     MessageExampleSequence: MessageExampleSequence,
     MessageExample: MessageExample,
     TrafficDetails: TrafficDetails,
-    USProgramBriefs: USProgramBriefs
+    ProgramBriefAttachmentSummary: ProgramBriefAttachmentSummary,
+    USProgramBriefs: USProgramBriefs,
+    ProgramBriefAttachment: ProgramBriefAttachment,
+    ProgramBriefAttachments: ProgramBriefAttachments
 });
 
 /*
@@ -842,6 +964,27 @@ const programBriefId = {
         }
     }
 };
+const contentType1 = {
+    parameterPath: ["options", "contentType"],
+    mapper: {
+        defaultValue: "application/json",
+        isConstant: true,
+        serializedName: "Content-Type",
+        type: {
+            name: "String"
+        }
+    }
+};
+const attachmentId = {
+    parameterPath: "attachmentId",
+    mapper: {
+        serializedName: "attachmentId",
+        required: true,
+        type: {
+            name: "Uuid"
+        }
+    }
+};
 const nextLink = {
     parameterPath: "nextLink",
     mapper: {
@@ -967,6 +1110,55 @@ class ShortCodesOperationsImpl {
             }
         });
     }
+    /**
+     * Gets the list of attachments from a US Program Brief.
+     * @param programBriefId
+     * @param options The options parameters.
+     */
+    listUSProgramBriefAttachments(programBriefId, options) {
+        const iter = this.getUSProgramBriefAttachmentsPagingAll(programBriefId, options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.getUSProgramBriefAttachmentsPagingPage(programBriefId, options);
+            }
+        };
+    }
+    getUSProgramBriefAttachmentsPagingPage(programBriefId, options) {
+        return tslib.__asyncGenerator(this, arguments, function* getUSProgramBriefAttachmentsPagingPage_1() {
+            let result = yield tslib.__await(this._getUSProgramBriefAttachments(programBriefId, options));
+            yield yield tslib.__await(result.attachments || []);
+            let continuationToken = result.nextLink;
+            while (continuationToken) {
+                result = yield tslib.__await(this._getUSProgramBriefAttachmentsNext(programBriefId, continuationToken, options));
+                continuationToken = result.nextLink;
+                yield yield tslib.__await(result.attachments || []);
+            }
+        });
+    }
+    getUSProgramBriefAttachmentsPagingAll(programBriefId, options) {
+        return tslib.__asyncGenerator(this, arguments, function* getUSProgramBriefAttachmentsPagingAll_1() {
+            var e_3, _a;
+            try {
+                for (var _b = tslib.__asyncValues(this.getUSProgramBriefAttachmentsPagingPage(programBriefId, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
+                    const page = _c.value;
+                    yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
+                }
+            }
+            catch (e_3_1) { e_3 = { error: e_3_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
+                }
+                finally { if (e_3) throw e_3.error; }
+            }
+        });
+    }
     /**
      * Gets the list of short codes for the current resource.
      * @param options The options parameters.
@@ -1013,6 +1205,58 @@ class ShortCodesOperationsImpl {
     _getUSProgramBriefs(options) {
         return this.client.sendOperationRequest({ options }, getUSProgramBriefsOperationSpec);
     }
+    /**
+     * Creates or replace an attachment on a US Program Brief.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param attachmentId Attachment Id. Must be a valid GUID
+     * @param id Program Brief Attachment Id.
+     * @param fileName The name of the file being attached
+     *                 e.g. 'myFile01'
+     * @param fileType The type of file being attached
+     *                 e.g. 'pdf', 'jpg', 'png'
+     * @param fileContentBase64 File content as base 64 encoded string
+     * @param type Attachment type describing the purpose of the attachment
+     *             e.g. 'callToAction', 'termsOfService'
+     * @param options The options parameters.
+     */
+    createOrReplaceUSProgramBriefAttachment(programBriefId, attachmentId, id, fileName, fileType, fileContentBase64, type, options) {
+        return this.client.sendOperationRequest({
+            programBriefId,
+            attachmentId,
+            id,
+            fileName,
+            fileType,
+            fileContentBase64,
+            type,
+            options
+        }, createOrReplaceUSProgramBriefAttachmentOperationSpec);
+    }
+    /**
+     * Gets a specific an attachment from a US Program Brief.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param attachmentId Attachment Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    getUSProgramBriefAttachment(programBriefId, attachmentId, options) {
+        return this.client.sendOperationRequest({ programBriefId, attachmentId, options }, getUSProgramBriefAttachmentOperationSpec);
+    }
+    /**
+     * Deletes a specific attachment from a US Program Brief.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param attachmentId Attachment Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    deleteUSProgramBriefAttachment(programBriefId, attachmentId, options) {
+        return this.client.sendOperationRequest({ programBriefId, attachmentId, options }, deleteUSProgramBriefAttachmentOperationSpec);
+    }
+    /**
+     * Gets the list of attachments from a US Program Brief.
+     * @param programBriefId
+     * @param options The options parameters.
+     */
+    _getUSProgramBriefAttachments(programBriefId, options) {
+        return this.client.sendOperationRequest({ programBriefId, options }, getUSProgramBriefAttachmentsOperationSpec);
+    }
     /**
      * GetShortCodesNext
      * @param nextLink The nextLink from the previous successful call to the GetShortCodes method.
@@ -1029,6 +1273,16 @@ class ShortCodesOperationsImpl {
     _getUSProgramBriefsNext(nextLink, options) {
         return this.client.sendOperationRequest({ nextLink, options }, getUSProgramBriefsNextOperationSpec);
     }
+    /**
+     * GetUSProgramBriefAttachmentsNext
+     * @param programBriefId
+     * @param nextLink The nextLink from the previous successful call to the GetUSProgramBriefAttachments
+     *                 method.
+     * @param options The options parameters.
+     */
+    _getUSProgramBriefAttachmentsNext(programBriefId, nextLink, options) {
+        return this.client.sendOperationRequest({ programBriefId, nextLink, options }, getUSProgramBriefAttachmentsNextOperationSpec);
+    }
 }
 // Operation Specifications
 const serializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ false);
@@ -1131,6 +1385,95 @@ const getUSProgramBriefsOperationSpec = {
     headerParameters: [accept],
     serializer
 };
+const createOrReplaceUSProgramBriefAttachmentOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments/{attachmentId}",
+    httpMethod: "PUT",
+    responses: {
+        200: {
+            bodyMapper: ProgramBriefAttachment
+        },
+        201: {
+            bodyMapper: ProgramBriefAttachment
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    requestBody: {
+        parameterPath: {
+            id: ["id"],
+            type: ["type"],
+            fileName: ["fileName"],
+            fileSizeInBytes: ["options", "fileSizeInBytes"],
+            fileType: ["fileType"],
+            fileContentBase64: ["fileContentBase64"]
+        },
+        mapper: Object.assign(Object.assign({}, ProgramBriefAttachment), { required: true })
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [
+        endpoint,
+        programBriefId,
+        attachmentId
+    ],
+    headerParameters: [accept, contentType1],
+    mediaType: "json",
+    serializer
+};
+const getUSProgramBriefAttachmentOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments/{attachmentId}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: ProgramBriefAttachment
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [
+        endpoint,
+        programBriefId,
+        attachmentId
+    ],
+    headerParameters: [accept],
+    serializer
+};
+const deleteUSProgramBriefAttachmentOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments/{attachmentId}",
+    httpMethod: "DELETE",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [apiVersion],
+    urlParameters: [
+        endpoint,
+        programBriefId,
+        attachmentId
+    ],
+    headerParameters: [accept],
+    serializer
+};
+const getUSProgramBriefAttachmentsOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: ProgramBriefAttachments
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [skip, top, apiVersion],
+    urlParameters: [endpoint, programBriefId],
+    headerParameters: [accept],
+    serializer
+};
 const getShortCodesNextOperationSpec = {
     path: "{nextLink}",
     httpMethod: "GET",
@@ -1163,6 +1506,26 @@ const getUSProgramBriefsNextOperationSpec = {
     headerParameters: [accept],
     serializer
 };
+const getUSProgramBriefAttachmentsNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: ProgramBriefAttachments
+        },
+        default: {
+            bodyMapper: CommunicationErrorResponse
+        }
+    },
+    queryParameters: [skip, top, apiVersion],
+    urlParameters: [
+        endpoint,
+        programBriefId,
+        nextLink
+    ],
+    headerParameters: [accept],
+    serializer
+};
 
 /*
  * Copyright (c) Microsoft Corporation.
@@ -1188,7 +1551,7 @@ class ShortCodesClientContext extends coreClient__namespace.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-communication-short-codes/1.0.0-beta.2`;
+        const packageDetails = `azsdk-js-communication-short-codes/1.0.0-beta.3`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1222,7 +1585,6 @@ class ShortCodesClient$1 extends ShortCodesClientContext {
     }
 }
 
-// Copyright (c) Microsoft Corporation.
 const isShortCodesClientOptions = (options) => options && !communicationCommon.isKeyCredential(options) && !coreAuth.isTokenCredential(options);
 class ShortCodesClient {
     constructor(connectionStringOrUrl, credentialOrOptions, maybeOptions = {}) {
@@ -1335,6 +1697,70 @@ class ShortCodesClient {
             span.end();
         }
     }
+    async getUSProgramBriefAttachment(programBriefId, attachmentId, options) {
+        const { span, updatedOptions } = createSpan("ShortCodesClient-getUSProgramBriefAttachment", options);
+        try {
+            return await this.client.shortCodesOperations.getUSProgramBriefAttachment(programBriefId, attachmentId, updatedOptions);
+        }
+        catch (e) {
+            span.setStatus({
+                code: coreTracing.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    listUSProgramBriefAttachments(programBriefId, options = {}) {
+        const { span, updatedOptions } = createSpan("ShortCodesClient-listUSProgramBriefAttachments", options);
+        try {
+            return this.client.shortCodesOperations.listUSProgramBriefAttachments(programBriefId, updatedOptions);
+        }
+        catch (e) {
+            span.setStatus({
+                code: coreTracing.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async deleteUSProgramBriefAttachment(programBriefId, attachmentId, options) {
+        const { span, updatedOptions } = createSpan("ShortCodesClient-deleteUSProgramBriefAttachment", options);
+        try {
+            return await this.client.shortCodesOperations.deleteUSProgramBriefAttachment(programBriefId, attachmentId, updatedOptions);
+        }
+        catch (e) {
+            span.setStatus({
+                code: coreTracing.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
+    async createOrReplaceUSProgramBriefAttachment(programBriefId, attachmentId, fileName, fileType, fileContent, attachmentType, options = {}) {
+        const { span, updatedOptions } = createSpan("ShortCodesClient-createOrReplaceUSProgramBriefAttachment", options);
+        try {
+            return await this.client.shortCodesOperations.createOrReplaceUSProgramBriefAttachment(programBriefId, attachmentId, attachmentId, fileName, fileType, fileContent, attachmentType, updatedOptions);
+        }
+        catch (e) {
+            span.setStatus({
+                code: coreTracing.SpanStatusCode.ERROR,
+                message: e.message,
+            });
+            throw e;
+        }
+        finally {
+            span.end();
+        }
+    }
 }
 
 exports.ShortCodesClient = ShortCodesClient;