@azure-tools/communication-short-codes 1.0.0-beta.4 → 1.0.0-beta.5

package/dist/esm/generated/src/operations/shortCodes.js

@@ -0,0 +1,600 @@
+/*
+ * 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.
+ */
+import { tracingClient } from "../tracing.js";
+import * as coreClient from "@azure/core-client";
+import * as Mappers from "../models/mappers.js";
+import * as Parameters from "../models/parameters.js";
+/// <reference lib="esnext.asynciterable" />
+/** Class containing ShortCodes operations. */
+export class ShortCodesImpl {
+    client;
+    /**
+     * Initialize a new instance of the class ShortCodes class.
+     * @param client Reference to the service client
+     */
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Gets the list of short codes for the current resource.
+     * @param options The options parameters.
+     */
+    listShortCodes(options) {
+        const iter = this.getShortCodesPagingAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.getShortCodesPagingPage(options);
+            }
+        };
+    }
+    async *getShortCodesPagingPage(options) {
+        let result = await this._getShortCodes(options);
+        yield result.shortCodes || [];
+        let continuationToken = result.nextLink;
+        while (continuationToken) {
+            result = await this._getShortCodesNext(continuationToken, options);
+            continuationToken = result.nextLink;
+            yield result.shortCodes || [];
+        }
+    }
+    async *getShortCodesPagingAll(options) {
+        for await (const page of this.getShortCodesPagingPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * This method supports pagination via the "skip" and "top" query parameters.
+     * @param options The options parameters.
+     */
+    listCosts(options) {
+        const iter = this.getCostsPagingAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.getCostsPagingPage(options);
+            }
+        };
+    }
+    async *getCostsPagingPage(options) {
+        let result = await this._getCosts(options);
+        yield result.costs || [];
+        let continuationToken = result.nextLink;
+        while (continuationToken) {
+            result = await this._getCostsNext(continuationToken, options);
+            continuationToken = result.nextLink;
+            yield result.costs || [];
+        }
+    }
+    async *getCostsPagingAll(options) {
+        for await (const page of this.getCostsPagingPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Gets the list of US Program Briefs for the current resource.
+     * @param options The options parameters.
+     */
+    listUSProgramBriefs(options) {
+        const iter = this.getUSProgramBriefsPagingAll(options);
+        return {
+            next() {
+                return iter.next();
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            byPage: () => {
+                return this.getUSProgramBriefsPagingPage(options);
+            }
+        };
+    }
+    async *getUSProgramBriefsPagingPage(options) {
+        let result = await this._getUSProgramBriefs(options);
+        yield result.programBriefs || [];
+        let continuationToken = result.nextLink;
+        while (continuationToken) {
+            result = await this._getUSProgramBriefsNext(continuationToken, options);
+            continuationToken = result.nextLink;
+            yield result.programBriefs || [];
+        }
+    }
+    async *getUSProgramBriefsPagingAll(options) {
+        for await (const page of this.getUSProgramBriefsPagingPage(options)) {
+            yield* page;
+        }
+    }
+    /**
+     * 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);
+            }
+        };
+    }
+    async *getUSProgramBriefAttachmentsPagingPage(programBriefId, options) {
+        let result = await this._getUSProgramBriefAttachments(programBriefId, options);
+        yield result.attachments || [];
+        let continuationToken = result.nextLink;
+        while (continuationToken) {
+            result = await this._getUSProgramBriefAttachmentsNext(programBriefId, continuationToken, options);
+            continuationToken = result.nextLink;
+            yield result.attachments || [];
+        }
+    }
+    async *getUSProgramBriefAttachmentsPagingAll(programBriefId, options) {
+        for await (const page of this.getUSProgramBriefAttachmentsPagingPage(programBriefId, options)) {
+            yield* page;
+        }
+    }
+    /**
+     * Gets the list of short codes for the current resource.
+     * @param options The options parameters.
+     */
+    async _getShortCodes(options) {
+        return tracingClient.withSpan("ShortCodesClient._getShortCodes", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ options }, getShortCodesOperationSpec);
+        });
+    }
+    /**
+     * This method supports pagination via the "skip" and "top" query parameters.
+     * @param options The options parameters.
+     */
+    async _getCosts(options) {
+        return tracingClient.withSpan("ShortCodesClient._getCosts", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ options }, getCostsOperationSpec);
+        });
+    }
+    /**
+     * Creates or updates a US Program Brief.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    async upsertUSProgramBrief(programBriefId, options) {
+        return tracingClient.withSpan("ShortCodesClient.upsertUSProgramBrief", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ programBriefId, options }, upsertUSProgramBriefOperationSpec);
+        });
+    }
+    /**
+     * Deletes a US Program Brief.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    async deleteUSProgramBrief(programBriefId, options) {
+        return tracingClient.withSpan("ShortCodesClient.deleteUSProgramBrief", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ programBriefId, options }, deleteUSProgramBriefOperationSpec);
+        });
+    }
+    /**
+     * Get a US Program Brief by id.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    async getUSProgramBrief(programBriefId, options) {
+        return tracingClient.withSpan("ShortCodesClient.getUSProgramBrief", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ programBriefId, options }, getUSProgramBriefOperationSpec);
+        });
+    }
+    /**
+     * Submits a US Program Brief for review.
+     * @param programBriefId Program Brief Id. Must be a valid GUID
+     * @param options The options parameters.
+     */
+    async submitUSProgramBrief(programBriefId, options) {
+        return tracingClient.withSpan("ShortCodesClient.submitUSProgramBrief", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ programBriefId, options }, submitUSProgramBriefOperationSpec);
+        });
+    }
+    /**
+     * Gets the list of US Program Briefs for the current resource.
+     * @param options The options parameters.
+     */
+    async _getUSProgramBriefs(options) {
+        return tracingClient.withSpan("ShortCodesClient._getUSProgramBriefs", options ?? {}, async (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.
+     */
+    async createOrReplaceUSProgramBriefAttachment(programBriefId, attachmentId, id, fileName, fileType, fileContentBase64, type, options) {
+        return tracingClient.withSpan("ShortCodesClient.createOrReplaceUSProgramBriefAttachment", options ?? {}, async (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.
+     */
+    async getUSProgramBriefAttachment(programBriefId, attachmentId, options) {
+        return tracingClient.withSpan("ShortCodesClient.getUSProgramBriefAttachment", options ?? {}, async (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.
+     */
+    async deleteUSProgramBriefAttachment(programBriefId, attachmentId, options) {
+        return tracingClient.withSpan("ShortCodesClient.deleteUSProgramBriefAttachment", options ?? {}, async (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.
+     */
+    async _getUSProgramBriefAttachments(programBriefId, options) {
+        return tracingClient.withSpan("ShortCodesClient._getUSProgramBriefAttachments", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ programBriefId, options }, getUSProgramBriefAttachmentsOperationSpec);
+        });
+    }
+    /**
+     * GetShortCodesNext
+     * @param nextLink The nextLink from the previous successful call to the GetShortCodes method.
+     * @param options The options parameters.
+     */
+    async _getShortCodesNext(nextLink, options) {
+        return tracingClient.withSpan("ShortCodesClient._getShortCodesNext", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ nextLink, options }, getShortCodesNextOperationSpec);
+        });
+    }
+    /**
+     * GetCostsNext
+     * @param nextLink The nextLink from the previous successful call to the GetCosts method.
+     * @param options The options parameters.
+     */
+    async _getCostsNext(nextLink, options) {
+        return tracingClient.withSpan("ShortCodesClient._getCostsNext", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ nextLink, options }, getCostsNextOperationSpec);
+        });
+    }
+    /**
+     * GetUSProgramBriefsNext
+     * @param nextLink The nextLink from the previous successful call to the GetUSProgramBriefs method.
+     * @param options The options parameters.
+     */
+    async _getUSProgramBriefsNext(nextLink, options) {
+        return tracingClient.withSpan("ShortCodesClient._getUSProgramBriefsNext", options ?? {}, async (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.
+     */
+    async _getUSProgramBriefAttachmentsNext(programBriefId, nextLink, options) {
+        return tracingClient.withSpan("ShortCodesClient._getUSProgramBriefAttachmentsNext", options ?? {}, async (options) => {
+            return this.client.sendOperationRequest({ programBriefId, nextLink, options }, getUSProgramBriefAttachmentsNextOperationSpec);
+        });
+    }
+}
+// Operation Specifications
+const serializer = coreClient.createSerializer(Mappers, /* isXml */ false);
+const getShortCodesOperationSpec = {
+    path: "/shortCodes",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.AcquiredShortCodes
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getCostsOperationSpec = {
+    path: "/shortCodes/costs",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ShortCodeCosts
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const upsertUSProgramBriefOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}",
+    httpMethod: "PATCH",
+    responses: {
+        200: {
+            bodyMapper: Mappers.USProgramBrief
+        },
+        201: {
+            bodyMapper: Mappers.USProgramBrief
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    requestBody: Parameters.body,
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.programBriefId],
+    headerParameters: [Parameters.accept, Parameters.contentType],
+    mediaType: "json",
+    serializer
+};
+const deleteUSProgramBriefOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}",
+    httpMethod: "DELETE",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.programBriefId],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getUSProgramBriefOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.USProgramBrief
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.programBriefId],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const submitUSProgramBriefOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/:submit",
+    httpMethod: "POST",
+    responses: {
+        200: {
+            bodyMapper: Mappers.USProgramBrief
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.programBriefId],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getUSProgramBriefsOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.USProgramBriefs
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const createOrReplaceUSProgramBriefAttachmentOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments/{attachmentId}",
+    httpMethod: "PUT",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ProgramBriefAttachment
+        },
+        201: {
+            bodyMapper: Mappers.ProgramBriefAttachment
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    requestBody: {
+        parameterPath: {
+            id: ["id"],
+            type: ["type"],
+            fileName: ["fileName"],
+            fileSizeInBytes: ["options", "fileSizeInBytes"],
+            fileType: ["fileType"],
+            fileContentBase64: ["fileContentBase64"]
+        },
+        mapper: { ...Mappers.ProgramBriefAttachment, required: true }
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.endpoint,
+        Parameters.programBriefId,
+        Parameters.attachmentId
+    ],
+    headerParameters: [Parameters.accept, Parameters.contentType1],
+    mediaType: "json",
+    serializer
+};
+const getUSProgramBriefAttachmentOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments/{attachmentId}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ProgramBriefAttachment
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.endpoint,
+        Parameters.programBriefId,
+        Parameters.attachmentId
+    ],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const deleteUSProgramBriefAttachmentOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments/{attachmentId}",
+    httpMethod: "DELETE",
+    responses: {
+        204: {},
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.apiVersion],
+    urlParameters: [
+        Parameters.endpoint,
+        Parameters.programBriefId,
+        Parameters.attachmentId
+    ],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getUSProgramBriefAttachmentsOperationSpec = {
+    path: "/shortCodes/countries/US/programBriefs/{programBriefId}/attachments",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ProgramBriefAttachments
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.programBriefId],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getShortCodesNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.AcquiredShortCodes
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.nextLink],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getCostsNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ShortCodeCosts
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.nextLink],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getUSProgramBriefsNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.USProgramBriefs
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [Parameters.endpoint, Parameters.nextLink],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+const getUSProgramBriefAttachmentsNextOperationSpec = {
+    path: "{nextLink}",
+    httpMethod: "GET",
+    responses: {
+        200: {
+            bodyMapper: Mappers.ProgramBriefAttachments
+        },
+        default: {
+            bodyMapper: Mappers.CommunicationErrorResponse
+        }
+    },
+    queryParameters: [Parameters.skip, Parameters.top, Parameters.apiVersion],
+    urlParameters: [
+        Parameters.endpoint,
+        Parameters.programBriefId,
+        Parameters.nextLink
+    ],
+    headerParameters: [Parameters.accept],
+    serializer
+};
+//# sourceMappingURL=shortCodes.js.map