diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/DeleteUSProgramBriefAsync.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/DeleteUSProgramBriefAsync.json deleted file mode 100644 index 487d72fe614e..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/DeleteUSProgramBriefAsync.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2021-10-25-preview", - "programBriefId": "146b433f-d774-40b9-9138-55d386208725", - "endpoint": "https://resourcename.region.dev.communications.azure.net/" - }, - "responses": { - "204": { - "headers": {} - } - } -} diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetShortCodesAsync.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetShortCodesAsync.json deleted file mode 100644 index 8a5ccbde53fc..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetShortCodesAsync.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "api-version": "2021-10-25-preview", - "endpoint": "https://resourcename.region.dev.communications.azure.net/" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "shortCodes": [ - { - "number": "123456", - "numberType": "shortCode", - "countryCode": "US", - "programBriefIds": [ - "146b433f-d774-40b9-9138-55d386208725" - ], - "purchaseDate": "2021-07-14T13:00:00+00:00" - } - ], - "nextLink": "" - } - } - } -} diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetUSProgramBriefAsync.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetUSProgramBriefAsync.json deleted file mode 100644 index ae5aef7e39ad..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetUSProgramBriefAsync.json +++ /dev/null @@ -1,117 +0,0 @@ -{ - "parameters": { - "api-version": "2021-10-25-preview", - "programBriefId": "146b433f-d774-40b9-9138-55d386208725", - "endpoint": "https://resourcename.region.dev.communications.azure.net/" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "146b433f-d774-40b9-9138-55d386208725", - "status": "approved", - "number": "123456", - "reviewNotes": [ - { - "message": "Program Brief is approved.", - "date": "2021-07-11T21:36:24.8898166+00:00" - } - ], - "costs": [ - { - "amount": 1500.0, - "currencyCode": "USD", - "billingFrequency": "monthly" - }, - { - "amount": 650.0, - "currencyCode": "USD", - "billingFrequency": "once" - } - ], - "submissionDate": "2021-07-11T21:36:24.8898166+00:00", - "statusUpdatedDate": "2021-08-10T21:36:24.8898162+00:00", - "programDetails": { - "isVanity": true, - "preferredVanityNumbers": [ - "123456" - ], - "numberType": "shortCode", - "isPoliticalCampaign": false, - "name": "CONTOSO Shipping", - "description": "CONTOSO Shipping program that will send shipping notification messages", - "url": "https://www.contoso.com/shipping", - "signUpTypes": [ - "sms", - "website" - ], - "signUpUrl": "https://www.contoso.com/shipping/callToAction.png", - "termsOfServiceUrl": "https://www.contoso.com/shipping/termsofservice", - "privacyPolicyUrl": "https://www.contoso.com/shipping/privacypolicy", - "expectedDateOfService": "2021-10-25T00:00:00+00:00" - }, - "companyInformation": { - "name": "CONTOSO", - "url": "https://www.contoso.com", - "address": "CONTOSO Address", - "contactInformation": { - "name": "John Doe", - "phone": "+1123456789", - "email": "john.doe@contoso.com" - }, - "customerCareInformation": { - "tollFreeNumber": "+1987654321", - "email": "customercare@contoso.com" - } - }, - "messageDetails": { - "supportedProtocols": [ - "sms" - ], - "recurrence": "transaction", - "helpMessage": "This is the HELP message test.", - "optOutMessage": "This is the STOP message test.", - "optInMessage": "CONTOSO Shipping - To confirm your subscription with us, please reply 'Y', and you will be added to our list.", - "optInReply": "JOIN", - "confirmationMessage": "CONTOSO Shipping - Welcome message to CONTOSO Shipping. Messaging & data rates may apply.For help, reply \"HELP\" or call/email customercare@contoso.comTo unsubscribe, reply \"STOP\". Visit our terms and conditions at https://www.contoso.com/shipping/termsofservice.", - "directionality": "twoWay", - "useCases": [ - { - "contentCategory": "loyaltyProgramPointsPrizes", - "examples": [ - { - "messages": [ - { - "direction": "toUser", - "text": "Your password is 123 STOP/HELP" - } - ] - }, - { - "messages": [ - { - "direction": "toUser", - "text": "Want me to notify you when package in the way?" - }, - { - "direction": "fromUser", - "text": "Y" - } - ] - } - ] - } - ] - }, - "trafficDetails": { - "totalMonthlyVolume": 10, - "monthlyAverageMessagesFromUser": 2, - "monthlyAverageMessagesToUser": 1, - "isSpiky": false, - "spikeDetails": "Higher traffic expected during holiday season and Black Friday.", - "estimatedRampUpTimeInDays": 10 - } - } - } - } -} diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetUSProgramBriefsAsync.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetUSProgramBriefsAsync.json deleted file mode 100644 index 1c601aa1ba6d..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/GetUSProgramBriefsAsync.json +++ /dev/null @@ -1,121 +0,0 @@ -{ - "parameters": { - "api-version": "2021-10-25-preview", - "endpoint": "https://resourcename.region.dev.communications.azure.net/" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "programBriefs": [ - { - "id": "146b433f-d774-40b9-9138-55d386208725", - "status": "approved", - "number": "123456", - "reviewNotes": [ - { - "message": "Program Brief is approved.", - "date": "2021-07-11T21:36:24.8898166+00:00" - } - ], - "costs": [ - { - "amount": 1500.0, - "currencyCode": "USD", - "billingFrequency": "monthly" - }, - { - "amount": 650.0, - "currencyCode": "USD", - "billingFrequency": "once" - } - ], - "submissionDate": "2021-07-11T21:36:24.8898166+00:00", - "statusUpdatedDate": "2021-08-10T21:36:24.8898162+00:00", - "programDetails": { - "isVanity": true, - "preferredVanityNumbers": [ - "123456" - ], - "numberType": "shortCode", - "isPoliticalCampaign": false, - "name": "CONTOSO Shipping", - "description": "CONTOSO Shipping program that will send shipping notification messages", - "url": "https://www.contoso.com/shipping", - "signUpTypes": [ - "sms", - "website" - ], - "signUpUrl": "https://www.contoso.com/shipping/callToAction.png", - "termsOfServiceUrl": "https://www.contoso.com/shipping/termsofservice", - "privacyPolicyUrl": "https://www.contoso.com/shipping/privacypolicy", - "expectedDateOfService": "2021-10-25T00:00:00+00:00" - }, - "companyInformation": { - "name": "CONTOSO", - "url": "https://www.contoso.com", - "address": "CONTOSO Address", - "contactInformation": { - "name": "John Doe", - "phone": "+1123456789", - "email": "john.doe@contoso.com" - }, - "customerCareInformation": { - "tollFreeNumber": "+1987654321", - "email": "customercare@contoso.com" - } - }, - "messageDetails": { - "supportedProtocols": [ - "sms" - ], - "recurrence": "transaction", - "helpMessage": "This is the HELP message test.", - "optOutMessage": "This is the STOP message test.", - "optInMessage": "CONTOSO Shipping - To confirm your subscription with us, please reply 'Y', and you will be added to our list.", - "optInReply": "JOIN", - "confirmationMessage": "CONTOSO Shipping - Welcome message to CONTOSO Shipping. Messaging & data rates may apply.For help, reply \"HELP\" or call/email customercare@contoso.comTo unsubscribe, reply \"STOP\". Visit our terms and conditions at https://www.contoso.com/shipping/termsofservice.", - "directionality": "twoWay", - "useCases": [ - { - "contentCategory": "loyaltyProgramPointsPrizes", - "examples": [ - { - "messages": [ - { - "direction": "toUser", - "text": "Your password is 123 STOP/HELP" - } - ] - }, - { - "messages": [ - { - "direction": "toUser", - "text": "Want me to notify you when package in the way?" - }, - { - "direction": "fromUser", - "text": "Y" - } - ] - } - ] - } - ] - }, - "trafficDetails": { - "totalMonthlyVolume": 10, - "monthlyAverageMessagesFromUser": 2, - "monthlyAverageMessagesToUser": 1, - "isSpiky": false, - "spikeDetails": "Higher traffic expected during holiday season and Black Friday.", - "estimatedRampUpTimeInDays": 10 - } - } - ], - "nextLink": "" - } - } - } -} diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/SubmitUSProgramBriefAsync.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/SubmitUSProgramBriefAsync.json deleted file mode 100644 index dd19f85aee92..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/SubmitUSProgramBriefAsync.json +++ /dev/null @@ -1,109 +0,0 @@ -{ - "parameters": { - "api-version": "2021-10-25-preview", - "programBriefId": "146b433f-d774-40b9-9138-55d386208725", - "endpoint": "https://resourcename.region.dev.communications.azure.net/" - }, - "responses": { - "200": { - "body": { - "id": "146b433f-d774-40b9-9138-55d386208725", - "status": "submitted", - "costs": [ - { - "amount": 1500.0, - "currencyCode": "USD", - "billingFrequency": "monthly" - }, - { - "amount": 650.0, - "currencyCode": "USD", - "billingFrequency": "once" - } - ], - "submissionDate": "2021-07-11T21:36:24.8898166+00:00", - "statusUpdatedDate": "2021-08-10T21:36:24.8898162+00:00", - "programDetails": { - "isVanity": true, - "preferredVanityNumbers": [ - "123456" - ], - "numberType": "shortCode", - "isPoliticalCampaign": false, - "name": "CONTOSO Shipping", - "description": "CONTOSO Shipping program that will send shipping notification messages", - "url": "https://www.contoso.com/shipping", - "signUpTypes": [ - "sms", - "website" - ], - "signUpUrl": "https://www.contoso.com/shipping/callToAction.png", - "termsOfServiceUrl": "https://www.contoso.com/shipping/termsofservice", - "privacyPolicyUrl": "https://www.contoso.com/shipping/privacypolicy", - "expectedDateOfService": "2021-10-25T00:00:00+00:00" - }, - "companyInformation": { - "name": "CONTOSO", - "url": "https://www.contoso.com", - "address": "CONTOSO Address", - "contactInformation": { - "name": "John Doe", - "phone": "+1123456789", - "email": "john.doe@contoso.com" - }, - "customerCareInformation": { - "tollFreeNumber": "+1987654321", - "email": "customercare@contoso.com" - } - }, - "messageDetails": { - "supportedProtocols": [ - "sms" - ], - "recurrence": "transaction", - "helpMessage": "This is the HELP message test.", - "optOutMessage": "This is the STOP message test.", - "optInMessage": "CONTOSO Shipping - To confirm your subscription with us, please reply 'Y', and you will be added to our list.", - "optInReply": "JOIN", - "confirmationMessage": "CONTOSO Shipping - Welcome message to CONTOSO Shipping. Messaging & data rates may apply.For help, reply \"HELP\" or call/email customercare@contoso.comTo unsubscribe, reply \"STOP\". Visit our terms and conditions at https://www.contoso.com/shipping/termsofservice.", - "directionality": "twoWay", - "useCases": [ - { - "contentCategory": "loyaltyProgramPointsPrizes", - "examples": [ - { - "messages": [ - { - "direction": "toUser", - "text": "Your password is 123 STOP/HELP" - } - ] - }, - { - "messages": [ - { - "direction": "toUser", - "text": "Want me to notify you when package in the way?" - }, - { - "direction": "fromUser", - "text": "Y" - } - ] - } - ] - } - ] - }, - "trafficDetails": { - "totalMonthlyVolume": 10, - "monthlyAverageMessagesFromUser": 2, - "monthlyAverageMessagesToUser": 1, - "isSpiky": false, - "spikeDetails": "Higher traffic expected during holiday season and Black Friday.", - "estimatedRampUpTimeInDays": 10 - } - } - } - } -} diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/UpsertUSProgramBriefAsync.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/UpsertUSProgramBriefAsync.json deleted file mode 100644 index 93ba12d2ef4a..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/examples/UpsertUSProgramBriefAsync.json +++ /dev/null @@ -1,294 +0,0 @@ -{ - "parameters": { - "api-version": "2021-10-25-preview", - "programBriefId": "146b433f-d774-40b9-9138-55d386208725", - "body": { - "id": "146b433f-d774-40b9-9138-55d386208725", - "programDetails": { - "isVanity": true, - "preferredVanityNumbers": [ - "123456" - ], - "numberType": "shortCode", - "isPoliticalCampaign": false, - "name": "CONTOSO Shipping", - "description": "CONTOSO Shipping program that will send shipping notification messages", - "url": "https://www.contoso.com/shipping", - "signUpTypes": [ - "sms", - "website" - ], - "signUpUrl": "https://www.contoso.com/shipping/callToAction.png", - "termsOfServiceUrl": "https://www.contoso.com/shipping/termsofservice", - "privacyPolicyUrl": "https://www.contoso.com/shipping/privacypolicy", - "expectedDateOfService": "2021-10-25T00:00:00+00:00" - }, - "companyInformation": { - "name": "CONTOSO", - "url": "https://www.contoso.com", - "address": "CONTOSO Address", - "contactInformation": { - "name": "John Doe", - "phone": "+1123456789", - "email": "john.doe@contoso.com" - }, - "customerCareInformation": { - "tollFreeNumber": "+1987654321", - "email": "customercare@contoso.com" - } - }, - "messageDetails": { - "supportedProtocols": [ - "sms" - ], - "recurrence": "transaction", - "helpMessage": "This is the HELP message test.", - "optOutMessage": "This is the STOP message test.", - "optInMessage": "CONTOSO Shipping - To confirm your subscription with us, please reply 'Y', and you will be added to our list.", - "optInReply": "JOIN", - "confirmationMessage": "CONTOSO Shipping - Welcome message to CONTOSO Shipping. Messaging & data rates may apply.For help, reply \"HELP\" or call/email customercare@contoso.comTo unsubscribe, reply \"STOP\". Visit our terms and conditions at https://www.contoso.com/shipping/termsofservice.", - "directionality": "twoWay", - "useCases": [ - { - "contentCategory": "loyaltyProgramPointsPrizes", - "examples": [ - { - "messages": [ - { - "direction": "toUser", - "text": "Your password is 123 STOP/HELP" - } - ] - }, - { - "messages": [ - { - "direction": "toUser", - "text": "Want me to notify you when package in the way?" - }, - { - "direction": "fromUser", - "text": "Y" - } - ] - } - ] - } - ] - }, - "trafficDetails": { - "totalMonthlyVolume": 10, - "monthlyAverageMessagesFromUser": 2, - "monthlyAverageMessagesToUser": 1, - "isSpiky": false, - "spikeDetails": "Higher traffic expected during holiday season and Black Friday.", - "estimatedRampUpTimeInDays": 10 - } - }, - "endpoint": "https://resourcename.region.dev.communications.azure.net/" - }, - "responses": { - "201": { - "headers": {}, - "body": { - "id": "146b433f-d774-40b9-9138-55d386208725", - "status": "draft", - "costs": [ - { - "amount": 1500.0, - "currencyCode": "USD", - "billingFrequency": "monthly" - }, - { - "amount": 650.0, - "currencyCode": "USD", - "billingFrequency": "once" - } - ], - "submissionDate": "2021-07-11T21:36:24.8898166+00:00", - "statusUpdatedDate": "2021-07-11T21:36:24.8898166+00:00", - "programDetails": { - "isVanity": true, - "preferredVanityNumbers": [ - "123456" - ], - "numberType": "shortCode", - "isPoliticalCampaign": false, - "name": "CONTOSO Shipping", - "description": "CONTOSO Shipping program that will send shipping notification messages", - "url": "https://www.contoso.com/shipping", - "signUpTypes": [ - "sms", - "website" - ], - "signUpUrl": "https://www.contoso.com/shipping/callToAction.png", - "termsOfServiceUrl": "https://www.contoso.com/shipping/termsofservice", - "privacyPolicyUrl": "https://www.contoso.com/shipping/privacypolicy", - "expectedDateOfService": "2021-10-25T00:00:00+00:00" - }, - "companyInformation": { - "name": "CONTOSO", - "url": "https://www.contoso.com", - "address": "CONTOSO Address", - "contactInformation": { - "name": "John Doe", - "phone": "+1123456789", - "email": "john.doe@contoso.com" - }, - "customerCareInformation": { - "tollFreeNumber": "+1987654321", - "email": "customercare@contoso.com" - } - }, - "messageDetails": { - "supportedProtocols": [ - "sms" - ], - "recurrence": "transaction", - "helpMessage": "This is the HELP message test.", - "optOutMessage": "This is the STOP message test.", - "optInMessage": "CONTOSO Shipping - To confirm your subscription with us, please reply 'Y', and you will be added to our list.", - "optInReply": "JOIN", - "confirmationMessage": "CONTOSO Shipping - Welcome message to CONTOSO Shipping. Messaging & data rates may apply.For help, reply \"HELP\" or call/email customercare@contoso.comTo unsubscribe, reply \"STOP\". Visit our terms and conditions at https://www.contoso.com/shipping/termsofservice.", - "directionality": "twoWay", - "useCases": [ - { - "contentCategory": "loyaltyProgramPointsPrizes", - "examples": [ - { - "messages": [ - { - "direction": "toUser", - "text": "Your password is 123 STOP/HELP" - } - ] - }, - { - "messages": [ - { - "direction": "toUser", - "text": "Want me to notify you when package in the way?" - }, - { - "direction": "fromUser", - "text": "Y" - } - ] - } - ] - } - ] - }, - "trafficDetails": { - "totalMonthlyVolume": 10, - "monthlyAverageMessagesFromUser": 2, - "monthlyAverageMessagesToUser": 1, - "isSpiky": false, - "spikeDetails": "Higher traffic expected during holiday season and Black Friday.", - "estimatedRampUpTimeInDays": 10 - } - } - }, - "200": { - "headers": {}, - "body": { - "id": "146b433f-d774-40b9-9138-55d386208725", - "status": "draft", - "costs": [ - { - "amount": 1500.0, - "currencyCode": "USD", - "billingFrequency": "monthly" - }, - { - "amount": 650.0, - "currencyCode": "USD", - "billingFrequency": "once" - } - ], - "submissionDate": "2021-07-11T21:36:24.8898166+00:00", - "statusUpdatedDate": "2021-08-10T21:36:24.8898162+00:00", - "programDetails": { - "isVanity": true, - "preferredVanityNumbers": [ - "123456" - ], - "numberType": "shortCode", - "isPoliticalCampaign": false, - "name": "CONTOSO Shipping", - "description": "CONTOSO Shipping program that will send shipping notification messages", - "url": "https://www.contoso.com/shipping", - "signUpTypes": [ - "sms", - "website" - ], - "signUpUrl": "https://www.contoso.com/shipping/callToAction.png", - "termsOfServiceUrl": "https://www.contoso.com/shipping/termsofservice", - "privacyPolicyUrl": "https://www.contoso.com/shipping/privacypolicy", - "expectedDateOfService": "2021-10-25T00:00:00+00:00" - }, - "companyInformation": { - "name": "CONTOSO", - "url": "https://www.contoso.com", - "address": "CONTOSO Address", - "contactInformation": { - "name": "John Doe", - "phone": "+1123456789", - "email": "john.doe@contoso.com" - }, - "customerCareInformation": { - "tollFreeNumber": "+1987654321", - "email": "customercare@contoso.com" - } - }, - "messageDetails": { - "supportedProtocols": [ - "sms" - ], - "recurrence": "transaction", - "helpMessage": "This is the HELP message test.", - "optOutMessage": "This is the STOP message test.", - "optInMessage": "CONTOSO Shipping - To confirm your subscription with us, please reply 'Y', and you will be added to our list.", - "optInReply": "JOIN", - "confirmationMessage": "CONTOSO Shipping - Welcome message to CONTOSO Shipping. Messaging & data rates may apply.For help, reply \"HELP\" or call/email customercare@contoso.comTo unsubscribe, reply \"STOP\". Visit our terms and conditions at https://www.contoso.com/shipping/termsofservice.", - "directionality": "twoWay", - "useCases": [ - { - "contentCategory": "loyaltyProgramPointsPrizes", - "examples": [ - { - "messages": [ - { - "direction": "toUser", - "text": "Your password is 123 STOP/HELP" - } - ] - }, - { - "messages": [ - { - "direction": "toUser", - "text": "Want me to notify you when package in the way?" - }, - { - "direction": "fromUser", - "text": "Y" - } - ] - } - ] - } - ] - }, - "trafficDetails": { - "totalMonthlyVolume": 10, - "monthlyAverageMessagesFromUser": 2, - "monthlyAverageMessagesToUser": 1, - "isSpiky": false, - "spikeDetails": "Higher traffic expected during holiday season and Black Friday.", - "estimatedRampUpTimeInDays": 10 - } - } - } - } -} diff --git a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/shortcodes.json b/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/shortcodes.json deleted file mode 100644 index b738efc44a8c..000000000000 --- a/specification/communication/data-plane/ShortCodes/preview/2021-10-25-preview/shortcodes.json +++ /dev/null @@ -1,888 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "ShortCodesNumbersClient", - "description": "The short codes client uses Azure Communication Services to purchase and manage short codes.", - "version": "2021-10-25-preview" - }, - "paths": { - "/shortCodes": { - "get": { - "tags": [ - "ShortCodes" - ], - "summary": "Gets the list of short codes for the current resource.", - "operationId": "ShortCodes_GetShortCodes", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "top", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/ShortCodes" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "shortCodes" - }, - "x-ms-examples": { - "List short codes": { - "$ref": "./examples/GetShortCodesAsync.json" - } - } - } - }, - "/shortCodes/countries/US/programBriefs/{programBriefId}": { - "patch": { - "tags": [ - "ShortCodes - ProgramBrief" - ], - "summary": "Creates or updates a US Program Brief.", - "operationId": "ShortCodes_UpsertUSProgramBrief", - "consumes": [ - "application/merge-patch+json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "programBriefId", - "description": "Program Brief Id. Must be a valid GUID", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "in": "body", - "name": "body", - "description": "Data to create new a Program Brief or fields to update an existing Program Brief", - "schema": { - "$ref": "#/definitions/USProgramBrief" - } - } - ], - "responses": { - "201": { - "description": "Success", - "schema": { - "$ref": "#/definitions/USProgramBrief" - } - }, - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/USProgramBrief" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "Creates or Updates a US Program Brief": { - "$ref": "./examples/UpsertUSProgramBriefAsync.json" - } - } - }, - "delete": { - "tags": [ - "ShortCodes - ProgramBrief" - ], - "summary": "Deletes a US Program Brief.", - "operationId": "ShortCodes_DeleteUSProgramBrief", - "parameters": [ - { - "in": "path", - "name": "programBriefId", - "description": "Program Brief Id. Must be a valid GUID", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "204": { - "description": "Success" - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "Deletes a US Program Brief": { - "$ref": "./examples/DeleteUSProgramBriefAsync.json" - } - }, - "produces": [ - "application/json" - ] - }, - "get": { - "tags": [ - "ShortCodes - ProgramBrief" - ], - "summary": "Get a US Program Brief by id.", - "operationId": "ShortCodes_GetUSProgramBrief", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "programBriefId", - "description": "Program Brief Id. Must be a valid GUID", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/USProgramBrief" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "Query a US Program Brief": { - "$ref": "./examples/GetUSProgramBriefAsync.json" - } - } - } - }, - "/shortCodes/countries/US/programBriefs/{programBriefId}/:submit": { - "post": { - "tags": [ - "ShortCodes - ProgramBrief" - ], - "summary": "Submits a US Program Brief for review.", - "operationId": "ShortCodes_SubmitUSProgramBrief", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "path", - "name": "programBriefId", - "description": "Program Brief Id. Must be a valid GUID", - "required": true, - "type": "string", - "format": "uuid" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/USProgramBrief" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-examples": { - "Submit a US Program Brief": { - "$ref": "./examples/SubmitUSProgramBriefAsync.json" - } - } - } - }, - "/shortCodes/countries/US/programBriefs": { - "get": { - "tags": [ - "ShortCodes - ProgramBrief" - ], - "summary": "Gets the list of US Program Briefs for the current resource.", - "operationId": "ShortCodes_GetUSProgramBriefs", - "produces": [ - "application/json" - ], - "parameters": [ - { - "in": "query", - "name": "skip", - "description": "An optional parameter for how many entries to skip, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "in": "query", - "name": "top", - "description": "An optional parameter for how many entries to return, for pagination purposes.", - "type": "integer", - "format": "int32", - "default": 100 - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/USProgramBriefs" - } - }, - "default": { - "description": "Failure", - "schema": { - "$ref": "../../../Common/stable/2021-03-07/common.json#/definitions/CommunicationErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink", - "itemName": "programBriefs" - }, - "x-ms-examples": { - "List US Program Briefs": { - "$ref": "./examples/GetUSProgramBriefsAsync.json" - } - } - } - } - }, - "definitions": { - "ShortCode": { - "description": "Represents a number, ShortCode or AlphaId, acquired in a given country.", - "type": "object", - "properties": { - "number": { - "description": "The value of the ShortCode or the alpha numeric e.g. '555555', 'CONTOSO', etc.", - "type": "string" - }, - "numberType": { - "description": "The type of number e.g. 'ShortCode', 'AlphaId'.", - "enum": [ - "shortCode", - "alphaId" - ], - "type": "string", - "x-ms-enum": { - "name": "NumberType", - "modelAsString": true - } - }, - "countryCode": { - "description": "ISO 3166 2-char code representing the country e.g. 'US'.", - "type": "string" - }, - "programBriefIds": { - "description": "Program Brief Name.", - "type": "array", - "items": { - "type": "string" - } - }, - "purchaseDate": { - "format": "date-time", - "description": "Date in which number was purchased.", - "type": "string" - } - } - }, - "ShortCodes": { - "description": "A wrapper for a list of short code entities.", - "type": "object", - "properties": { - "shortCodes": { - "description": "List of short codes.", - "type": "array", - "items": { - "$ref": "#/definitions/ShortCode" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page.", - "type": "string" - } - } - }, - "ReviewNote": { - "description": "Holds a note about a Program Brief that has gone thru stages of review process.", - "type": "object", - "properties": { - "message": { - "description": "Note related to a Program Brief that may imply changes needed from the client.", - "type": "string" - }, - "date": { - "format": "date-time", - "description": "Date and time when the note was added to the Program Brief.", - "type": "string" - } - } - }, - "ShortCodeCost": { - "description": "The incurred cost for a single short code.", - "required": [ - "amount", - "billingFrequency", - "currencyCode" - ], - "type": "object", - "properties": { - "amount": { - "format": "double", - "description": "The cost amount.", - "type": "number" - }, - "currencyCode": { - "description": "The ISO 4217 currency code for the cost amount, e.g. USD.", - "type": "string" - }, - "billingFrequency": { - "description": "The frequency with which the cost gets billed.", - "enum": [ - "monthly", - "once" - ], - "type": "string", - "x-ms-enum": { - "name": "BillingFrequency", - "modelAsString": true - } - } - } - }, - "ProgramDetails": { - "type": "object", - "properties": { - "isVanity": { - "description": "Set to true if the request is for a vanity number.", - "type": "boolean" - }, - "preferredVanityNumbers": { - "description": "Priority ordered list of preferred vanity numbers.\r\nVanity numbers should be 5 or 6 digit when number type is ShortCode.\r\ne.g. 555555, 222222.", - "type": "array", - "items": { - "type": "string" - } - }, - "numberType": { - "description": "Type for desired numbers e.g. 'shortCode' or 'alphaId'.", - "enum": [ - "shortCode", - "alphaId" - ], - "type": "string", - "x-ms-enum": { - "name": "NumberType", - "modelAsString": true - } - }, - "isPoliticalCampaign": { - "description": "Indicates whether the number will be used for political campaigns or not.", - "type": "boolean" - }, - "name": { - "description": "A program name that indicates the purpose of filling the Program Brief and how the number will be used for messaging.\r\ne.g. 'CONTOSO Shipping'", - "type": "string" - }, - "description": { - "description": "Describes how and why the number will be used for messaging as part of the program.", - "type": "string" - }, - "url": { - "format": "uri", - "description": "URL for the program or company.", - "type": "string" - }, - "signUpTypes": { - "description": "Indicates how the consumer can sign up to the program e.g. 'website', 'pointOfSale' and/or 'sms'.", - "type": "array", - "items": { - "description": "Indicates how a program will be discoverable by the consumer.", - "enum": [ - "website", - "pointOfSale", - "sms", - "interactiveVoiceResponse" - ], - "type": "string", - "x-ms-enum": { - "name": "ProgramSignUpType", - "modelAsString": true - } - } - }, - "signUpUrl": { - "format": "uri", - "description": "URL for \"call to action\" image for the program.", - "type": "string" - }, - "termsOfServiceUrl": { - "format": "uri", - "description": "URL for program terms of service.", - "type": "string" - }, - "privacyPolicyUrl": { - "format": "uri", - "description": "URL for privacy policy.", - "type": "string" - }, - "expectedDateOfService": { - "format": "date-time", - "description": "Date in which SMS messages will start to be sent out.\r\nShould follow ISO 8601 internet format for datetimes.\r\ne.g. 2021-08-17T22:02:51.316Z, 2021-08-17T16:39:57-08:00, etc.", - "type": "string" - } - } - }, - "ContactInformation": { - "description": "Contact Information", - "type": "object", - "properties": { - "name": { - "description": "Name of authorized user for purposes of submitting the Program Brief.", - "type": "string" - }, - "phone": { - "description": "Contact phone number for the authorized user for the customer. Use E164 format. e.g. +14086111111.", - "type": "string" - }, - "email": { - "format": "email", - "description": "Contact email address number for the authorized user for the customer.", - "type": "string" - } - } - }, - "CustomerCareInformation": { - "description": "Customer Care Information", - "type": "object", - "properties": { - "tollFreeNumber": { - "description": "Customer support phone number for the customer submitting the Program Brief. Use E164 format. e.g. +18005551212", - "type": "string" - }, - "email": { - "format": "email", - "description": "Customer support email address for the customer submitting the Program Brief.", - "type": "string" - } - } - }, - "CompanyInformation": { - "type": "object", - "properties": { - "name": { - "description": "Legal entity name for customer submitting Program Brief.", - "type": "string" - }, - "url": { - "format": "uri", - "description": "Company URL for customer submitting Program Brief.", - "type": "string" - }, - "address": { - "description": "Company's address for the customer submitting the Program Brief.", - "type": "string" - }, - "contactInformation": { - "$ref": "#/definitions/ContactInformation" - }, - "customerCareInformation": { - "$ref": "#/definitions/CustomerCareInformation" - } - } - }, - "MessageExample": { - "description": "Represents a message example to be sent from or to the end user.", - "type": "object", - "properties": { - "direction": { - "description": "Indicates whether the message example is supposed to be sent to or from the end user e.g. toUser", - "enum": [ - "toUser", - "fromUser" - ], - "type": "string", - "x-ms-enum": { - "name": "MessageDirection", - "modelAsString": true - } - }, - "text": { - "description": "Actual example text for the message e.g. 'Want me to notify you when package in the way?'", - "type": "string" - } - } - }, - "MessageExampleSequence": { - "description": "A sequence of example messages to and from the end user.", - "type": "object", - "properties": { - "messages": { - "description": "Example messages to be sent to and from the end user.", - "type": "array", - "items": { - "$ref": "#/definitions/MessageExample" - } - } - } - }, - "UseCase": { - "description": "Describes a messaging use case for a given content type by providing example messages.", - "type": "object", - "properties": { - "contentCategory": { - "description": "Indicates the messaging content category used in the program e.g. 'ringTones', 'smsChat', 'video', 'loyaltyProgramPointsPrizes', 'gifting', 'inApplicationBilling', 'textToScreen'.", - "enum": [ - "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" - ], - "type": "string", - "x-ms-enum": { - "name": "MessageContentCategory", - "modelAsString": true - } - }, - "examples": { - "description": "Example messages to be sent to and from the end user for the indicated content type.", - "type": "array", - "items": { - "$ref": "#/definitions/MessageExampleSequence" - } - } - } - }, - "MessageDetails": { - "type": "object", - "properties": { - "supportedProtocols": { - "description": "Applicable message protocols used in the program e.g. SMS, MMS.", - "type": "array", - "items": { - "description": "Applicable message protocols to be used in a program.", - "enum": [ - "sms", - "mms" - ], - "type": "string", - "x-ms-enum": { - "name": "MessageProtocol", - "modelAsString": true - } - } - }, - "recurrence": { - "description": "Indicates the nature of the messaging associated with the program e.g. 'subscription', 'transaction'.", - "enum": [ - "subscription", - "transaction" - ], - "type": "string", - "x-ms-enum": { - "name": "Recurrence", - "modelAsString": true - } - }, - "helpMessage": { - "description": "Message text for mobile terminated message associated with HELP keyword\r\ne.g 'This is the HELP message test.'.", - "type": "string" - }, - "optOutMessage": { - "description": "\"Message text for mobile terminated message associated with STOP keyword\r\ne.g. 'This is the STOP message test.'.", - "type": "string" - }, - "optInMessage": { - "type": "string" - }, - "optInReply": { - "description": "Keyword used to confirm double Opt-In method e.g. 'JOIN'.", - "type": "string" - }, - "confirmationMessage": { - "type": "string" - }, - "directionality": { - "description": "Describes directionality e.g. oneWay or twoWay", - "enum": [ - "oneWay", - "twoWay" - ], - "type": "string", - "x-ms-enum": { - "name": "MessageDirectionality", - "modelAsString": true - } - }, - "useCases": { - "description": "Provides message exchange examples from and to end user for each supported message content type.", - "type": "array", - "items": { - "$ref": "#/definitions/UseCase" - } - } - } - }, - "TrafficDetails": { - "type": "object", - "properties": { - "totalMonthlyVolume": { - "format": "int32", - "description": "Estimated total messages per month.", - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "monthlyAverageMessagesFromUser": { - "format": "int32", - "description": "Estimated number of Mobile-Originated messages likely to be received from a user per month.", - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "monthlyAverageMessagesToUser": { - "format": "int32", - "description": "Estimated number of Mobile-Terminated messages likely to be sent per user per month.", - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - }, - "isSpiky": { - "description": "Indicates if the nature of the messaging traffic will be bursty.", - "type": "boolean" - }, - "spikeDetails": { - "description": "If isSpiky=true, then explain additional details about the traffic pattern\r\ne.g. 'Higher traffic expected during holiday season and Black Friday.'.", - "type": "string" - }, - "estimatedRampUpTimeInDays": { - "format": "int32", - "description": "Numbers of days in which is expected to start sending messages from the short code.", - "maximum": 2147483647, - "minimum": 0, - "type": "integer" - } - } - }, - "USProgramBrief": { - "description": "Represents a US Program Brief for acquiring a short code in the United States.\r\nA Program Brief provides vital information to the carriers about a messaging program or campaign that would be associated with a short code or alpha sender number.\r\nA Program Brief also provides specifics about the use case, the purpose and the consumer experience receiving the message.", - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "format": "uuid", - "description": "Program Brief Id.", - "type": "string" - }, - "status": { - "description": "Program Brief status e.g. 'submitted', 'approved', etc", - "enum": [ - "submitted", - "approved", - "submitNewVanityNumbers", - "updateProgramBrief", - "draft", - "denied" - ], - "type": "string", - "x-ms-enum": { - "name": "ProgramBriefStatus", - "modelAsString": true - } - }, - "number": { - "description": "Number provisioned for the Program Brief e.g. 555555, 'CONTOSO'", - "type": "string" - }, - "reviewNotes": { - "description": "Notes added to the Program Brief after being reviewed to help customer understand\r\nreview results and necessary follow up actions.", - "type": "array", - "items": { - "$ref": "#/definitions/ReviewNote" - } - }, - "costs": { - "description": "Represents the costs tied to the number.", - "type": "array", - "items": { - "$ref": "#/definitions/ShortCodeCost" - } - }, - "submissionDate": { - "format": "date-time", - "description": "Date and time when the Program Brief was submitted.", - "type": "string" - }, - "statusUpdatedDate": { - "format": "date-time", - "description": "Last date and time when the Program Brief status was updated.", - "type": "string" - }, - "programDetails": { - "$ref": "#/definitions/ProgramDetails" - }, - "companyInformation": { - "$ref": "#/definitions/CompanyInformation" - }, - "messageDetails": { - "$ref": "#/definitions/MessageDetails" - }, - "trafficDetails": { - "$ref": "#/definitions/TrafficDetails" - } - } - }, - "USProgramBriefs": { - "description": "A wrapper for a list of USProgramBrief entities.", - "type": "object", - "properties": { - "programBriefs": { - "description": "List of Program Briefs.", - "type": "array", - "items": { - "$ref": "#/definitions/USProgramBrief" - } - }, - "nextLink": { - "description": "Represents the URL link to the next page.", - "type": "string" - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "in": "query", - "name": "api-version", - "description": "Version of API to invoke", - "required": true, - "type": "string" - }, - "Endpoint": { - "in": "path", - "name": "endpoint", - "description": "The communication resource, for example https://resourcename.communication.azure.com", - "required": true, - "type": "string", - "x-ms-skip-url-encoding": true, - "x-ms-parameter-location": "client" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - }, - "description": "Azure Active Directory OAuth2 Flow" - } - }, - "x-ms-parameterized-host": { - "hostTemplate": "{endpoint}", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - } -} diff --git a/specification/communication/data-plane/ShortCodes/readme.csharp.md b/specification/communication/data-plane/ShortCodes/readme.csharp.md deleted file mode 100644 index 2efd3715cdc3..000000000000 --- a/specification/communication/data-plane/ShortCodes/readme.csharp.md +++ /dev/null @@ -1,15 +0,0 @@ -## C - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 1 - clear-output-folder: true - client-side-validation: false - namespace: Microsoft.CommunicationServices - output-folder: $(csharp-sdks-folder)/communicationservices/management/Microsoft.CommunicationServices/GeneratedProtocol -``` diff --git a/specification/communication/data-plane/ShortCodes/readme.md b/specification/communication/data-plane/ShortCodes/readme.md deleted file mode 100644 index e5b29b1cdcef..000000000000 --- a/specification/communication/data-plane/ShortCodes/readme.md +++ /dev/null @@ -1,69 +0,0 @@ -# communicationservices - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for communicationservices. - -## Getting Started - -To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: - -> `autorest readme.md` - -To see additional help and options, run: - -> `autorest --help` - -For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. - ---- - -## Configuration - -### Basic Information - -These are the global settings for the communicationservices. - -```yaml -openapi-type: data-plane -tag: package-2020-07-20-preview1 -``` - -### Tag: package-shortcode-2021-10-25-preview - -These settings apply only when `--tag=package-shortcode-2021-10-25-preview` is specified on the command line. - -```yaml $(tag) == 'package-shortcode-2021-10-25-preview' -input-file: - - preview/2021-10-25-preview/shortcodes.json -title: - Azure Communication Services -``` - -## Supression -``` yaml -directive: - - from: - - shortcodes.json - suppress: - - R2005 #Long running operation status code - reason: - - Approval from Azure review board that Long Running Operations can return 202s. -``` - ---- - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - -## CSharp - -See configuration in [readme.csharp.md](./readme.csharp.md) diff --git a/specification/communication/data-plane/ShortCodes/readme.typescript.md b/specification/communication/data-plane/ShortCodes/readme.typescript.md deleted file mode 100644 index be9f877fd1c2..000000000000 --- a/specification/communication/data-plane/ShortCodes/readme.typescript.md +++ /dev/null @@ -1,13 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -```yaml $(typescript) -typescript: - azure-arm: true - package-name: "communicationservices" - output-folder: "$(typescript-sdks-folder)/packages/communicationservices" - payload-flattening-threshold: 1 - generate-metadata: true -```