From 8821832698e7795251e2927f7cf39efc97f1c114 Mon Sep 17 00:00:00 2001 From: childish-sambino Date: Tue, 21 Apr 2020 12:58:11 -0500 Subject: [PATCH] fix: properly describe request bodies and add response descriptions (#85) --- src/services/twilio-api/api-browser.js | 34 +- src/services/twilio-api/twilio_accounts.json | 186 +- src/services/twilio-api/twilio_api.json | 13873 +++++++--------- src/services/twilio-api/twilio_authy.json | 358 +- src/services/twilio-api/twilio_autopilot.json | 1142 +- .../twilio-api/twilio_bulkexports.json | 169 +- src/services/twilio-api/twilio_chat.json | 4330 +++-- .../twilio-api/twilio_conversations.json | 895 +- src/services/twilio-api/twilio_fax.json | 196 +- src/services/twilio-api/twilio_flex.json | 922 +- src/services/twilio-api/twilio_insights.json | 16 +- src/services/twilio-api/twilio_lookups.json | 7 +- src/services/twilio-api/twilio_messaging.json | 663 +- src/services/twilio-api/twilio_monitor.json | 21 +- src/services/twilio-api/twilio_notify.json | 1085 +- src/services/twilio-api/twilio_numbers.json | 489 +- src/services/twilio-api/twilio_preview.json | 5021 +++--- src/services/twilio-api/twilio_pricing.json | 31 +- src/services/twilio-api/twilio_proxy.json | 806 +- .../twilio-api/twilio_serverless.json | 544 +- src/services/twilio-api/twilio_studio.json | 593 +- src/services/twilio-api/twilio_supersim.json | 333 +- src/services/twilio-api/twilio_sync.json | 1112 +- .../twilio-api/twilio_taskrouter.json | 4364 ++--- src/services/twilio-api/twilio_trunking.json | 595 +- src/services/twilio-api/twilio_verify.json | 791 +- src/services/twilio-api/twilio_video.json | 1222 +- src/services/twilio-api/twilio_voice.json | 72 +- src/services/twilio-api/twilio_wireless.json | 843 +- .../services/twilio-api/twilio-client.test.js | 2 +- 30 files changed, 18397 insertions(+), 22318 deletions(-) diff --git a/src/services/twilio-api/api-browser.js b/src/services/twilio-api/api-browser.js index b2a2aeb3..83f3f8da 100644 --- a/src/services/twilio-api/api-browser.js +++ b/src/services/twilio-api/api-browser.js @@ -45,8 +45,17 @@ class TwilioApiBrowser { // Move the operations into an operations object. OPERATIONS.forEach(operationName => { if (operationName in path) { - path.operations[operationName] = path[operationName]; + const operation = path[operationName]; + path.operations[operationName] = operation; delete path[operationName]; + + // Convert all the request body properties to query parameters for + // simpler parsing downstream. + const parameters = this.requestPropertiesToParameters(operation.requestBody); + + if (parameters.length > 0) { + operation.parameters = operation.parameters ? operation.parameters.concat(parameters) : parameters; + } } }); @@ -65,6 +74,29 @@ class TwilioApiBrowser { return domains; } + + requestPropertiesToParameters(requestBody) { + const parameters = []; + const content = (requestBody || {}).content || {}; + + Object.values(content).forEach(type => { + const typeSchema = type.schema || {}; + const properties = typeSchema.properties || {}; + const required = typeSchema.required || []; + + Object.entries(properties).forEach(([name, schema]) => { + parameters.push({ + name, + schema, + in: 'query', + required: required.includes(name), + description: schema.description + }); + }); + }); + + return parameters; + } } module.exports = TwilioApiBrowser; diff --git a/src/services/twilio-api/twilio_accounts.json b/src/services/twilio-api/twilio_accounts.json index 639d6ced..9015bb66 100644 --- a/src/services/twilio-api/twilio_accounts.json +++ b/src/services/twilio-api/twilio_accounts.json @@ -156,7 +156,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -170,38 +171,35 @@ }, "post": { "description": "Create a new AWS Credential", - "parameters": [ - { - "description": "A string that contains the AWS access credentials in the format `:`. For example, `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`", - "in": "query", - "name": "Credentials", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request.", - "in": "query", - "name": "AccountSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "description": "The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "Credentials": { + "description": "A string that contains the AWS access credentials in the format `:`. For example, `AKIAIOSFODNN7EXAMPLE:wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "Credentials" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -210,7 +208,8 @@ "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" } } - } + }, + "description": "Created" } }, "security": [ @@ -290,7 +289,8 @@ "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" } } - } + }, + "description": "OK" } }, "security": [ @@ -316,17 +316,23 @@ "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -335,7 +341,8 @@ "$ref": "#/components/schemas/accounts.v1.credential.credential_aws" } } - } + }, + "description": "OK" } }, "security": [ @@ -421,7 +428,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -435,38 +443,35 @@ }, "post": { "description": "Create a new Public Key Credential", - "parameters": [ - { - "description": "A URL encoded representation of the public key. For example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----`", - "in": "query", - "name": "PublicKey", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request", - "in": "query", - "name": "AccountSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "description": "The SID of the Subaccount that this Credential should be associated with. Must be a valid Subaccount of the account issuing the request", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "PublicKey": { + "description": "A URL encoded representation of the public key. For example, `-----BEGIN PUBLIC KEY-----MIIBIjANB.pa9xQIDAQAB-----END PUBLIC KEY-----`", + "type": "string" + } + }, + "required": [ + "PublicKey" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -475,7 +480,8 @@ "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" } } - } + }, + "description": "Created" } }, "security": [ @@ -555,7 +561,8 @@ "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" } } - } + }, + "description": "OK" } }, "security": [ @@ -581,17 +588,23 @@ "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -600,7 +613,8 @@ "$ref": "#/components/schemas/accounts.v1.credential.credential_public_key" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_api.json b/src/services/twilio-api/twilio_api.json index 02ddcffb..e5a5e27e 100644 --- a/src/services/twilio-api/twilio_api.json +++ b/src/services/twilio-api/twilio_api.json @@ -7138,7 +7138,6 @@ "description": "Only return the Account resources with friendly names that exactly match this name.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -7147,7 +7146,6 @@ "description": "Only return Account resources with the given status. Can be `closed`, `suspended` or `active`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "active", @@ -7212,7 +7210,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7226,17 +7225,21 @@ }, "post": { "description": "Create a new Twilio Subaccount from the account making the request", - "parameters": [ - { - "description": "A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}`", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}`", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -7245,7 +7248,8 @@ "$ref": "#/components/schemas/api.v2010.account" } } - } + }, + "description": "Created" } }, "security": [ @@ -7290,7 +7294,6 @@ "description": "The `customer_name` of the Address resources to read.", "in": "query", "name": "CustomerName", - "required": false, "schema": { "type": "string" } @@ -7299,7 +7302,6 @@ "description": "The string that identifies the Address resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -7308,7 +7310,6 @@ "description": "The ISO country code of the Address resources to read.", "in": "query", "name": "IsoCountry", - "required": false, "schema": { "type": "string" } @@ -7368,7 +7369,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7394,89 +7396,63 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The name to associate with the new address.", - "in": "query", - "name": "CustomerName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The number and street address of the new address.", - "in": "query", - "name": "Street", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The city of the new address.", - "in": "query", - "name": "City", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The state or region of the new address.", - "in": "query", - "name": "Region", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The postal code of the new address.", - "in": "query", - "name": "PostalCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The ISO country code of the new address.", - "in": "query", - "name": "IsoCountry", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new address. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to enable emergency calling on the new address. Can be: `true` or `false`.", - "in": "query", - "name": "EmergencyEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.", - "in": "query", - "name": "AutoCorrectAddress", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AutoCorrectAddress": { + "description": "Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.", + "type": "boolean" + }, + "City": { + "description": "The city of the new address.", + "type": "string" + }, + "CustomerName": { + "description": "The name to associate with the new address.", + "type": "string" + }, + "EmergencyEnabled": { + "description": "Whether to enable emergency calling on the new address. Can be: `true` or `false`.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new address. It can be up to 64 characters long.", + "type": "string" + }, + "IsoCountry": { + "description": "The ISO country code of the new address.", + "type": "string" + }, + "PostalCode": { + "description": "The postal code of the new address.", + "type": "string" + }, + "Region": { + "description": "The state or region of the new address.", + "type": "string" + }, + "Street": { + "description": "The number and street address of the new address.", + "type": "string" + } + }, + "required": [ + "CustomerName", + "Street", + "City", + "Region", + "PostalCode", + "IsoCountry" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -7485,7 +7461,8 @@ "$ref": "#/components/schemas/api.v2010.account.address" } } - } + }, + "description": "Created" } }, "security": [ @@ -7594,7 +7571,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7698,7 +7676,8 @@ "$ref": "#/components/schemas/api.v2010.account.address" } } - } + }, + "description": "OK" } }, "security": [ @@ -7736,80 +7715,51 @@ "pattern": "^AD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the address. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The name to associate with the address.", - "in": "query", - "name": "CustomerName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number and street address of the address.", - "in": "query", - "name": "Street", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The city of the address.", - "in": "query", - "name": "City", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The state or region of the address.", - "in": "query", - "name": "Region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The postal code of the address.", - "in": "query", - "name": "PostalCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to enable emergency calling on the address. Can be: `true` or `false`.", - "in": "query", - "name": "EmergencyEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.", - "in": "query", - "name": "AutoCorrectAddress", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AutoCorrectAddress": { + "description": "Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won't alter the address you provide.", + "type": "boolean" + }, + "City": { + "description": "The city of the address.", + "type": "string" + }, + "CustomerName": { + "description": "The name to associate with the address.", + "type": "string" + }, + "EmergencyEnabled": { + "description": "Whether to enable emergency calling on the address. Can be: `true` or `false`.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the address. It can be up to 64 characters long.", + "type": "string" + }, + "PostalCode": { + "description": "The postal code of the address.", + "type": "string" + }, + "Region": { + "description": "The state or region of the address.", + "type": "string" + }, + "Street": { + "description": "The number and street address of the address.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7818,7 +7768,8 @@ "$ref": "#/components/schemas/api.v2010.account.address" } } - } + }, + "description": "OK" } }, "security": [ @@ -7864,7 +7815,6 @@ "description": "The string that identifies the Application resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -7924,7 +7874,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7950,229 +7901,468 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is the account's default API version.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiVersion": { + "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is the account's default API version.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new application. It can be up to 64 characters long.", + "type": "string" + }, + "MessageStatusCallback": { + "description": "The URL we should call using a POST method to send message status information to your application.", + "format": "uri", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsStatusCallback": { + "description": "The URL we should call using a POST method to send status information about SMS messages sent by the application.", + "format": "uri", + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL we should call when the phone number assigned to this application receives a call.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } } - }, + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.application" + } + } + }, + "description": "Created" + } + }, + "security": [ { - "description": "The URL we should call when the phone number assigned to this application receives a call.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "date_created" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json": { + "delete": { + "description": "Delete the application by the specified application sid", + "parameters": [ { - "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to delete.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the Application resource to delete.", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL we should call when the phone number receives an incoming SMS message.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message.", + "get": { + "description": "Fetch the application specified by the provided sid", + "parameters": [ { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource to fetch.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the Application resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.application" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The URL we should call using a POST method to send status information about SMS messages sent by the application.", - "in": "query", - "name": "SmsStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "Updates the application's properties", + "parameters": [ { - "description": "The URL we should call using a POST method to send message status information to your application.", - "in": "query", - "name": "MessageStatusCallback", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to update.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "A descriptive string that you create to describe the new application. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the Application resource to update.", + "in": "path", + "name": "Sid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiVersion": { + "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is your account's default API version.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "MessageStatusCallback": { + "description": "The URL we should call using a POST method to send message status information to your application.", + "format": "uri", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsStatusCallback": { + "description": "The URL we should call using a POST method to send status information about SMS messages sent by the application.", + "format": "uri", + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL we should call when the phone number assigned to this application receives a call.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.v2010.account.application" } } - } + }, + "description": "OK" } }, "security": [ @@ -8194,14 +8384,15 @@ "friendly_name", "date_created" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json": { - "delete": { - "description": "Delete the application by the specified application sid", + "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json": { + "description": "Authorized Twilio Connect apps", + "get": { + "description": "Retrieve a list of authorized-connect-apps belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -8213,21 +8404,62 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Application resource to delete.", - "in": "path", - "name": "Sid", - "required": true, + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "authorized_connect_apps": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + }, + "type": "array" + }, + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" } }, "security": [ @@ -8239,12 +8471,24 @@ "GA" ] }, - "description": "An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message.", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "connect_app_sid", + "connect_app_friendly_name" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json": { + "description": "Authorized Twilio Connect apps", "get": { - "description": "Fetch the application specified by the provided sid", + "description": "Fetch an instance of an authorized-connect-app", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -8256,14 +8500,14 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Application resource to fetch.", + "description": "The SID of the Connect App to fetch.", "in": "path", - "name": "Sid", + "name": "ConnectAppSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", + "pattern": "^CN[0-9a-fA-F]{32}$", "type": "string" } } @@ -8273,10 +8517,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.application" + "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" } } - } + }, + "description": "OK" } }, "security": [ @@ -8288,285 +8533,24 @@ "GA" ] }, - "post": { - "description": "Updates the application's properties", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "connect_app_sid", + "connect_app_friendly_name" + ], + "x-path-type": "instance" + }, + "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json": { + "description": "Country codes with available phone numbers", + "get": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Application resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is your account's default API version.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call when the phone number assigned to this application receives a call.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL we should call when the phone number receives an incoming SMS message.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using a POST method to send status information about SMS messages sent by the application.", - "in": "query", - "name": "SmsStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call using a POST method to send message status information to your application.", - "in": "query", - "name": "MessageStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.application" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "date_created" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json": { - "description": "Authorized Twilio Connect apps", - "get": { - "description": "Retrieve a list of authorized-connect-apps belonging to the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resources.", "in": "path", "name": "AccountSid", "required": true, @@ -8594,9 +8578,9 @@ "application/json": { "schema": { "properties": { - "authorized_connect_apps": { + "countries": { "items": { - "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" }, "type": "array" }, @@ -8632,7 +8616,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -8650,18 +8635,19 @@ } ], "x-default-output-properties": [ - "connect_app_sid", - "connect_app_friendly_name" + "country_code", + "country", + "beta" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json": { - "description": "Authorized Twilio Connect apps", + "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json": { + "description": "Country codes with available phone numbers", "get": { - "description": "Fetch an instance of an authorized-connect-app", + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resource.", "in": "path", "name": "AccountSid", "required": true, @@ -8673,14 +8659,11 @@ } }, { - "description": "The SID of the Connect App to fetch.", + "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country to fetch available phone number information about.", "in": "path", - "name": "ConnectAppSid", + "name": "CountryCode", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CN[0-9a-fA-F]{32}$", "type": "string" } } @@ -8690,10 +8673,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.authorized_connect_app" + "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" } } - } + }, + "description": "OK" } }, "security": [ @@ -8711,18 +8695,19 @@ } ], "x-default-output-properties": [ - "connect_app_sid", - "connect_app_friendly_name" + "country_code", + "country", + "beta" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json": { - "description": "Country codes with available phone numbers", + "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json": { + "description": "Available local phone numbers", "get": { "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resources.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", "in": "path", "name": "AccountSid", "required": true, @@ -8734,174 +8719,18 @@ } }, { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", + "in": "path", + "name": "CountryCode", + "required": true, + "schema": { + "type": "string" + } + }, + { + "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "countries": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "country_code", - "country", - "beta" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json": { - "description": "Country codes with available phone numbers", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country to fetch available phone number information about.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.available_phone_number_country" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "country_code", - "country", - "beta" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json": { - "description": "Available local phone numbers", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers.", - "in": "path", - "name": "CountryCode", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", - "in": "query", - "name": "AreaCode", - "required": false, + "name": "AreaCode", "schema": { "type": "integer" } @@ -8910,7 +8739,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -8919,7 +8747,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -8928,7 +8755,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -8937,7 +8763,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -8946,7 +8771,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -8955,7 +8779,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -8964,7 +8787,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -8973,7 +8795,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -8982,7 +8803,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -8991,7 +8811,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -9000,7 +8819,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -9009,7 +8827,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -9018,7 +8835,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -9027,7 +8843,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -9036,7 +8851,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -9045,7 +8859,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -9054,7 +8867,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9114,7 +8926,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9168,7 +8981,6 @@ "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "AreaCode", - "required": false, "schema": { "type": "integer" } @@ -9177,7 +8989,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -9186,7 +8997,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9195,7 +9005,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9204,7 +9013,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9213,7 +9021,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9222,7 +9029,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9231,7 +9037,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9240,7 +9045,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -9249,7 +9053,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -9258,7 +9061,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -9267,7 +9069,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -9276,7 +9077,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -9285,7 +9085,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -9294,7 +9093,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -9303,7 +9101,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -9312,7 +9109,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -9321,7 +9117,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9381,7 +9176,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9435,7 +9231,6 @@ "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "AreaCode", - "required": false, "schema": { "type": "integer" } @@ -9444,7 +9239,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -9453,7 +9247,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9462,7 +9255,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9471,7 +9263,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9480,7 +9271,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9489,7 +9279,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9498,7 +9287,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9507,7 +9295,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -9516,7 +9303,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -9525,7 +9311,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -9534,7 +9319,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -9543,7 +9327,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -9552,7 +9335,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -9561,7 +9343,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -9570,7 +9351,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -9579,7 +9359,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -9588,7 +9367,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9648,7 +9426,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9702,7 +9481,6 @@ "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "AreaCode", - "required": false, "schema": { "type": "integer" } @@ -9711,7 +9489,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -9720,7 +9497,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9729,7 +9505,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9738,7 +9513,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9747,7 +9521,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9756,7 +9529,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9765,7 +9537,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -9774,7 +9545,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -9783,7 +9553,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -9792,7 +9561,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -9801,7 +9569,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -9810,7 +9577,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -9819,7 +9585,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -9828,7 +9593,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -9837,7 +9601,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -9846,7 +9609,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -9855,7 +9617,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9915,7 +9676,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9969,7 +9731,6 @@ "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "AreaCode", - "required": false, "schema": { "type": "integer" } @@ -9978,7 +9739,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -9987,7 +9747,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -9996,7 +9755,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10005,7 +9763,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10014,7 +9771,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10023,7 +9779,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10032,7 +9787,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10041,7 +9795,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -10050,7 +9803,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -10059,7 +9811,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -10068,7 +9819,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -10077,7 +9827,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -10086,7 +9835,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -10095,7 +9843,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -10104,7 +9851,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -10113,7 +9859,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -10122,7 +9867,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10182,7 +9926,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10236,7 +9981,6 @@ "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "AreaCode", - "required": false, "schema": { "type": "integer" } @@ -10245,7 +9989,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -10254,7 +9997,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10263,7 +10005,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10272,7 +10013,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10281,7 +10021,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10290,7 +10029,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10299,7 +10037,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10308,7 +10045,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -10317,7 +10053,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -10326,7 +10061,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -10335,7 +10069,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -10344,7 +10077,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -10353,7 +10085,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -10362,7 +10093,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -10371,7 +10101,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -10380,7 +10109,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -10389,7 +10117,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10449,7 +10176,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10503,7 +10231,6 @@ "description": "The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "AreaCode", - "required": false, "schema": { "type": "integer" } @@ -10512,7 +10239,6 @@ "description": "The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters.", "in": "query", "name": "Contains", - "required": false, "schema": { "type": "string" } @@ -10521,7 +10247,6 @@ "description": "Whether the phone numbers can receive text messages. Can be: `true` or `false`.", "in": "query", "name": "SmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10530,7 +10255,6 @@ "description": "Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.", "in": "query", "name": "MmsEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10539,7 +10263,6 @@ "description": "Whether the phone numbers can receive calls. Can be: `true` or `false`.", "in": "query", "name": "VoiceEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10548,7 +10271,6 @@ "description": "Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeAllAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10557,7 +10279,6 @@ "description": "Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeLocalAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10566,7 +10287,6 @@ "description": "Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.", "in": "query", "name": "ExcludeForeignAddressRequired", - "required": false, "schema": { "type": "boolean" } @@ -10575,7 +10295,6 @@ "description": "Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -10584,7 +10303,6 @@ "description": "Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearNumber", - "required": false, "schema": { "type": "string" } @@ -10593,7 +10311,6 @@ "description": "Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "NearLatLong", - "required": false, "schema": { "type": "string" } @@ -10602,7 +10319,6 @@ "description": "The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "Distance", - "required": false, "schema": { "type": "integer" } @@ -10611,7 +10327,6 @@ "description": "Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InPostalCode", - "required": false, "schema": { "type": "string" } @@ -10620,7 +10335,6 @@ "description": "Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRegion", - "required": false, "schema": { "type": "string" } @@ -10629,7 +10343,6 @@ "description": "Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InRateCenter", - "required": false, "schema": { "type": "string" } @@ -10638,7 +10351,6 @@ "description": "Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada.", "in": "query", "name": "InLata", - "required": false, "schema": { "type": "string" } @@ -10647,7 +10359,6 @@ "description": "Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number.", "in": "query", "name": "InLocality", - "required": false, "schema": { "type": "string" } @@ -10656,7 +10367,6 @@ "description": "Whether the phone numbers can receive faxes. Can be: `true` or `false`.", "in": "query", "name": "FaxEnabled", - "required": false, "schema": { "type": "boolean" } @@ -10716,7 +10426,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10766,7 +10477,8 @@ "$ref": "#/components/schemas/api.v2010.account.balance" } } - } + }, + "description": "OK" } }, "security": [ @@ -10811,7 +10523,6 @@ "description": "Only show calls made to this phone number, SIP address, Client identifier or SIM SID.", "in": "query", "name": "To", - "required": false, "schema": { "type": "string" } @@ -10820,7 +10531,6 @@ "description": "Only include calls from this phone number, SIP address, Client identifier or SIM SID.", "in": "query", "name": "From", - "required": false, "schema": { "type": "string" } @@ -10829,7 +10539,6 @@ "description": "Only include calls spawned by calls with this SID.", "in": "query", "name": "ParentCallSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -10841,7 +10550,6 @@ "description": "The status of the calls to include. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "queued", @@ -10860,7 +10568,6 @@ "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.", "in": "query", "name": "StartTime", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -10870,7 +10577,6 @@ "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.", "in": "query", "name": "StartTime<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -10880,7 +10586,6 @@ "description": "Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.", "in": "query", "name": "StartTime>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -10890,7 +10595,6 @@ "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.", "in": "query", "name": "EndTime", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -10900,7 +10604,6 @@ "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.", "in": "query", "name": "EndTime<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -10910,7 +10613,6 @@ "description": "Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.", "in": "query", "name": "EndTime>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -10971,7 +10673,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10997,391 +10700,352 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The phone number, SIP address, or client identifier to call.", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApplicationSid": { + "description": "The SID of the Application resource that will handle the call, if the call will be handled by an application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "AsyncAmd": { + "description": "Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`.", + "type": "string" + }, + "AsyncAmdStatusCallback": { + "description": "The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax.", + "format": "uri", + "type": "string" + }, + "AsyncAmdStatusCallbackMethod": { + "description": "The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Byoc": { + "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)", + "maxLength": 34, + "minLength": 34, + "pattern": "^BY[0-9a-fA-F]{32}$", + "type": "string" + }, + "CallReason": { + "description": "The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)", + "type": "string" + }, + "CallerId": { + "description": "The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`.", + "type": "string" + }, + "FallbackMethod": { + "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackUrl": { + "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.", + "format": "uri", + "type": "string" + }, + "From": { + "description": "The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number.", + "type": "string" + }, + "MachineDetection": { + "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).", + "type": "string" + }, + "MachineDetectionSilenceTimeout": { + "description": "The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.", + "type": "integer" + }, + "MachineDetectionSpeechEndThreshold": { + "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.", + "type": "integer" + }, + "MachineDetectionSpeechThreshold": { + "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.", + "type": "integer" + }, + "MachineDetectionTimeout": { + "description": "The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.", + "type": "integer" + }, + "Method": { + "description": "The HTTP method we should use when calling the `url` parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Record": { + "description": "Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL.", + "type": "boolean" + }, + "RecordingChannels": { + "description": "The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call.", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "The URL that we call when the recording is available to be accessed.", + "type": "string" + }, + "RecordingStatusCallbackEvent": { + "description": "The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space.", + "items": { + "type": "string" + }, + "type": "array" + }, + "RecordingStatusCallbackMethod": { + "description": "The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SendDigits": { + "description": "A string of keys to dial after connecting to the number, maximum of 32 digits. Valid digits in the string include: any digit (`0`-`9`), '`#`', '`*`' and '`w`', to insert a half second pause. For example, if you connected to a company phone number and wanted to pause for one second, and then dial extension 1234 followed by the pound key, the value of this parameter would be `ww1234#`. Remember to URL-encode this string, since the '`#`' character has special meaning in a URL. If both `SendDigits` and `MachineDetection` parameters are provided, then `MachineDetection` will be ignored.", + "type": "string" + }, + "SipAuthPassword": { + "description": "The password required to authenticate the user account specified in `sip_auth_username`.", + "type": "string" + }, + "SipAuthUsername": { + "description": "The username used to authenticate the caller making a SIP call.", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. See the code sample for [monitoring call progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json). If an `application_sid` is present, this parameter is ignored.", + "items": { + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Timeout": { + "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail.", + "type": "integer" + }, + "To": { + "description": "The phone number, SIP address, or client identifier to call.", + "type": "string" + }, + "Trim": { + "description": "Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.", + "type": "string" + }, + "Twiml": { + "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored.", + "type": "string" + }, + "Url": { + "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).", + "format": "uri", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } } - }, + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.call" + } + } + }, + "description": "Created" + } + }, + "security": [ { - "description": "The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number.", - "in": "query", - "name": "From", + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "from", + "to", + "status", + "start_time" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json": { + "description": "Call FeedbackSummary resources provide an idea of how your end user\u00e2\u20ac\u2122s perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame.", + "post": { + "description": "Create a FeedbackSummary resource for a call", + "parameters": [ + { + "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", + "in": "path", + "name": "AccountSid", "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The HTTP method we should use when calling the `url` parameter's value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "FallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "FallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. See the code sample for [monitoring call progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json). If an `application_sid` is present, this parameter is ignored.", - "in": "query", - "name": "StatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "A string of keys to dial after connecting to the number, maximum of 32 digits. Valid digits in the string include: any digit (`0`-`9`), '`#`', '`*`' and '`w`', to insert a half second pause. For example, if you connected to a company phone number and wanted to pause for one second, and then dial extension 1234 followed by the pound key, the value of this parameter would be `ww1234#`. Remember to URL-encode this string, since the '`#`' character has special meaning in a URL. If both `SendDigits` and `MachineDetection` parameters are provided, then `MachineDetection` will be ignored.", - "in": "query", - "name": "SendDigits", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail.", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL.", - "in": "query", - "name": "Record", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call.", - "in": "query", - "name": "RecordingChannels", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL that we call when the recording is available to be accessed.", - "in": "query", - "name": "RecordingStatusCallback", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "RecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The username used to authenticate the caller making a SIP call.", - "in": "query", - "name": "SipAuthUsername", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The password required to authenticate the user account specified in `sip_auth_username`.", - "in": "query", - "name": "SipAuthPassword", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).", - "in": "query", - "name": "MachineDetection", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds.", - "in": "query", - "name": "MachineDetectionTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space.", - "in": "query", - "name": "RecordingStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.", - "in": "query", - "name": "Trim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`.", - "in": "query", - "name": "CallerId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.", - "in": "query", - "name": "MachineDetectionSpeechThreshold", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.", - "in": "query", - "name": "MachineDetectionSpeechEndThreshold", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.", - "in": "query", - "name": "MachineDetectionSilenceTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`.", - "in": "query", - "name": "AsyncAmd", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax.", - "in": "query", - "name": "AsyncAmdStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "AsyncAmdStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)", - "in": "query", - "name": "Byoc", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BY[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)", - "in": "query", - "name": "CallReason", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).", - "in": "query", - "name": "Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored.", - "in": "query", - "name": "Twiml", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Application resource that will handle the call, if the call will be handled by an application.", - "in": "query", - "name": "ApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "EndDate": { + "description": "Only include feedback given on or before this date. Format is `YYYY-MM-DD` and specified in UTC.", + "format": "date-time", + "type": "string" + }, + "IncludeSubaccounts": { + "description": "Whether to also include Feedback resources from all subaccounts. `true` includes feedback from all subaccounts and `false`, the default, includes feedback from only the specified account.", + "type": "boolean" + }, + "StartDate": { + "description": "Only include feedback given on or after this date. Format is `YYYY-MM-DD` and specified in UTC.", + "format": "date-time", + "type": "string" + }, + "StatusCallback": { + "description": "The URL that we will request when the feedback summary is complete.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method (`GET` or `POST`) we use to make the request to the `StatusCallback` URL.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + } + }, + "required": [ + "StartDate", + "EndDate" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.call" + "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" } } - } + }, + "description": "Created" } }, "security": [ @@ -11400,17 +11064,15 @@ ], "x-default-output-properties": [ "sid", - "from", - "to", - "status", - "start_time" + "call_feedback_count", + "quality_score_average", + "start_date" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json": { - "description": "Call FeedbackSummary resources provide an idea of how your end user\u00e2\u20ac\u2122s perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame.", - "post": { - "description": "Create a FeedbackSummary resource for a call", + "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json": { + "delete": { + "description": "Delete a FeedbackSummary resource from a call", "parameters": [ { "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", @@ -11425,133 +11087,21 @@ } }, { - "description": "Only include feedback given on or after this date. Format is `YYYY-MM-DD` and specified in UTC.", - "in": "query", - "name": "StartDate", - "required": true, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include feedback given on or before this date. Format is `YYYY-MM-DD` and specified in UTC.", - "in": "query", - "name": "EndDate", + "description": "A 34 character string that uniquely identifies this resource.", + "in": "path", + "name": "Sid", "required": true, "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Whether to also include Feedback resources from all subaccounts. `true` includes feedback from all subaccounts and `false`, the default, includes feedback from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL that we will request when the feedback summary is complete.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method (`GET` or `POST`) we use to make the request to the `StatusCallback` URL.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^FS[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_feedback_count", - "quality_score_average", - "start_date" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json": { - "delete": { - "description": "Delete a FeedbackSummary resource from a call", - "parameters": [ - { - "description": "The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 34 character string that uniquely identifies this resource.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FS[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -11600,7 +11150,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_feedback_summary" } } - } + }, + "description": "OK" } }, "security": [ @@ -11663,7 +11214,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" } } - } + }, + "description": "OK" } }, "security": [ @@ -11701,39 +11253,43 @@ "pattern": "^CA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The call quality expressed as an integer from `1` to `5` where `1` represents very poor call quality and `5` represents a perfect call.", - "in": "query", - "name": "QualityScore", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.", - "in": "query", - "name": "Issue", - "required": false, - "schema": { - "items": { - "enum": [ - "audio-latency", - "digits-not-captured", - "dropped-call", - "imperfect-audio", - "incorrect-caller-id", - "one-way-audio", - "post-dial-delay", - "unsolicited-call" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Issue": { + "description": "One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.", + "items": { + "enum": [ + "audio-latency", + "digits-not-captured", + "dropped-call", + "imperfect-audio", + "incorrect-caller-id", + "one-way-audio", + "post-dial-delay", + "unsolicited-call" + ], + "type": "string" + }, + "type": "array" + }, + "QualityScore": { + "description": "The call quality expressed as an integer from `1` to `5` where `1` represents very poor call quality and `5` represents a perfect call.", + "type": "integer" + } + }, + "required": [ + "QualityScore" ], - "type": "string" - }, - "type": "array" + "type": "object" + } } } - ], + }, "responses": { "200": { "content": { @@ -11742,7 +11298,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_feedback" } } - } + }, + "description": "OK" } }, "security": [ @@ -11799,7 +11356,6 @@ "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", "in": "query", "name": "Log", - "required": false, "schema": { "type": "integer" } @@ -11808,7 +11364,6 @@ "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", "in": "query", "name": "MessageDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -11818,7 +11373,6 @@ "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", "in": "query", "name": "MessageDate<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -11828,7 +11382,6 @@ "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", "in": "query", "name": "MessageDate>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -11889,7 +11442,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -11964,7 +11518,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_notification|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -12017,166 +11572,101 @@ "pattern": "^CA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A unique token for each payment session that should be provided to maintain idempotency of the session.", - "in": "query", - "name": "IdempotencyKey", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback` to send status information of payment session.", - "in": "query", - "name": "StatusCallback", - "required": true, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "If Payment source is ACH, type of bank account. Can be: `consumer-checking`, `consumer-savings`, `commercial-checking`. The default value is `consumer-checking`.", - "in": "query", - "name": "BankAccountType", - "required": false, - "schema": { - "enum": [ - "consumer-checking", - "consumer-savings", - "commercial-checking" - ], - "type": "string" - } - }, - { - "description": "If this field is present and greater than `0.0` payment source will be charged. Otherwise payment source will be tokenized.", - "in": "query", - "name": "ChargeAmount", - "required": false, - "schema": { - "type": "number" - } - }, - { - "description": "Currency `charge_amount` is in. It's format should be as specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD`.", - "in": "query", - "name": "Currency", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Decription of the charge.", - "in": "query", - "name": "Description", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Kind of medium customer would enter payment source information in. Currently only 'DTMF' is supported, which means customer would use keypad of their phone to enter card number etc.", - "in": "query", - "name": "Input", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "If postal code is expected, minimum length of the postal code. When user enters postal code, this value will be used to validate.", - "in": "query", - "name": "MinPostalCodeLength", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Additonal data to be sent over to payment provider. It has to be a JSON string with only one level object. This parameter can be used to send information such as customer name, phone number etc. Refer to specific payment provider's documentation in Twilio console for supported names/values/format.", - "in": "query", - "name": "Parameter", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "Payment connector that you would like Twilio to use for processing payments. The default value is `Default`, which means you need to have at least one payment connector configured in Twilio with name 'Default'. If not you must provide connector configuration name here.", - "in": "query", - "name": "PaymentConnector", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Payment source type. Can be: `credit-card`, `ach-debit`. The default value is `credit-card`.", - "in": "query", - "name": "PaymentMethod", - "required": false, - "schema": { - "enum": [ - "credit-card", - "ach-debit" - ], - "type": "string" - } - }, - { - "description": "Whether to expect postal code during payment source data gathering. Can be: `true`, `false`. The default value is `true`.", - "in": "query", - "name": "PostalCode", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to expect security code during payment source data gathering. Can be: `true`, `false`. The default value is `true`.", - "in": "query", - "name": "SecurityCode", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The number of seconds that we should allow customer to enter payment information. Can be an integer between `5` and `600`, inclusive. The default value is `5`.", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "If tokenization of payment source is desired, this represents type of token. Can be: `one-time`, `reusable`. The default value is `reusable`.", - "in": "query", - "name": "TokenType", - "required": false, - "schema": { - "enum": [ - "one-time", - "reusable" - ], - "type": "string" - } - }, - { - "description": "List of card types accepted with each card types separated by space. Can be: `visa`,`nmastercard`,`amex`,`maestro`,`discover`,`optima`,`jcb`,`diners-club`,`enroute`. The default value is `visa mastercard amex`.", - "in": "query", - "name": "ValidCardTypes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "BankAccountType": { + "description": "If Payment source is ACH, type of bank account. Can be: `consumer-checking`, `consumer-savings`, `commercial-checking`. The default value is `consumer-checking`.", + "enum": [ + "consumer-checking", + "consumer-savings", + "commercial-checking" + ], + "type": "string" + }, + "ChargeAmount": { + "description": "If this field is present and greater than `0.0` payment source will be charged. Otherwise payment source will be tokenized.", + "type": "number" + }, + "Currency": { + "description": "Currency `charge_amount` is in. It's format should be as specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD`.", + "type": "string" + }, + "Description": { + "description": "Decription of the charge.", + "type": "string" + }, + "IdempotencyKey": { + "description": "A unique token for each payment session that should be provided to maintain idempotency of the session.", + "type": "string" + }, + "Input": { + "description": "Kind of medium customer would enter payment source information in. Currently only 'DTMF' is supported, which means customer would use keypad of their phone to enter card number etc.", + "type": "string" + }, + "MinPostalCodeLength": { + "description": "If postal code is expected, minimum length of the postal code. When user enters postal code, this value will be used to validate.", + "type": "integer" + }, + "Parameter": { + "description": "Additonal data to be sent over to payment provider. It has to be a JSON string with only one level object. This parameter can be used to send information such as customer name, phone number etc. Refer to specific payment provider's documentation in Twilio console for supported names/values/format.", + "type": "object" + }, + "PaymentConnector": { + "description": "Payment connector that you would like Twilio to use for processing payments. The default value is `Default`, which means you need to have at least one payment connector configured in Twilio with name 'Default'. If not you must provide connector configuration name here.", + "type": "string" + }, + "PaymentMethod": { + "description": "Payment source type. Can be: `credit-card`, `ach-debit`. The default value is `credit-card`.", + "enum": [ + "credit-card", + "ach-debit" + ], + "type": "string" + }, + "PostalCode": { + "description": "Whether to expect postal code during payment source data gathering. Can be: `true`, `false`. The default value is `true`.", + "type": "boolean" + }, + "SecurityCode": { + "description": "Whether to expect security code during payment source data gathering. Can be: `true`, `false`. The default value is `true`.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback` to send status information of payment session.", + "format": "uri", + "type": "string" + }, + "Timeout": { + "description": "The number of seconds that we should allow customer to enter payment information. Can be an integer between `5` and `600`, inclusive. The default value is `5`.", + "type": "integer" + }, + "TokenType": { + "description": "If tokenization of payment source is desired, this represents type of token. Can be: `one-time`, `reusable`. The default value is `reusable`.", + "enum": [ + "one-time", + "reusable" + ], + "type": "string" + }, + "ValidCardTypes": { + "description": "List of card types accepted with each card types separated by space. Can be: `visa`,`nmastercard`,`amex`,`maestro`,`discover`,`optima`,`jcb`,`diners-club`,`enroute`. The default value is `visa mastercard amex`.", + "type": "string" + } + }, + "required": [ + "IdempotencyKey", + "StatusCallback" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -12185,7 +11675,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.payments" } } - } + }, + "description": "Created" } }, "security": [ @@ -12247,57 +11738,52 @@ "pattern": "^PK[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A unique token for each payment session that should be provided to maintain idempotency of the session.", - "in": "query", - "name": "IdempotencyKey", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback` to send status information of payment session.", - "in": "query", - "name": "StatusCallback", - "required": true, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Specific payment source information to expect. Can be: `payment-card-number`,`expiration-date`,`security-code`,`postal-code`,`bank-routing-number`,`bank-account-number`.", - "in": "query", - "name": "Capture", - "required": false, - "schema": { - "enum": [ - "payment-card-number", - "expiration-date", - "security-code", - "postal-code", - "bank-routing-number", - "bank-account-number" - ], - "type": "string" - } - }, - { - "description": "Instruction to complete or cancel the transaction. Can be: `complete`, `cancel.`", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "complete", - "cancel" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Capture": { + "description": "Specific payment source information to expect. Can be: `payment-card-number`,`expiration-date`,`security-code`,`postal-code`,`bank-routing-number`,`bank-account-number`.", + "enum": [ + "payment-card-number", + "expiration-date", + "security-code", + "postal-code", + "bank-routing-number", + "bank-account-number" + ], + "type": "string" + }, + "IdempotencyKey": { + "description": "A unique token for each payment session that should be provided to maintain idempotency of the session.", + "type": "string" + }, + "Status": { + "description": "Instruction to complete or cancel the transaction. Can be: `complete`, `cancel.`", + "enum": [ + "complete", + "cancel" + ], + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback` to send status information of payment session.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "IdempotencyKey", + "StatusCallback" + ], + "type": "object" + } + } + } + }, "responses": { "202": { "content": { @@ -12306,7 +11792,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.payments" } } - } + }, + "description": "Accepted" } }, "security": [ @@ -12361,7 +11848,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "in": "query", "name": "DateCreated", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -12371,7 +11857,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "in": "query", "name": "DateCreated<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -12381,7 +11866,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "in": "query", "name": "DateCreated>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -12442,7 +11926,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -12480,71 +11965,57 @@ "pattern": "^CA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space.", - "in": "query", - "name": "RecordingStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).", - "in": "query", - "name": "RecordingStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "RecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not.", - "in": "query", - "name": "Trim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels.", - "in": "query", - "name": "RecordingChannels", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "RecordingChannels": { + "description": "The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels.", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback).", + "format": "uri", + "type": "string" + }, + "RecordingStatusCallbackEvent": { + "description": "The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space.", + "items": { + "type": "string" + }, + "type": "array" + }, + "RecordingStatusCallbackMethod": { + "description": "The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Trim": { + "description": "Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -12553,7 +12024,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_recording" } } - } + }, + "description": "Created" } }, "security": [ @@ -12683,7 +12155,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_recording" } } - } + }, + "description": "OK" } }, "security": [ @@ -12730,34 +12203,38 @@ "schema": { "type": "string" } - }, - { - "description": "The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "type": "string" - } - }, - { - "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.", - "in": "query", - "name": "PauseBehavior", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "PauseBehavior": { + "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.", + "type": "string" + }, + "Status": { + "description": "The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.", + "enum": [ + "in-progress", + "paused", + "stopped", + "processing", + "completed", + "absent" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -12766,7 +12243,8 @@ "$ref": "#/components/schemas/api.v2010.account.call.call_recording" } } - } + }, + "description": "OK" } }, "security": [ @@ -12872,7 +12350,8 @@ "$ref": "#/components/schemas/api.v2010.account.call" } } - } + }, + "description": "OK" } }, "security": [ @@ -12910,129 +12389,100 @@ "pattern": "^CA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).", - "in": "query", - "name": "Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when calling the `url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The new status of the resource. Can be: `canceled` or `completed`. Specifying `canceled` will attempt to hang up calls that are queued or ringing; however, it will not affect calls already in progress. Specifying `completed` will attempt to hang up a call even if it's already in progress.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "canceled", - "completed" - ], - "type": "string" - } - }, - { - "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "FallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "FallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when requesting the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive", - "in": "query", - "name": "Twiml", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FallbackMethod": { + "description": "The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackUrl": { + "description": "The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored.", + "format": "uri", + "type": "string" + }, + "Method": { + "description": "The HTTP method we should use when calling the `url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Status": { + "description": "The new status of the resource. Can be: `canceled` or `completed`. Specifying `canceled` will attempt to hang up calls that are queued or ringing; however, it will not affect calls already in progress. Specifying `completed` will attempt to hang up a call even if it's already in progress.", + "enum": [ + "canceled", + "completed" + ], + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted).", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use when requesting the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Twiml": { + "description": "TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive", + "type": "string" + }, + "Url": { + "description": "The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls).", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -13041,7 +12491,8 @@ "$ref": "#/components/schemas/api.v2010.account.call" } } - } + }, + "description": "OK" } }, "security": [ @@ -13088,7 +12539,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", "in": "query", "name": "DateCreated", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -13098,7 +12548,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", "in": "query", "name": "DateCreated<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -13108,7 +12557,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`.", "in": "query", "name": "DateCreated>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -13118,7 +12566,6 @@ "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", "in": "query", "name": "DateUpdated", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -13128,7 +12575,6 @@ "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", "in": "query", "name": "DateUpdated<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -13138,7 +12584,6 @@ "description": "The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`.", "in": "query", "name": "DateUpdated>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -13148,7 +12593,6 @@ "description": "The string that identifies the Conference resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -13157,7 +12601,6 @@ "description": "The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "init", @@ -13222,7 +12665,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -13279,7 +12723,6 @@ "description": "Whether to return only participants that are muted. Can be: `true` or `false`.", "in": "query", "name": "Muted", - "required": false, "schema": { "type": "boolean" } @@ -13288,7 +12731,6 @@ "description": "Whether to return only participants that are on hold. Can be: `true` or `false`.", "in": "query", "name": "Hold", - "required": false, "schema": { "type": "boolean" } @@ -13297,7 +12739,6 @@ "description": "Whether to return only participants who are coaching another call. Can be: `true` or `false`.", "in": "query", "name": "Coaching", - "required": false, "schema": { "type": "boolean" } @@ -13357,7 +12798,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -13392,407 +12834,326 @@ "schema": { "type": "string" } - }, + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Beep": { + "description": "Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", + "type": "string" + }, + "Byoc": { + "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)", + "maxLength": 34, + "minLength": 34, + "pattern": "^BY[0-9a-fA-F]{32}$", + "type": "string" + }, + "CallSidToCoach": { + "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "Coaching": { + "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.", + "type": "boolean" + }, + "ConferenceRecord": { + "description": "Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", + "type": "string" + }, + "ConferenceRecordingStatusCallback": { + "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", + "format": "uri", + "type": "string" + }, + "ConferenceRecordingStatusCallbackEvent": { + "description": "The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, and `failed`. Separate multiple values with a space. The default value is `in-progress completed failed`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ConferenceRecordingStatusCallbackMethod": { + "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "ConferenceStatusCallback": { + "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", + "format": "uri", + "type": "string" + }, + "ConferenceStatusCallbackEvent": { + "description": "The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, and `speaker`. Separate multiple values with a space. Defaults to `start end`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ConferenceStatusCallbackMethod": { + "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "ConferenceTrim": { + "description": "Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", + "type": "string" + }, + "EarlyMedia": { + "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`.", + "type": "boolean" + }, + "EndConferenceOnExit": { + "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "From": { + "description": "The `from` phone number that will dial the new conference participant. Can be a phone number or a client id.", + "type": "string" + }, + "MaxParticipants": { + "description": "The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", + "type": "integer" + }, + "Muted": { + "description": "Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Record": { + "description": "Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "RecordingChannels": { + "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", + "format": "uri", + "type": "string" + }, + "RecordingStatusCallbackEvent": { + "description": "The recording state changes that should generate a call to `recording_status_callback`. Can be: `in-progress`, `completed`, and `failed`. Separate multiple values with a space. The default value is `in-progress completed failed`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "RecordingStatusCallbackMethod": { + "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Region": { + "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", + "type": "string" + }, + "SipAuthPassword": { + "description": "The SIP password for authentication.", + "type": "string" + }, + "SipAuthUsername": { + "description": "The SIP username used for authentication.", + "type": "string" + }, + "StartConferenceOnEnter": { + "description": "Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Timeout": { + "description": "The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.", + "type": "integer" + }, + "To": { + "description": "The phone number, client id, or sip address to invite to the conference. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified.", + "type": "string" + }, + "WaitMethod": { + "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "WaitUrl": { + "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", + "format": "uri", + "type": "string" + } + }, + "required": [ + "From", + "To" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.conference.participant" + } + } + }, + "description": "Created" + } + }, + "security": [ { - "description": "The `from` phone number that will dial the new conference participant. Can be a phone number or a client id.", - "in": "query", - "name": "From", + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "call_sid", + "status", + "muted", + "hold" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json": { + "delete": { + "description": "Kick a participant from a given conference", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to delete.", + "in": "path", + "name": "AccountSid", "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The phone number, client id, or sip address to invite to the conference. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified.", - "in": "query", - "name": "To", + "description": "The SID of the conference with the participants to delete.", + "in": "path", + "name": "ConferenceSid", "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CF[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to delete.", + "in": "path", + "name": "CallSid", + "required": true, "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.", - "in": "query", - "name": "StatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.", - "in": "query", - "name": "Record", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`.", - "in": "query", - "name": "Muted", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", - "in": "query", - "name": "Beep", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", - "in": "query", - "name": "StartConferenceOnEnter", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "EndConferenceOnExit", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", - "in": "query", - "name": "WaitUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", - "in": "query", - "name": "WaitMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`.", - "in": "query", - "name": "EarlyMedia", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", - "in": "query", - "name": "MaxParticipants", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", - "in": "query", - "name": "ConferenceRecord", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", - "in": "query", - "name": "ConferenceTrim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", - "in": "query", - "name": "ConferenceStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "ConferenceStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, and `speaker`. Separate multiple values with a space. Defaults to `start end`.", - "in": "query", - "name": "ConferenceStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", - "in": "query", - "name": "RecordingChannels", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", - "in": "query", - "name": "RecordingStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "RecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The SIP username used for authentication.", - "in": "query", - "name": "SipAuthUsername", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SIP password for authentication.", - "in": "query", - "name": "SipAuthPassword", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", - "in": "query", - "name": "Region", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", - "in": "query", - "name": "ConferenceRecordingStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "ConferenceRecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The recording state changes that should generate a call to `recording_status_callback`. Can be: `in-progress`, `completed`, and `failed`. Separate multiple values with a space. The default value is `in-progress completed failed`.", - "in": "query", - "name": "RecordingStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, and `failed`. Separate multiple values with a space. The default value is `in-progress completed failed`.", - "in": "query", - "name": "ConferenceRecordingStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.", - "in": "query", - "name": "Coaching", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.", - "in": "query", - "name": "CallSidToCoach", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta)", - "in": "query", - "name": "Byoc", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BY[0-9a-fA-F]{32}$", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" - } - } - } + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -13804,25 +13165,12 @@ "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "call_sid", - "status", - "muted", - "hold" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json": { - "delete": { - "description": "Kick a participant from a given conference", + "description": "Conference participants", + "get": { + "description": "Fetch an instance of a participant", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -13834,7 +13182,7 @@ } }, { - "description": "The SID of the conference with the participants to delete.", + "description": "The SID of the conference with the participant to fetch.", "in": "path", "name": "ConferenceSid", "required": true, @@ -13846,7 +13194,7 @@ } }, { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to delete.", + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to fetch.", "in": "path", "name": "CallSid", "required": true, @@ -13859,8 +13207,15 @@ } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.conference.participant" + } + } + }, + "description": "OK" } }, "security": [ @@ -13872,12 +13227,11 @@ "GA" ] }, - "description": "Conference participants", - "get": { - "description": "Fetch an instance of a participant", + "post": { + "description": "Update the properties of the participant", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update.", "in": "path", "name": "AccountSid", "required": true, @@ -13889,7 +13243,7 @@ } }, { - "description": "The SID of the conference with the participant to fetch.", + "description": "The SID of the conference with the participant to update.", "in": "path", "name": "ConferenceSid", "required": true, @@ -13901,7 +13255,7 @@ } }, { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to fetch.", + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to update.", "in": "path", "name": "CallSid", "required": true, @@ -13913,222 +13267,113 @@ } } ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.conference.participant" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "Update the properties of the participant", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the conference with the participant to update.", - "in": "path", - "name": "ConferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to update.", - "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.", - "in": "query", - "name": "Muted", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.", - "in": "query", - "name": "Hold", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the ``, `` or `` commands.", - "in": "query", - "name": "HoldUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.", - "in": "query", - "name": "HoldMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `` or `` commands.", - "in": "query", - "name": "AnnounceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "AnnounceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", - "in": "query", - "name": "WaitUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", - "in": "query", - "name": "WaitMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.", - "in": "query", - "name": "BeepOnExit", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "EndConferenceOnExit", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.", - "in": "query", - "name": "Coaching", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.", - "in": "query", - "name": "CallSidToCoach", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AnnounceMethod": { + "description": "The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "AnnounceUrl": { + "description": "The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `` or `` commands.", + "format": "uri", + "type": "string" + }, + "BeepOnExit": { + "description": "Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.", + "type": "boolean" + }, + "CallSidToCoach": { + "description": "The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "Coaching": { + "description": "Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.", + "type": "boolean" + }, + "EndConferenceOnExit": { + "description": "Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "Hold": { + "description": "Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.", + "type": "boolean" + }, + "HoldMethod": { + "description": "The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "HoldUrl": { + "description": "The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the ``, `` or `` commands.", + "format": "uri", + "type": "string" + }, + "Muted": { + "description": "Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`.", + "type": "boolean" + }, + "WaitMethod": { + "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "WaitUrl": { + "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "200": { "content": { @@ -14137,7 +13382,8 @@ "$ref": "#/components/schemas/api.v2010.account.conference.participant" } } - } + }, + "description": "OK" } }, "security": [ @@ -14195,7 +13441,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "in": "query", "name": "DateCreated", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -14205,7 +13450,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "in": "query", "name": "DateCreated<", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -14215,7 +13459,6 @@ "description": "The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.", "in": "query", "name": "DateCreated>", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -14276,7 +13519,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -14406,7 +13650,8 @@ "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" } } - } + }, + "description": "OK" } }, "security": [ @@ -14453,34 +13698,38 @@ "schema": { "type": "string" } - }, - { - "description": "The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "in-progress", - "paused", - "stopped", - "processing", - "completed", - "absent" - ], - "type": "string" - } - }, - { - "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.", - "in": "query", - "name": "PauseBehavior", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "PauseBehavior": { + "description": "Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.", + "type": "string" + }, + "Status": { + "description": "The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.", + "enum": [ + "in-progress", + "paused", + "stopped", + "processing", + "completed", + "absent" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -14489,7 +13738,8 @@ "$ref": "#/components/schemas/api.v2010.account.conference.conference_recording" } } - } + }, + "description": "OK" } }, "security": [ @@ -14553,7 +13803,8 @@ "$ref": "#/components/schemas/api.v2010.account.conference" } } - } + }, + "description": "OK" } }, "security": [ @@ -14588,53 +13839,49 @@ "schema": { "type": "string" } - }, - { - "description": "The new status of the resource. Can be: Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "completed" - ], - "type": "string" - } - }, - { - "description": "The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with `` or ``.", - "in": "query", - "name": "AnnounceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`", - "in": "query", - "name": "AnnounceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AnnounceMethod": { + "description": "The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "AnnounceUrl": { + "description": "The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with `` or ``.", + "format": "uri", + "type": "string" + }, + "Status": { + "description": "The new status of the resource. Can be: Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants", + "enum": [ + "completed" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -14643,7 +13890,8 @@ "$ref": "#/components/schemas/api.v2010.account.conference" } } - } + }, + "description": "OK" } }, "security": [ @@ -14739,7 +13987,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -14842,7 +14091,8 @@ "$ref": "#/components/schemas/api.v2010.account.connect_app" } } - } + }, + "description": "OK" } }, "security": [ @@ -14880,101 +14130,164 @@ "pattern": "^CN[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.", - "in": "query", - "name": "AuthorizeRedirectUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The company name to set for the Connect App.", - "in": "query", - "name": "CompanyName", - "required": false, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AuthorizeRedirectUrl": { + "description": "The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App.", + "format": "uri", + "type": "string" + }, + "CompanyName": { + "description": "The company name to set for the Connect App.", + "type": "string" + }, + "DeauthorizeCallbackMethod": { + "description": "The HTTP method to use when calling `deauthorize_callback_url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "DeauthorizeCallbackUrl": { + "description": "The URL to call using the `deauthorize_callback_method` to de-authorize the Connect App.", + "format": "uri", + "type": "string" + }, + "Description": { + "description": "A description of the Connect App.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "HomepageUrl": { + "description": "A public URL where users can obtain more information about this Connect App.", + "format": "uri", + "type": "string" + }, + "Permissions": { + "description": "A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`.", + "items": { + "enum": [ + "get-all", + "post-all" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } } - }, + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.connect_app" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The HTTP method to use when calling `deauthorize_callback_url`.", - "in": "query", - "name": "DeauthorizeCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name" + ], + "x-path-type": "instance" + }, + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json": { + "description": "Incoming phone numbers on a Twilio account/project", + "get": { + "description": "Retrieve a list of incoming-phone-numbers belonging to the account used to make the request.", + "parameters": [ { - "description": "The URL to call using the `deauthorize_callback_method` to de-authorize the Connect App.", - "in": "query", - "name": "DeauthorizeCallbackUrl", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to read.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "A description of the Connect App.", + "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", + "in": "query", + "name": "Beta", + "schema": { + "type": "boolean" + } + }, + { + "description": "A string that identifies the IncomingPhoneNumber resources to read.", "in": "query", - "name": "Description", - "required": false, + "name": "FriendlyName", "schema": { "type": "string" } }, { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", "in": "query", - "name": "FriendlyName", - "required": false, + "name": "PhoneNumber", "schema": { "type": "string" } }, { - "description": "A public URL where users can obtain more information about this Connect App.", + "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", "in": "query", - "name": "HomepageUrl", - "required": false, + "name": "Origin", "schema": { - "format": "uri", "type": "string" } }, { - "description": "A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "Permissions", - "required": false, + "name": "PageSize", "schema": { - "items": { - "enum": [ - "get-all", - "post-all" - ], - "type": "string" - }, - "type": "array" + "maximum": 1000, + "minimum": 1, + "type": "integer" } } ], @@ -14983,12 +14296,297 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.connect_app" + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "incoming_phone_numbers": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + }, + "type": "array" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" } } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "Purchase a phone-number for the account.", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "ApiVersion": { + "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", + "type": "string" + }, + "AreaCode": { + "description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only).", + "type": "string" + }, + "BundleSid": { + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyAddressSid": { + "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyStatus": { + "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", + "enum": [ + "Active", + "Inactive" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.", + "type": "string" + }, + "IdentitySid": { + "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", + "type": "string" + }, + "SmsApplicationSid": { + "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the new phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "TrunkSid": { + "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceApplicationSid": { + "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceReceiveMode": { + "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", + "enum": [ + "voice", + "fax" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } } } }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + } + } + }, + "description": "Created" + } + }, "security": [ { "accountSid_authToken": [] @@ -15005,17 +14603,18 @@ ], "x-default-output-properties": [ "sid", + "phone_number", "friendly_name" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json": { - "description": "Incoming phone numbers on a Twilio account/project", + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json": { + "description": "Incoming local phone numbers on a Twilio account/project", "get": { - "description": "Retrieve a list of incoming-phone-numbers belonging to the account used to make the request.", + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -15030,16 +14629,14 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } }, { - "description": "A string that identifies the IncomingPhoneNumber resources to read.", + "description": "A string that identifies the resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -15048,7 +14645,6 @@ "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", "in": "query", "name": "PhoneNumber", - "required": false, "schema": { "type": "string" } @@ -15057,7 +14653,6 @@ "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", "in": "query", "name": "Origin", - "required": false, "schema": { "type": "string" } @@ -15088,7 +14683,7 @@ }, "incoming_phone_numbers": { "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" }, "type": "array" }, @@ -15117,7 +14712,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -15130,7 +14726,7 @@ ] }, "post": { - "description": "Purchase a phone-number for the account.", + "description": "", "parameters": [ { "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", @@ -15143,337 +14739,604 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "ApiVersion": { + "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", + "type": "string" + }, + "BundleSid": { + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyAddressSid": { + "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyStatus": { + "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", + "enum": [ + "Active", + "Inactive" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", + "type": "string" + }, + "IdentitySid": { + "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", + "type": "string" + }, + "SmsApplicationSid": { + "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the new phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "TrunkSid": { + "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceApplicationSid": { + "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceReceiveMode": { + "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", + "enum": [ + "voice", + "fax" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "PhoneNumber" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "phone_number", + "friendly_name" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json": { + "description": "Incoming mobile phone numbers on a Twilio account/project", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } }, { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", + "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", - "name": "ApiVersion", - "required": false, + "name": "Beta", "schema": { - "type": "string" + "type": "boolean" } }, { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number.", + "description": "A string that identifies the resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } }, { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", + "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", "in": "query", - "name": "SmsApplicationSid", - "required": false, + "name": "PhoneNumber", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "in": "query", - "name": "VoiceApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "in": "query", - "name": "EmergencyStatus", - "required": false, - "schema": { - "enum": [ - "Active", - "Inactive" - ], "type": "string" } }, { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "in": "query", - "name": "EmergencyAddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "in": "query", - "name": "TrunkSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", + "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", "in": "query", - "name": "IdentitySid", - "required": false, + "name": "Origin", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "AddressSid", - "required": false, + "name": "PageSize", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "incoming_phone_numbers": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + }, + "type": "array" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "in": "query", - "name": "VoiceReceiveMode", - "required": false, - "schema": { - "enum": [ - "voice", - "fax" - ], - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "in": "query", - "name": "BundleSid", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "in": "query", - "name": "PhoneNumber", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only).", - "in": "query", - "name": "AreaCode", - "required": false, - "schema": { + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "ApiVersion": { + "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", + "type": "string" + }, + "BundleSid": { + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyAddressSid": { + "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyStatus": { + "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", + "enum": [ + "Active", + "Inactive" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.", + "type": "string" + }, + "IdentitySid": { + "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", + "type": "string" + }, + "SmsApplicationSid": { + "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the new phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "TrunkSid": { + "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceApplicationSid": { + "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceReceiveMode": { + "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", + "enum": [ + "voice", + "fax" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "PhoneNumber" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" } } - } + }, + "description": "Created" } }, "security": [ @@ -15497,8 +15360,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json": { - "description": "Incoming local phone numbers on a Twilio account/project", + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json": { + "description": "Incoming toll free phone numbers on a Twilio account/project", "get": { "description": "", "parameters": [ @@ -15518,7 +15381,6 @@ "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", "in": "query", "name": "Beta", - "required": false, "schema": { "type": "boolean" } @@ -15527,7 +15389,6 @@ "description": "A string that identifies the resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -15536,7 +15397,6 @@ "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", "in": "query", "name": "PhoneNumber", - "required": false, "schema": { "type": "string" } @@ -15545,7 +15405,6 @@ "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", "in": "query", "name": "Origin", - "required": false, "schema": { "type": "string" } @@ -15576,7 +15435,7 @@ }, "incoming_phone_numbers": { "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" }, "type": "array" }, @@ -15605,7 +15464,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -15631,328 +15491,228 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "in": "query", - "name": "PhoneNumber", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", - "in": "query", - "name": "SmsApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "in": "query", - "name": "VoiceApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", - "in": "query", - "name": "IdentitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "in": "query", - "name": "AddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "in": "query", - "name": "EmergencyStatus", - "required": false, - "schema": { - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - } - }, - { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "in": "query", - "name": "EmergencyAddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "in": "query", - "name": "TrunkSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "in": "query", - "name": "VoiceReceiveMode", - "required": false, - "schema": { - "enum": [ - "voice", - "fax" - ], - "type": "string" - } - }, - { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "in": "query", - "name": "BundleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "ApiVersion": { + "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", + "type": "string" + }, + "BundleSid": { + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyAddressSid": { + "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyStatus": { + "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", + "enum": [ + "Active", + "Inactive" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", + "type": "string" + }, + "IdentitySid": { + "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", + "type": "string" + }, + "SmsApplicationSid": { + "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the new phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "TrunkSid": { + "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceApplicationSid": { + "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceReceiveMode": { + "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", + "enum": [ + "voice", + "fax" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "PhoneNumber" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" } } - } + }, + "description": "Created" } }, "security": [ @@ -15976,10 +15736,10 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json": { - "description": "Incoming mobile phone numbers on a Twilio account/project", + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json": { + "description": "TODO: Resource-level docs", "get": { - "description": "", + "description": "Retrieve a list of Add-on installations currently assigned to this Number.", "parameters": [ { "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", @@ -15994,38 +15754,14 @@ } }, { - "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A string that identifies the resources to read.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "PhoneNumber", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", - "in": "query", - "name": "Origin", - "required": false, + "description": "The SID of the Phone Number to which the Add-on is assigned.", + "in": "path", + "name": "ResourceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } }, @@ -16046,6 +15782,12 @@ "application/json": { "schema": { "properties": { + "assigned_add_ons": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + }, + "type": "array" + }, "end": { "type": "integer" }, @@ -16053,12 +15795,6 @@ "format": "uri", "type": "string" }, - "incoming_phone_numbers": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" - }, - "type": "array" - }, "next_page_uri": { "format": "uri", "type": "string" @@ -16084,7 +15820,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -16093,11 +15830,11 @@ } ], "tags": [ - "GA" + "Beta" ] }, "post": { - "description": "", + "description": "Assign an Add-on installation to the Number specified.", "parameters": [ { "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", @@ -16112,326 +15849,49 @@ } }, { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "in": "query", - "name": "PhoneNumber", + "description": "The SID of the Phone Number to assign the Add-on.", + "in": "path", + "name": "ResourceSid", "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application.", - "in": "query", - "name": "SmsApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "in": "query", - "name": "VoiceApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations.", - "in": "query", - "name": "IdentitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "in": "query", - "name": "AddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "in": "query", - "name": "EmergencyStatus", - "required": false, - "schema": { - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - } - }, - { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "in": "query", - "name": "EmergencyAddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "in": "query", - "name": "TrunkSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "in": "query", - "name": "VoiceReceiveMode", - "required": false, - "schema": { - "enum": [ - "voice", - "fax" - ], - "type": "string" - } - }, - { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "in": "query", - "name": "BundleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "InstalledAddOnSid": { + "description": "The SID that identifies the Add-on installation.", + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "InstalledAddOnSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" } } - } + }, + "description": "Created" } }, "security": [ @@ -16440,7 +15900,7 @@ } ], "tags": [ - "GA" + "Beta" ] }, "servers": [ @@ -16450,15 +15910,16 @@ ], "x-default-output-properties": [ "sid", - "phone_number", - "friendly_name" + "unique_name", + "friendly_name", + "description" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json": { - "description": "Incoming toll free phone numbers on a Twilio account/project", + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json": { + "description": "TODO: Resource-level docs", "get": { - "description": "", + "description": "Retrieve a list of Extensions for the Assigned Add-on.", "parameters": [ { "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", @@ -16473,38 +15934,26 @@ } }, { - "description": "Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "Beta", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A string that identifies the resources to read.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit.", - "in": "query", - "name": "PhoneNumber", - "required": false, + "description": "The SID of the Phone Number to which the Add-on is assigned.", + "in": "path", + "name": "ResourceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.", - "in": "query", - "name": "Origin", - "required": false, + "description": "The SID that uniquely identifies the assigned Add-on installation.", + "in": "path", + "name": "AssignedAddOnSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XE[0-9a-fA-F]{32}$", "type": "string" } }, @@ -16528,16 +15977,16 @@ "end": { "type": "integer" }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "incoming_phone_numbers": { + "extensions": { "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" }, "type": "array" }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, "next_page_uri": { "format": "uri", "type": "string" @@ -16563,7 +16012,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -16572,14 +16022,29 @@ } ], "tags": [ - "GA" + "Beta" ] }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "unique_name", + "friendly_name", + "product_name" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Extension for the Assigned Add-on.", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -16591,326 +16056,182 @@ } }, { - "description": "The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "in": "query", - "name": "PhoneNumber", + "description": "The SID of the Phone Number to which the Add-on is assigned.", + "in": "path", + "name": "ResourceSid", "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application.", - "in": "query", - "name": "SmsApplicationSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call when the new phone number receives an incoming SMS message.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "in": "query", - "name": "VoiceApplicationSid", - "required": false, + "description": "The SID that uniquely identifies the assigned Add-on installation.", + "in": "path", + "name": "AssignedAddOnSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "pattern": "^XE[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^XF[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "unique_name", + "friendly_name", + "product_name" + ], + "x-path-type": "instance" + }, + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json": { + "delete": { + "description": "Remove the assignment of an Add-on installation from the Number specified.", + "parameters": [ { - "description": "The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "in": "query", - "name": "VoiceUrl", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to delete.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations.", - "in": "query", - "name": "IdentitySid", - "required": false, + "description": "The SID of the Phone Number to which the Add-on is assigned.", + "in": "path", + "name": "ResourceSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations.", - "in": "query", - "name": "AddressSid", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the resource to delete.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", + "pattern": "^XE[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "description": "The configuration status parameter that determines whether the new phone number is enabled for emergency calling.", - "in": "query", - "name": "EmergencyStatus", - "required": false, - "schema": { - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "Beta" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch an instance of an Add-on installation currently assigned to this Number.", + "parameters": [ { - "description": "The SID of the emergency address configuration to use for emergency calling from the new phone number.", - "in": "query", - "name": "EmergencyAddressSid", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "in": "query", - "name": "TrunkSid", - "required": false, + "description": "The SID of the Phone Number to which the Add-on is assigned.", + "in": "path", + "name": "ResourceSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "in": "query", - "name": "VoiceReceiveMode", - "required": false, - "schema": { - "enum": [ - "voice", - "fax" - ], + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "in": "query", - "name": "BundleSid", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", + "pattern": "^XE[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" } } - } + }, + "description": "OK" } }, "security": [ @@ -16919,7 +16240,7 @@ } ], "tags": [ - "GA" + "Beta" ] }, "servers": [ @@ -16929,18 +16250,18 @@ ], "x-default-output-properties": [ "sid", - "phone_number", - "friendly_name" + "unique_name", + "friendly_name", + "description" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of Add-on installations currently assigned to this Number.", + "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json": { + "delete": { + "description": "Delete a phone-numbers belonging to the account used to make the request.", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -16952,9 +16273,9 @@ } }, { - "description": "The SID of the Phone Number to which the Add-on is assigned.", + "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to delete.", "in": "path", - "name": "ResourceSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, @@ -16962,15 +16283,48 @@ "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Incoming phone numbers on a Twilio account/project", + "get": { + "description": "Fetch an incoming-phone-number belonging to the account used to make the request.", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to fetch.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } }, { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", + "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" } } ], @@ -16979,46 +16333,11 @@ "content": { "application/json": { "schema": { - "properties": { - "assigned_add_ons": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" } } - } + }, + "description": "OK" } }, "security": [ @@ -17027,14 +16346,14 @@ } ], "tags": [ - "Beta" + "GA" ] }, "post": { - "description": "Assign an Add-on installation to the Number specified.", + "description": "Update an incoming-phone-number instance.", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).", "in": "path", "name": "AccountSid", "required": true, @@ -17046,9 +16365,9 @@ } }, { - "description": "The SID of the Phone Number to assign the Add-on.", + "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update.", "in": "path", - "name": "ResourceSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, @@ -17056,29 +16375,228 @@ "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID that identifies the Add-on installation.", - "in": "query", - "name": "InstalledAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "AddressSid": { + "description": "The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "ApiVersion": { + "description": "The API version to use for incoming calls made to the phone number. The default is `2010-04-01`.", + "type": "string" + }, + "BundleSid": { + "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^BU[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyAddressSid": { + "description": "The SID of the emergency address configuration to use for emergency calling from this phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "EmergencyStatus": { + "description": "The configuration status parameter that determines whether the phone number is enabled for emergency calling.", + "enum": [ + "Active", + "Inactive" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", + "type": "string" + }, + "IdentitySid": { + "description": "The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsApplicationSid": { + "description": "The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when the phone number receives an incoming SMS message.", + "format": "uri", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "TrunkSid": { + "description": "The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceApplicationSid": { + "description": "The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "VoiceCallerIdLookup": { + "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceReceiveMode": { + "description": "The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", + "enum": [ + "voice", + "fax" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" } } - } + }, + "description": "OK" } }, "security": [ @@ -17087,7 +16605,7 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ @@ -17097,19 +16615,18 @@ ], "x-default-output-properties": [ "sid", - "unique_name", - "friendly_name", - "description" + "phone_number", + "friendly_name" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json": { - "description": "TODO: Resource-level docs", + "/2010-04-01/Accounts/{AccountSid}/Keys.json": { + "description": "API keys", "get": { - "description": "Retrieve a list of Extensions for the Assigned Add-on.", + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -17120,30 +16637,6 @@ "type": "string" } }, - { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID that uniquely identifies the assigned Add-on installation.", - "in": "path", - "name": "AssignedAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -17164,16 +16657,16 @@ "end": { "type": "integer" }, - "extensions": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" - }, - "type": "array" - }, "first_page_uri": { "format": "uri", "type": "string" }, + "keys": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.key" + }, + "type": "array" + }, "next_page_uri": { "format": "uri", "type": "string" @@ -17199,16 +16692,69 @@ "type": "object" } } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Key resource.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } } } }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.new_key" + } + } + }, + "description": "Created" + } + }, "security": [ { "accountSid_authToken": [] } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ @@ -17218,19 +16764,17 @@ ], "x-default-output-properties": [ "sid", - "unique_name", "friendly_name", - "product_name" + "date_created" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Extension for the Assigned Add-on.", + "/2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -17242,51 +16786,21 @@ } }, { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID that uniquely identifies the assigned Add-on installation.", - "in": "path", - "name": "AssignedAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the resource to fetch.", + "description": "The Twilio-provided string that uniquely identifies the Key resource to delete.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^XF[0-9a-fA-F]{32}$", + "pattern": "^SK[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension" - } - } - } + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -17295,28 +16809,15 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "unique_name", - "friendly_name", - "product_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json": { - "delete": { - "description": "Remove the assignment of an Add-on installation from the Number specified.", + "description": "API keys", + "get": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -17328,33 +16829,28 @@ } }, { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the resource to delete.", + "description": "The Twilio-provided string that uniquely identifies the Key resource to fetch.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", + "pattern": "^SK[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.key" + } + } + }, + "description": "OK" } }, "security": [ @@ -17363,15 +16859,14 @@ } ], "tags": [ - "Beta" + "GA" ] }, - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch an instance of an Add-on installation currently assigned to this Number.", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to update.", "in": "path", "name": "AccountSid", "required": true, @@ -17383,39 +16878,43 @@ } }, { - "description": "The SID of the Phone Number to which the Add-on is assigned.", - "in": "path", - "name": "ResourceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the resource to fetch.", + "description": "The Twilio-provided string that uniquely identifies the Key resource to update.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^XE[0-9a-fA-F]{32}$", + "pattern": "^SK[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on" + "$ref": "#/components/schemas/api.v2010.account.key" } } - } + }, + "description": "OK" } }, "security": [ @@ -17424,7 +16923,7 @@ } ], "tags": [ - "Beta" + "GA" ] }, "servers": [ @@ -17434,18 +16933,18 @@ ], "x-default-output-properties": [ "sid", - "unique_name", "friendly_name", - "description" + "date_created" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json": { - "delete": { - "description": "Delete a phone-numbers belonging to the account used to make the request.", + "/2010-04-01/Accounts/{AccountSid}/Messages.json": { + "description": "A Message resource represents an inbound or outbound message.", + "get": { + "description": "Retrieve a list of messages belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -17457,59 +16956,57 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to delete.", - "in": "path", - "name": "Sid", - "required": true, + "description": "Read messages sent to only this phone number.", + "in": "query", + "name": "To", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ + }, { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Incoming phone numbers on a Twilio account/project", - "get": { - "description": "Fetch an incoming-phone-number belonging to the account used to make the request.", - "parameters": [ + "description": "Read messages sent from only this phone number or alphanumeric sender ID.", + "in": "query", + "name": "From", + "schema": { + "type": "string" + } + }, { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, + "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "in": "query", + "name": "DateSent", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "format": "date-time", "type": "string" } }, { - "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, + "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "in": "query", + "name": "DateSent<", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", + "format": "date-time", + "type": "string" + } + }, + { + "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "in": "query", + "name": "DateSent>", + "schema": { + "format": "date-time", "type": "string" } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } } ], "responses": { @@ -17517,10 +17014,47 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "messages": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.message" + }, + "type": "array" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -17533,10 +17067,10 @@ ] }, "post": { - "description": "Update an incoming-phone-number instance.", + "description": "Send a message from the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", "in": "path", "name": "AccountSid", "required": true, @@ -17546,343 +17080,400 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressRetention": { + "description": "Determines if the address can be stored or obfuscated based on privacy settings", + "enum": [ + "retain" + ], + "type": "string" + }, + "ApplicationSid": { + "description": "The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "Body": { + "description": "The text of the message you want to send. Can be up to 1,600 characters in length.", + "type": "string" + }, + "ContentRetention": { + "description": "Determines if the message content can be stored or redacted based on privacy settings", + "enum": [ + "retain" + ], + "type": "string" + }, + "ForceDelivery": { + "description": "Reserved", + "type": "boolean" + }, + "From": { + "description": "A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty.", + "type": "string" + }, + "MaxPrice": { + "description": "The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked.", + "type": "number" + }, + "MediaUrl": { + "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada.", + "items": { + "format": "uri", + "type": "string" + }, + "type": "array" + }, + "MessagingServiceSid": { + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + }, + "PersistentAction": { + "description": "Rich actions for Channels Messages.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ProvideFeedback": { + "description": "Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default.", + "type": "boolean" + }, + "SmartEncoded": { + "description": "Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed.", + "format": "uri", + "type": "string" + }, + "To": { + "description": "The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels.", + "type": "string" + }, + "ValidityPeriod": { + "description": "How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds.", + "type": "integer" + } + }, + "required": [ + "To" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.message" + } + } + }, + "description": "Created" + } + }, + "security": [ { - "description": "The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update.", + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "from", + "to", + "status", + "direction", + "date_sent" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json": { + "description": "Customer-provided feedback on delivery confirmation", + "post": { + "description": "", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", "in": "path", - "name": "Sid", + "name": "AccountSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers).", - "in": "query", - "name": "AccountSid", - "required": false, + "description": "The SID of the Message resource for which the feedback was provided.", + "in": "path", + "name": "MessageSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The API version to use for incoming calls made to the phone number. The default is `2010-04-01`.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Outcome": { + "description": "Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.", + "enum": [ + "confirmed", + "unconfirmed" + ], + "type": "string" + } + }, + "type": "object" + } } - }, + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.message.message_feedback" + } + } + }, + "description": "Created" + } + }, + "security": [ { - "description": "A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "message_sid", + "outcome", + "date_created" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json": { + "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", + "get": { + "description": "Retrieve a list of Media resources belonging to the account used to make the request", + "parameters": [ { - "description": "The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application.", - "in": "query", - "name": "SmsApplicationSid", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to read.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, + "description": "The SID of the Message resource that this Media resource belongs to.", + "in": "path", + "name": "MessageSid", + "required": true, "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`.", + "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", "in": "query", - "name": "SmsFallbackUrl", - "required": false, + "name": "DateCreated", "schema": { - "format": "uri", + "format": "date-time", "type": "string" } }, { - "description": "The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.", + "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", "in": "query", - "name": "SmsMethod", - "required": false, + "name": "DateCreated<", "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "format": "date-time", "type": "string" } }, { - "description": "The URL we should call when the phone number receives an incoming SMS message.", + "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", "in": "query", - "name": "SmsUrl", - "required": false, + "name": "DateCreated>", "schema": { - "format": "uri", + "format": "date-time", "type": "string" } }, { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "StatusCallback", - "required": false, + "name": "PageSize", "schema": { - "format": "uri", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "media_list": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.message.media" + }, + "type": "array" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "parent_sid", + "content_type" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json": { + "delete": { + "description": "Delete media from your account. Once delete, you will no longer be billed", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to delete.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa.", - "in": "query", - "name": "VoiceApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to lookup the caller's name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.", - "in": "query", - "name": "VoiceCallerIdLookup", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The configuration status parameter that determines whether the phone number is enabled for emergency calling.", - "in": "query", - "name": "EmergencyStatus", - "required": false, - "schema": { - "enum": [ - "Active", - "Inactive" - ], - "type": "string" - } - }, - { - "description": "The SID of the emergency address configuration to use for emergency calling from this phone number.", - "in": "query", - "name": "EmergencyAddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa.", - "in": "query", - "name": "TrunkSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.", - "in": "query", - "name": "VoiceReceiveMode", - "required": false, - "schema": { - "enum": [ - "voice", - "fax" - ], - "type": "string" - } - }, - { - "description": "The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations.", - "in": "query", - "name": "IdentitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations.", - "in": "query", - "name": "AddressSid", - "required": false, + "description": "The SID of the Message resource that this Media resource belongs to.", + "in": "path", + "name": "MessageSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations.", - "in": "query", - "name": "BundleSid", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the Media resource to delete", + "in": "path", + "name": "Sid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^BU[0-9a-fA-F]{32}$", + "pattern": "^ME[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.incoming_phone_number" - } - } - } + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -17894,25 +17485,12 @@ "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Keys.json": { - "description": "API keys", + "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", "get": { - "description": "", + "description": "Fetch a single media instance belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -17924,106 +17502,40 @@ } }, { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "keys": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.key" - }, - "type": "array" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Key resource.", + "description": "The SID of the Message resource that this Media resource belongs to.", "in": "path", - "name": "AccountSid", + "name": "MessageSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, + "description": "The Twilio-provided string that uniquely identifies the Media resource to fetch", + "in": "path", + "name": "Sid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ME[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.new_key" + "$ref": "#/components/schemas/api.v2010.account.message.media" } } - } + }, + "description": "OK" } }, "security": [ @@ -18042,17 +17554,17 @@ ], "x-default-output-properties": [ "sid", - "friendly_name", - "date_created" + "parent_sid", + "content_type" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json": { + "/2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json": { "delete": { - "description": "", + "description": "Deletes a message record from your account", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -18064,14 +17576,14 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Key resource to delete.", + "description": "The Twilio-provided string that uniquely identifies the Message resource to delete.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } } @@ -18090,12 +17602,12 @@ "GA" ] }, - "description": "API keys", + "description": "A Message resource represents an inbound or outbound message.", "get": { - "description": "", + "description": "Fetch a message belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -18107,14 +17619,14 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Key resource to fetch.", + "description": "The Twilio-provided string that uniquely identifies the Message resource to fetch.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } } @@ -18124,10 +17636,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.key" + "$ref": "#/components/schemas/api.v2010.account.message" } } - } + }, + "description": "OK" } }, "security": [ @@ -18140,10 +17653,10 @@ ] }, "post": { - "description": "", + "description": "To redact a message-body from a post-flight message record, post to the message instance resource with an empty body", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to update.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to update.", "in": "path", "name": "AccountSid", "required": true, @@ -18155,36 +17668,46 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Key resource to update.", + "description": "The Twilio-provided string that uniquely identifies the Message resource to update.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^SK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { + "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Body": { + "description": "The text of the message you want to send. Can be up to 1,600 characters long.", + "type": "string" + } + }, + "required": [ + "Body" + ], + "type": "object" + } + } + } + }, "responses": { - "200": { + "202": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.key" + "$ref": "#/components/schemas/api.v2010.account.message" } } - } + }, + "description": "Accepted" } }, "security": [ @@ -18203,18 +17726,21 @@ ], "x-default-output-properties": [ "sid", - "friendly_name", - "date_created" + "from", + "to", + "status", + "direction", + "date_sent" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Messages.json": { - "description": "A Message resource represents an inbound or outbound message.", + "/2010-04-01/Accounts/{AccountSid}/Notifications.json": { + "description": "[DEPRECATED] Log entries", "get": { - "description": "Retrieve a list of messages belonging to the account used to make the request", + "description": "Retrieve a list of notifications belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -18226,48 +17752,35 @@ } }, { - "description": "Read messages sent to only this phone number.", - "in": "query", - "name": "To", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Read messages sent from only this phone number or alphanumeric sender ID.", + "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", "in": "query", - "name": "From", - "required": false, + "name": "Log", "schema": { - "type": "string" + "type": "integer" } }, { - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", "in": "query", - "name": "DateSent", - "required": false, + "name": "MessageDate", "schema": { "format": "date-time", "type": "string" } }, { - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", "in": "query", - "name": "DateSent<", - "required": false, + "name": "MessageDate<", "schema": { "format": "date-time", "type": "string" } }, { - "description": "The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.", + "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", "in": "query", - "name": "DateSent>", - "required": false, + "name": "MessageDate>", "schema": { "format": "date-time", "type": "string" @@ -18297,16 +17810,16 @@ "format": "uri", "type": "string" }, - "messages": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.message" - }, - "type": "array" - }, "next_page_uri": { "format": "uri", "type": "string" }, + "notifications": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.notification" + }, + "type": "array" + }, "page": { "type": "integer" }, @@ -18328,7 +17841,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -18340,11 +17854,26 @@ "GA" ] }, - "post": { - "description": "Send a message from the account used to make the request", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "call_sid", + "error_code", + "message_date" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json": { + "description": "[DEPRECATED] Log entries", + "get": { + "description": "Fetch a notification belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -18356,170 +17885,28 @@ } }, { - "description": "The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels.", - "in": "query", - "name": "To", + "description": "The Twilio-provided string that uniquely identifies the Notification resource to fetch.", + "in": "path", + "name": "Sid", "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used.", - "in": "query", - "name": "ApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked.", - "in": "query", - "name": "MaxPrice", - "required": false, - "schema": { - "type": "number" - } - }, - { - "description": "Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default.", - "in": "query", - "name": "ProvideFeedback", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds.", - "in": "query", - "name": "ValidityPeriod", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Reserved", - "in": "query", - "name": "ForceDelivery", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Determines if the message content can be stored or redacted based on privacy settings", - "in": "query", - "name": "ContentRetention", - "required": false, - "schema": { - "enum": [ - "retain" - ], - "type": "string" - } - }, - { - "description": "Determines if the address can be stored or obfuscated based on privacy settings", - "in": "query", - "name": "AddressRetention", - "required": false, - "schema": { - "enum": [ - "retain" - ], - "type": "string" - } - }, - { - "description": "Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`.", - "in": "query", - "name": "SmartEncoded", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Rich actions for Channels Messages.", - "in": "query", - "name": "PersistentAction", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty.", - "in": "query", - "name": "From", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery.", - "in": "query", - "name": "MessagingServiceSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The text of the message you want to send. Can be up to 1,600 characters in length.", - "in": "query", - "name": "Body", - "required": false, - "schema": { + "pattern": "^NO[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada.", - "in": "query", - "name": "MediaUrl", - "required": false, - "schema": { - "items": { - "format": "uri", - "type": "string" - }, - "type": "array" - } } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.message" + "$ref": "#/components/schemas/api.v2010.account.notification|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -18538,21 +17925,19 @@ ], "x-default-output-properties": [ "sid", - "from", - "to", - "status", - "direction", - "date_sent" + "call_sid", + "error_code", + "message_date" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json": { - "description": "Customer-provided feedback on delivery confirmation", - "post": { - "description": "", + "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json": { + "description": "An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb.", + "get": { + "description": "Retrieve a list of outgoing-caller-ids belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -18564,135 +17949,34 @@ } }, { - "description": "The SID of the Message resource for which the feedback was provided.", - "in": "path", - "name": "MessageSid", - "required": true, + "description": "The phone number of the OutgoingCallerId resources to read.", + "in": "query", + "name": "PhoneNumber", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.", + "description": "The string that identifies the OutgoingCallerId resources to read.", "in": "query", - "name": "Outcome", - "required": false, + "name": "FriendlyName", "schema": { - "enum": [ - "confirmed", - "unconfirmed" - ], "type": "string" } + }, + { + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", + "schema": { + "maximum": 1000, + "minimum": 1, + "type": "integer" + } } ], "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.message.message_feedback" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "message_sid", - "outcome", - "date_created" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json": { - "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", - "get": { - "description": "Retrieve a list of Media resources belonging to the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Message resource that this Media resource belongs to.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", - "in": "query", - "name": "DateCreated<", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.", - "in": "query", - "name": "DateCreated>", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { + "200": { "content": { "application/json": { "schema": { @@ -18704,16 +17988,16 @@ "format": "uri", "type": "string" }, - "media_list": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.message.media" - }, - "type": "array" - }, "next_page_uri": { "format": "uri", "type": "string" }, + "outgoing_caller_ids": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + }, + "type": "array" + }, "page": { "type": "integer" }, @@ -18735,7 +18019,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -18747,24 +18032,11 @@ "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "parent_sid", - "content_type" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json": { - "delete": { - "description": "Delete media from your account. Once delete, you will no longer be billed", + "post": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for the new caller ID resource.", "in": "path", "name": "AccountSid", "required": true, @@ -18774,96 +18046,71 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the Message resource that this Media resource belongs to.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Media resource to delete", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] } ], - "tags": [ - "GA" - ] - }, - "description": "The Media resource represents a piece of media, such as an image, that is associated with a message.", - "get": { - "description": "Fetch a single media instance belonging to the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Message resource that this Media resource belongs to.", - "in": "path", - "name": "MessageSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Media resource to fetch", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallDelay": { + "description": "The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`.", + "type": "integer" + }, + "Extension": { + "description": "The digits to dial after connecting the verification call.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.", + "type": "string" + }, + "PhoneNumber": { + "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information about the verification process to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + } + }, + "required": [ + "PhoneNumber" + ], + "type": "object" + } } } - ], + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.message.media" + "$ref": "#/components/schemas/api.v2010.account.validation_request" } } - } + }, + "description": "Created" } }, "security": [ @@ -18882,17 +18129,17 @@ ], "x-default-output-properties": [ "sid", - "parent_sid", - "content_type" + "phone_number", + "friendly_name" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json": { + "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json": { "delete": { - "description": "Deletes a message record from your account", + "description": "Delete the caller-id specified from the account", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -18904,14 +18151,14 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Message resource to delete.", + "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } } @@ -18930,12 +18177,12 @@ "GA" ] }, - "description": "A Message resource represents an inbound or outbound message.", + "description": "An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb.", "get": { - "description": "Fetch a message belonging to the account used to make the request", + "description": "Fetch an outgoing-caller-id belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -18947,14 +18194,14 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Message resource to fetch.", + "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } } @@ -18964,10 +18211,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.message" + "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" } } - } + }, + "description": "OK" } }, "security": [ @@ -18980,10 +18228,10 @@ ] }, "post": { - "description": "To redact a message-body from a post-flight message record, post to the message instance resource with an empty body", + "description": "Updates the caller-id", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to update.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to update.", "in": "path", "name": "AccountSid", "required": true, @@ -18995,36 +18243,43 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Message resource to update.", + "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^(SM|MM)[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The text of the message you want to send. Can be up to 1,600 characters long.", - "in": "query", - "name": "Body", - "required": true, - "schema": { + "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } } ], - "responses": { - "202": { - "content": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.message" + "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" } } - } + }, + "description": "OK" } }, "security": [ @@ -19043,21 +18298,18 @@ ], "x-default-output-properties": [ "sid", - "from", - "to", - "status", - "direction", - "date_sent" + "phone_number", + "friendly_name" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Notifications.json": { - "description": "[DEPRECATED] Log entries", + "/2010-04-01/Accounts/{AccountSid}/Queues.json": { + "description": "Queues of calls", "get": { - "description": "Retrieve a list of notifications belonging to the account used to make the request", + "description": "Retrieve a list of queues belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -19068,45 +18320,6 @@ "type": "string" } }, - { - "description": "Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.", - "in": "query", - "name": "Log", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate<", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date.", - "in": "query", - "name": "MessageDate>", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -19135,12 +18348,6 @@ "format": "uri", "type": "string" }, - "notifications": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.notification" - }, - "type": "array" - }, "page": { "type": "integer" }, @@ -19151,6 +18358,12 @@ "format": "uri", "type": "string" }, + "queues": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.queue" + }, + "type": "array" + }, "start": { "type": "integer" }, @@ -19162,7 +18375,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -19174,26 +18388,11 @@ "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "call_sid", - "error_code", - "message_date" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json": { - "description": "[DEPRECATED] Log entries", - "get": { - "description": "Fetch a notification belonging to the account used to make the request", + "post": { + "description": "Create a queue", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", "in": "path", "name": "AccountSid", "required": true, @@ -19203,29 +18402,40 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Notification resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^NO[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long.", + "type": "string" + }, + "MaxSize": { + "description": "The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000.", + "type": "integer" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.notification|instance" + "$ref": "#/components/schemas/api.v2010.account.queue" } } - } + }, + "description": "Created" } }, "security": [ @@ -19244,19 +18454,19 @@ ], "x-default-output-properties": [ "sid", - "call_sid", - "error_code", - "message_date" + "friendly_name", + "current_size", + "average_wait_time" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json": { - "description": "An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb.", + "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json": { + "description": "Calls in a call queue", "get": { - "description": "Retrieve a list of outgoing-caller-ids belonging to the account used to make the request", + "description": "Retrieve the members of the queue", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to read.", "in": "path", "name": "AccountSid", "required": true, @@ -19268,20 +18478,14 @@ } }, { - "description": "The phone number of the OutgoingCallerId resources to read.", - "in": "query", - "name": "PhoneNumber", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The string that identifies the OutgoingCallerId resources to read.", - "in": "query", - "name": "FriendlyName", - "required": false, + "description": "The SID of the Queue in which to find the members", + "in": "path", + "name": "QueueSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^QU[0-9a-fA-F]{32}$", "type": "string" } }, @@ -19313,12 +18517,6 @@ "format": "uri", "type": "string" }, - "outgoing_caller_ids": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" - }, - "type": "array" - }, "page": { "type": "integer" }, @@ -19329,6 +18527,12 @@ "format": "uri", "type": "string" }, + "queue_members": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.queue.member" + }, + "type": "array" + }, "start": { "type": "integer" }, @@ -19340,7 +18544,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -19352,11 +18557,26 @@ "GA" ] }, - "post": { - "description": "", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "call_sid", + "date_enqueued", + "position", + "wait_time" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json": { + "description": "Calls in a call queue", + "get": { + "description": "Fetch a specific member from the queue", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for the new caller ID resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -19368,84 +18588,37 @@ } }, { - "description": "The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", - "in": "query", - "name": "PhoneNumber", + "description": "The SID of the Queue in which to find the members to fetch.", + "in": "path", + "name": "QueueSid", "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^QU[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`.", - "in": "query", - "name": "CallDelay", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The digits to dial after connecting the verification call.", - "in": "query", - "name": "Extension", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information about the verification process to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to fetch.", + "in": "path", + "name": "CallSid", + "required": true, "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], "type": "string" } } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.validation_request" + "$ref": "#/components/schemas/api.v2010.account.queue.member" } } - } + }, + "description": "OK" } }, "security": [ @@ -19457,24 +18630,11 @@ "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "phone_number", - "friendly_name" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json": { - "delete": { - "description": "Delete the caller-id specified from the account", + "post": { + "description": "Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to update.", "in": "path", "name": "AccountSid", "required": true, @@ -19486,14 +18646,123 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete.", + "description": "The SID of the Queue in which to find the members to update.", + "in": "path", + "name": "QueueSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^QU[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update.", + "in": "path", + "name": "CallSid", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Method": { + "description": "How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Url": { + "description": "The absolute URL of the Queue resource.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "Url" + ], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.queue.member" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "call_sid", + "date_enqueued", + "position", + "wait_time" + ], + "x-path-type": "instance" + }, + "/2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json": { + "delete": { + "description": "Remove an empty queue", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to delete.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Queue resource to delete", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", + "pattern": "^QU[0-9a-fA-F]{32}$", "type": "string" } } @@ -19512,12 +18781,12 @@ "GA" ] }, - "description": "An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb.", + "description": "Queues of calls", "get": { - "description": "Fetch an outgoing-caller-id belonging to the account used to make the request", + "description": "Fetch an instance of a queue identified by the QueueSid", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -19529,14 +18798,14 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch.", + "description": "The Twilio-provided string that uniquely identifies the Queue resource to fetch", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", + "pattern": "^QU[0-9a-fA-F]{32}$", "type": "string" } } @@ -19546,10 +18815,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + "$ref": "#/components/schemas/api.v2010.account.queue" } } - } + }, + "description": "OK" } }, "security": [ @@ -19562,10 +18832,10 @@ ] }, "post": { - "description": "Updates the caller-id", + "description": "Update the queue with the new parameters", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to update.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to update.", "in": "path", "name": "AccountSid", "required": true, @@ -19577,36 +18847,47 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update.", + "description": "The Twilio-provided string that uniquely identifies the Queue resource to update", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { + "pattern": "^QU[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long.", + "type": "string" + }, + "MaxSize": { + "description": "The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.outgoing_caller_id" + "$ref": "#/components/schemas/api.v2010.account.queue" } } - } + }, + "description": "OK" } }, "security": [ @@ -19625,18 +18906,19 @@ ], "x-default-output-properties": [ "sid", - "phone_number", - "friendly_name" + "friendly_name", + "current_size", + "average_wait_time" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Queues.json": { - "description": "Queues of calls", + "/2010-04-01/Accounts/{AccountSid}/Recordings.json": { + "description": "Recordings of phone calls", "get": { - "description": "Retrieve a list of queues belonging to the account used to make the request", + "description": "Retrieve a list of recordings belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -19647,6 +18929,55 @@ "type": "string" } }, + { + "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", + "in": "query", + "name": "DateCreated", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", + "in": "query", + "name": "DateCreated<", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", + "in": "query", + "name": "DateCreated>", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read.", + "in": "query", + "name": "CallSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Conference SID that identifies the conference associated with the recording to read.", + "in": "query", + "name": "ConferenceSid", + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CF[0-9a-fA-F]{32}$", + "type": "string" + } + }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -19685,9 +19016,9 @@ "format": "uri", "type": "string" }, - "queues": { + "recordings": { "items": { - "$ref": "#/components/schemas/api.v2010.account.queue" + "$ref": "#/components/schemas/api.v2010.account.recording" }, "type": "array" }, @@ -19702,61 +19033,8 @@ "type": "object" } } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "Create a queue", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000.", - "in": "query", - "name": "MaxSize", - "required": false, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue" - } - } - } + }, + "description": "OK" } }, "security": [ @@ -19775,19 +19053,20 @@ ], "x-default-output-properties": [ "sid", - "friendly_name", - "current_size", - "average_wait_time" + "call_sid", + "status", + "start_time", + "duration" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json": { - "description": "Calls in a call queue", + "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json": { + "description": "References to text transcriptions of call recordings", "get": { - "description": "Retrieve the members of the queue", + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -19799,14 +19078,14 @@ } }, { - "description": "The SID of the Queue in which to find the members", + "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcriptions to read.", "in": "path", - "name": "QueueSid", + "name": "RecordingSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } }, @@ -19848,15 +19127,15 @@ "format": "uri", "type": "string" }, - "queue_members": { + "start": { + "type": "integer" + }, + "transcriptions": { "items": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" }, "type": "array" }, - "start": { - "type": "integer" - }, "uri": { "format": "uri", "type": "string" @@ -19865,7 +19144,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -19883,20 +19163,19 @@ } ], "x-default-output-properties": [ - "call_sid", - "date_enqueued", - "position", - "wait_time" + "sid", + "type", + "status", + "duration" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json": { - "description": "Calls in a call queue", - "get": { - "description": "Fetch a specific member from the queue", + "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { + "delete": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -19908,36 +19187,33 @@ } }, { - "description": "The SID of the Queue in which to find the members to fetch.", + "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to delete.", "in": "path", - "name": "QueueSid", + "name": "RecordingSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to fetch.", + "description": "The Twilio-provided string that uniquely identifies the Transcription resource to delete.", "in": "path", - "name": "CallSid", + "name": "Sid", "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" - } - } - } + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -19949,11 +19225,12 @@ "GA" ] }, - "post": { - "description": "Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL", + "description": "References to text transcriptions of call recordings", + "get": { + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to update.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -19965,56 +19242,26 @@ } }, { - "description": "The SID of the Queue in which to find the members to update.", + "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to fetch.", "in": "path", - "name": "QueueSid", + "name": "RecordingSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update.", + "description": "The Twilio-provided string that uniquely identifies the Transcription resource to fetch.", "in": "path", - "name": "CallSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The absolute URL of the Queue resource.", - "in": "query", - "name": "Url", + "name": "Sid", "required": true, "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters.", - "in": "query", - "name": "Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } } @@ -20024,10 +19271,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue.member" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" } } - } + }, + "description": "OK" } }, "security": [ @@ -20045,19 +19293,20 @@ } ], "x-default-output-properties": [ - "call_sid", - "date_enqueued", - "position", - "wait_time" + "sid", + "type", + "status", + "duration" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json": { - "delete": { - "description": "Remove an empty queue", + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { + "description": "The results of an Add-on API call", + "get": { + "description": "Retrieve a list of results belonging to the recording", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -20069,58 +19318,25 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Queue resource to delete", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Queues of calls", - "get": { - "description": "Fetch an instance of a queue identified by the QueueSid", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to fetch.", + "description": "The SID of the recording to which the result to read belongs.", "in": "path", - "name": "AccountSid", + "name": "ReferenceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The Twilio-provided string that uniquely identifies the Queue resource to fetch", - "in": "path", - "name": "Sid", - "required": true, + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } } ], @@ -20129,10 +19345,47 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue" + "properties": { + "add_on_results": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" + }, + "type": "array" + }, + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + } + }, + "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -20144,11 +19397,26 @@ "GA" ] }, - "post": { - "description": "Update the queue with the new parameters", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "status", + "add_on_sid", + "date_created" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { + "description": "A single Add-on results' payload", + "get": { + "description": "Retrieve a list of payloads belonging to the AddOnResult", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to update.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -20160,147 +19428,36 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Queue resource to update", + "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.", "in": "path", - "name": "Sid", + "name": "ReferenceSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^QU[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, + "description": "The SID of the AddOnResult to which the payloads to read belongs.", + "in": "path", + "name": "AddOnResultSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XR[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "MaxSize", - "required": false, + "name": "PageSize", "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.queue" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "current_size", - "average_wait_time" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings.json": { - "description": "Recordings of phone calls", - "get": { - "description": "Retrieve a list of recordings belonging to the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", - "in": "query", - "name": "DateCreated<", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.", - "in": "query", - "name": "DateCreated>", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read.", - "in": "query", - "name": "CallSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Conference SID that identifies the conference associated with the recording to read.", - "in": "query", - "name": "ConferenceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, + "maximum": 1000, + "minimum": 1, "type": "integer" } } @@ -20328,16 +19485,16 @@ "page_size": { "type": "integer" }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "recordings": { + "payloads": { "items": { - "$ref": "#/components/schemas/api.v2010.account.recording" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" }, "type": "array" }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, "start": { "type": "integer" }, @@ -20349,7 +19506,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -20368,20 +19526,17 @@ ], "x-default-output-properties": [ "sid", - "call_sid", - "status", - "start_time", - "duration" + "label", + "content_type" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json": { - "description": "References to text transcriptions of call recordings", - "get": { - "description": "", + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { + "delete": { + "description": "Delete a payload from the result along with all associated Data", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -20393,9 +19548,9 @@ } }, { - "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcriptions to read.", + "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.", "in": "path", - "name": "RecordingSid", + "name": "ReferenceSid", "required": true, "schema": { "maxLength": 34, @@ -20405,122 +19560,26 @@ } }, { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "transcriptions": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" - }, - "type": "array" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json": { - "delete": { - "description": "", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to delete.", + "description": "The SID of the AddOnResult to which the payloads to delete belongs.", "in": "path", - "name": "RecordingSid", + "name": "AddOnResultSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", + "pattern": "^XR[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to delete.", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", + "pattern": "^XH[0-9a-fA-F]{32}$", "type": "string" } } @@ -20539,12 +19598,12 @@ "GA" ] }, - "description": "References to text transcriptions of call recordings", + "description": "A single Add-on results' payload", "get": { - "description": "", + "description": "Fetch an instance of a result payload", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -20556,9 +19615,9 @@ } }, { - "description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to fetch.", + "description": "The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.", "in": "path", - "name": "RecordingSid", + "name": "ReferenceSid", "required": true, "schema": { "maxLength": 34, @@ -20568,27 +19627,40 @@ } }, { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to fetch.", + "description": "The SID of the AddOnResult to which the payload to fetch belongs.", "in": "path", - "name": "Sid", + "name": "AddOnResultSid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", + "pattern": "^XR[0-9a-fA-F]{32}$", "type": "string" } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_transcription" + }, + { + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^XH[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" } } - } + }, + "description": "OK" } }, "security": [ @@ -20607,19 +19679,17 @@ ], "x-default-output-properties": [ "sid", - "type", - "status", - "duration" + "label", + "content_type" ], "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json": { - "description": "The results of an Add-on API call", - "get": { - "description": "Retrieve a list of results belonging to the recording", + "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { + "delete": { + "description": "Delete a result and purge all associated Payloads", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -20631,7 +19701,7 @@ } }, { - "description": "The SID of the recording to which the result to read belongs.", + "description": "The SID of the recording to which the result to delete belongs.", "in": "path", "name": "ReferenceSid", "required": true, @@ -20643,61 +19713,21 @@ } }, { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" + "maxLength": 34, + "minLength": 34, + "pattern": "^XR[0-9a-fA-F]{32}$", + "type": "string" } } ], "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "add_on_results": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" - }, - "type": "array" - }, - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -20709,26 +19739,12 @@ "GA" ] }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "status", - "add_on_sid", - "date_created" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json": { - "description": "A single Add-on results' payload", + "description": "The results of an Add-on API call", "get": { - "description": "Retrieve a list of payloads belonging to the AddOnResult", + "description": "Fetch an instance of an AddOnResult", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -20740,7 +19756,7 @@ } }, { - "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.", + "description": "The SID of the recording to which the result to fetch belongs.", "in": "path", "name": "ReferenceSid", "required": true, @@ -20752,9 +19768,9 @@ } }, { - "description": "The SID of the AddOnResult to which the payloads to read belongs.", + "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.", "in": "path", - "name": "AddOnResultSid", + "name": "Sid", "required": true, "schema": { "maxLength": 34, @@ -20762,16 +19778,6 @@ "pattern": "^XR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } } ], "responses": { @@ -20779,46 +19785,11 @@ "content": { "application/json": { "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "payloads": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" - }, - "type": "array" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" } } - } + }, + "description": "OK" } }, "security": [ @@ -20837,17 +19808,18 @@ ], "x-default-output-properties": [ "sid", - "label", - "content_type" + "status", + "add_on_sid", + "date_created" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json": { + "/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json": { "delete": { - "description": "Delete a payload from the result along with all associated Data", + "description": "Delete a recording from your account", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to delete.", "in": "path", "name": "AccountSid", "required": true, @@ -20859,38 +19831,14 @@ } }, { - "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the AddOnResult to which the payloads to delete belongs.", - "in": "path", - "name": "AddOnResultSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.", + "description": "The Twilio-provided string that uniquely identifies the Recording resource to delete.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^XH[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } } @@ -20909,12 +19857,12 @@ "GA" ] }, - "description": "A single Add-on results' payload", + "description": "Recordings of phone calls", "get": { - "description": "Fetch an instance of a result payload", + "description": "Fetch an instance of a recording", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch.", "in": "path", "name": "AccountSid", "required": true, @@ -20926,38 +19874,14 @@ } }, { - "description": "The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the AddOnResult to which the payload to fetch belongs.", - "in": "path", - "name": "AddOnResultSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.", + "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch.", "in": "path", "name": "Sid", "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^XH[0-9a-fA-F]{32}$", + "pattern": "^RE[0-9a-fA-F]{32}$", "type": "string" } } @@ -20967,243 +19891,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload" + "$ref": "#/components/schemas/api.v2010.account.recording" } } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "label", - "content_type" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json": { - "delete": { - "description": "Delete a result and purge all associated Payloads", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the result to delete belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "The results of an Add-on API call", - "get": { - "description": "Fetch an instance of an AddOnResult", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the recording to which the result to fetch belongs.", - "in": "path", - "name": "ReferenceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording.recording_add_on_result" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "status", - "add_on_sid", - "date_created" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json": { - "delete": { - "description": "Delete a recording from your account", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Recordings of phone calls", - "get": { - "description": "Fetch an instance of a recording", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Recording resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RE[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.recording" - } - } - } + }, + "description": "OK" } }, "security": [ @@ -21301,7 +19993,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -21327,17 +20020,26 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A human readable descriptive text that describes the CredentialList, up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable descriptive text that describes the CredentialList, up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -21346,7 +20048,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" } } - } + }, + "description": "Created" } }, "security": [ @@ -21453,7 +20156,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -21491,26 +20195,31 @@ "pattern": "^CL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long.", - "in": "query", - "name": "Username", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)", - "in": "query", - "name": "Password", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Password": { + "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)", + "type": "string" + }, + "Username": { + "description": "The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long.", + "type": "string" + } + }, + "required": [ + "Username", + "Password" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -21519,7 +20228,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" } } - } + }, + "description": "Created" } }, "security": [ @@ -21647,7 +20357,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -21697,17 +20408,23 @@ "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)", - "in": "query", - "name": "Password", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Password": { + "description": "The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`)", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -21716,7 +20433,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -21820,7 +20538,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -21858,17 +20577,26 @@ "pattern": "^CL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A human readable descriptive text for a CredentialList, up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable descriptive text for a CredentialList, up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -21877,7 +20605,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_credential_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -21972,7 +20701,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -21998,152 +20728,111 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\".", - "in": "query", - "name": "DomainName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should when the domain receives a call.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call to pass status parameters (such as call ended) to your application.", - "in": "query", - "name": "VoiceStatusCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.", - "in": "query", - "name": "SipRegistration", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.", - "in": "query", - "name": "EmergencyCallingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.", - "in": "query", - "name": "Secure", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DomainName": { + "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\".", + "type": "string" + }, + "EmergencyCallingEnabled": { + "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Secure": { + "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.", + "type": "boolean" + }, + "SipRegistration": { + "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceStatusCallbackMethod": { + "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceStatusCallbackUrl": { + "description": "The URL that we should call to pass status parameters (such as call ended) to your application.", + "format": "uri", + "type": "string" + }, + "VoiceUrl": { + "description": "The URL we should when the domain receives a call.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "DomainName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -22152,7 +20841,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" } } - } + }, + "description": "Created" } }, "security": [ @@ -22260,7 +20950,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -22298,20 +20989,29 @@ "pattern": "^SD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the CredentialList resource to map to the SIP domain.", - "in": "query", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CredentialListSid": { + "description": "The SID of the CredentialList resource to map to the SIP domain.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "CredentialListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -22320,7 +21020,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" } } - } + }, + "description": "Created" } }, "security": [ @@ -22447,7 +21148,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping" } } - } + }, + "description": "OK" } }, "security": [ @@ -22554,7 +21256,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -22592,20 +21295,29 @@ "pattern": "^SD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the IpAccessControlList resource to map to the SIP domain.", - "in": "query", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "IpAccessControlListSid": { + "description": "The SID of the IpAccessControlList resource to map to the SIP domain.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "IpAccessControlListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -22614,7 +21326,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" } } - } + }, + "description": "Created" } }, "security": [ @@ -22741,7 +21454,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping" } } - } + }, + "description": "OK" } }, "security": [ @@ -22848,7 +21562,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -22886,20 +21601,29 @@ "pattern": "^SD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the CredentialList resource to map to the SIP domain.", - "in": "query", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CredentialListSid": { + "description": "The SID of the CredentialList resource to map to the SIP domain.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "CredentialListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -22908,7 +21632,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" } } - } + }, + "description": "Created" } }, "security": [ @@ -23035,7 +21760,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping" } } - } + }, + "description": "OK" } }, "security": [ @@ -23142,7 +21868,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -23180,20 +21907,29 @@ "pattern": "^SD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain.", - "in": "query", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CredentialListSid": { + "description": "A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "CredentialListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -23202,7 +21938,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" } } - } + }, + "description": "Created" } }, "security": [ @@ -23329,7 +22066,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping" } } - } + }, + "description": "OK" } }, "security": [ @@ -23436,7 +22174,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -23474,20 +22213,29 @@ "pattern": "^SD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The unique id of the IP access control list to map to the SIP domain.", - "in": "query", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "IpAccessControlListSid": { + "description": "The unique id of the IP access control list to map to the SIP domain.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "IpAccessControlListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -23496,7 +22244,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" } } - } + }, + "description": "Created" } }, "security": [ @@ -23623,7 +22372,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping" } } - } + }, + "description": "OK" } }, "security": [ @@ -23726,7 +22476,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" } } - } + }, + "description": "OK" } }, "security": [ @@ -23764,152 +22515,108 @@ "pattern": "^SD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_url`", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call to pass status parameters (such as call ended) to your application.", - "in": "query", - "name": "VoiceStatusCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call when the domain receives a call.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.", - "in": "query", - "name": "SipRegistration", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\".", - "in": "query", - "name": "DomainName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.", - "in": "query", - "name": "EmergencyCallingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.", - "in": "query", - "name": "Secure", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DomainName": { + "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and \"-\".", + "type": "string" + }, + "EmergencyCallingEnabled": { + "description": "Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Secure": { + "description": "Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain.", + "type": "boolean" + }, + "SipRegistration": { + "description": "Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not.", + "type": "boolean" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method we should use to call `voice_url`", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceStatusCallbackMethod": { + "description": "The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceStatusCallbackUrl": { + "description": "The URL that we should call to pass status parameters (such as call ended) to your application.", + "format": "uri", + "type": "string" + }, + "VoiceUrl": { + "description": "The URL we should call when the domain receives a call.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -23918,7 +22625,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_domain" } } - } + }, + "description": "OK" } }, "security": [ @@ -24014,7 +22722,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -24040,17 +22749,26 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A human readable descriptive text that describes the IpAccessControlList, up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable descriptive text that describes the IpAccessControlList, up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -24059,7 +22777,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" } } - } + }, + "description": "Created" } }, "security": [ @@ -24166,7 +22885,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -24204,35 +22924,35 @@ "pattern": "^AL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", - "in": "query", - "name": "IpAddress", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", - "in": "query", - "name": "CidrPrefixLength", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CidrPrefixLength": { + "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", + "type": "integer" + }, + "FriendlyName": { + "description": "A human readable descriptive text for this resource, up to 64 characters long.", + "type": "string" + }, + "IpAddress": { + "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", + "type": "string" + } + }, + "required": [ + "FriendlyName", + "IpAddress" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -24241,7 +22961,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" } } - } + }, + "description": "Created" } }, "security": [ @@ -24369,7 +23090,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" } } - } + }, + "description": "OK" } }, "security": [ @@ -24419,35 +23141,31 @@ "pattern": "^IP[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", - "in": "query", - "name": "IpAddress", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A human readable descriptive text for this resource, up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", - "in": "query", - "name": "CidrPrefixLength", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CidrPrefixLength": { + "description": "An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used.", + "type": "integer" + }, + "FriendlyName": { + "description": "A human readable descriptive text for this resource, up to 64 characters long.", + "type": "string" + }, + "IpAddress": { + "description": "An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -24456,7 +23174,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address" } } - } + }, + "description": "OK" } }, "security": [ @@ -24560,7 +23279,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -24598,17 +23318,26 @@ "pattern": "^AL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A human readable descriptive text, up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable descriptive text, up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -24617,7 +23346,8 @@ "$ref": "#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -24661,7 +23391,6 @@ "description": "The string that identifies the ShortCode resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -24670,7 +23399,6 @@ "description": "Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.", "in": "query", "name": "ShortCode", - "required": false, "schema": { "type": "string" } @@ -24730,7 +23458,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -24792,7 +23521,8 @@ "$ref": "#/components/schemas/api.v2010.account.short_code" } } - } + }, + "description": "OK" } }, "security": [ @@ -24830,92 +23560,73 @@ "pattern": "^SC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`.", - "in": "query", - "name": "ApiVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call when receiving an incoming SMS message to this short code.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiVersion": { + "description": "The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code.", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call when receiving an incoming SMS message to this short code.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -24924,7 +23635,8 @@ "$ref": "#/components/schemas/api.v2010.account.short_code" } } - } + }, + "description": "OK" } }, "security": [ @@ -25020,7 +23732,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -25046,17 +23759,23 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -25065,7 +23784,8 @@ "$ref": "#/components/schemas/api.v2010.account.new_signing_key" } } - } + }, + "description": "Created" } }, "security": [ @@ -25169,7 +23889,8 @@ "$ref": "#/components/schemas/api.v2010.account.signing_key" } } - } + }, + "description": "OK" } }, "security": [ @@ -25207,17 +23928,23 @@ "pattern": "^SK[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -25226,7 +23953,8 @@ "$ref": "#/components/schemas/api.v2010.account.signing_key" } } - } + }, + "description": "OK" } }, "security": [ @@ -25265,121 +23993,33 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours).", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } } ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.token" - } + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Ttl": { + "description": "The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours).", + "type": "integer" + } + }, + "type": "object" } } } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "username", - "ice_servers" - ], - "x-path-type": "list" - }, - "/2010-04-01/Accounts/{AccountSid}/Transcriptions.json": { - "description": "Text transcriptions of call recordings", - "get": { - "description": "Retrieve a list of transcriptions belonging to the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "properties": { - "end": { - "type": "integer" - }, - "first_page_uri": { - "format": "uri", - "type": "string" - }, - "next_page_uri": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_uri": { - "format": "uri", - "type": "string" - }, - "start": { - "type": "integer" - }, - "transcriptions": { - "items": { - "$ref": "#/components/schemas/api.v2010.account.transcription" - }, - "type": "array" - }, - "uri": { - "format": "uri", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/api.v2010.account.token" } } - } + }, + "description": "Created" } }, "security": [ @@ -25397,420 +24037,28 @@ } ], "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" + "username", + "ice_servers" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json": { - "delete": { - "description": "Delete a transcription from the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to delete.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "Text transcriptions of call recordings", - "get": { - "description": "Fetch an instance of a Transcription", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Twilio-provided string that uniquely identifies the Transcription resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/api.v2010.account.transcription" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://api.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "type", - "status", - "duration" - ], - "x-path-type": "instance" - }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records.json": { - "description": "Twilio account usage records", - "get": { - "description": "Retrieve a list of usage-records belonging to the account used to make the request", - "parameters": [ - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", - "in": "path", - "name": "AccountSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", - "in": "query", - "name": "Category", - "required": false, - "schema": { - "enum": [ - "agent-conference", - "answering-machine-detection", - "authy-authentications", - "authy-calls-outbound", - "authy-monthly-fees", - "authy-phone-intelligence", - "authy-phone-verifications", - "authy-sms-outbound", - "call-progess-events", - "calleridlookups", - "calls", - "calls-client", - "calls-globalconference", - "calls-inbound", - "calls-inbound-local", - "calls-inbound-mobile", - "calls-inbound-tollfree", - "calls-outbound", - "calls-pay-verb-transactions", - "calls-recordings", - "calls-sip", - "calls-sip-inbound", - "calls-sip-outbound", - "carrier-lookups", - "conversations", - "conversations-api-requests", - "conversations-conversation-events", - "conversations-endpoint-connectivity", - "conversations-events", - "conversations-participant-events", - "conversations-participants", - "cps", - "fraud-lookups", - "group-rooms", - "group-rooms-data-track", - "group-rooms-encrypted-media-recorded", - "group-rooms-media-downloaded", - "group-rooms-media-recorded", - "group-rooms-media-routed", - "group-rooms-media-stored", - "group-rooms-participant-minutes", - "group-rooms-recorded-minutes", - "ip-messaging", - "ip-messaging-commands", - "ip-messaging-data-storage", - "ip-messaging-data-transfer", - "ip-messaging-endpoint-connectivity", - "lookups", - "marketplace", - "marketplace-algorithmia-named-entity-recognition", - "marketplace-digital-segment-business-info", - "marketplace-google-speech-to-text", - "marketplace-ibm-watson-message-insights", - "marketplace-ibm-watson-message-sentiment", - "marketplace-ibm-watson-recording-analysis", - "marketplace-icehook-systems-scout", - "marketplace-infogroup-dataaxle-bizinfo", - "marketplace-cadence-transcription", - "marketplace-cadence-translation", - "marketplace-capio-speech-to-text", - "marketplace-facebook-offline-conversions", - "marketplace-keen-io-contact-center-analytics", - "marketplace-marchex-cleancall", - "marketplace-marchex-sentiment-analysis-for-sms", - "marketplace-marketplace-nextcaller-social-id", - "marketplace-mobile-commons-opt-out-classifier", - "marketplace-nexiwave-voicemail-to-text", - "marketplace-nextcaller-advanced-caller-identification", - "marketplace-nomorobo-spam-score", - "marketplace-payfone-tcpa-compliance", - "marketplace-telo-opencnam", - "marketplace-truecnam-true-spam", - "marketplace-twilio-caller-name-lookup-us", - "marketplace-twilio-carrier-information-lookup", - "marketplace-voicebase-pci", - "marketplace-voicebase-transcription", - "marketplace-whitepages-pro-caller-identification", - "marketplace-whitepages-pro-phone-intelligence", - "marketplace-whitepages-pro-phone-reputation", - "marketplace-wolfram-short-answer", - "marketplace-wolfarm-spoken-results", - "marketplace-deepgram-phrase-detector", - "marketplace-convriza-ababa", - "marketplace-ibm-watson-tone-analyzer", - "marketplace-remeeting-automatic-speech-recognition", - "marketplace-tcpa-defense-solutions-blacklist-feed", - "marketplace-voicebase-transcription-custom-vocabulary", - "marketplace-ytica-contact-center-reporting-analytics", - "mediastorage", - "mms", - "mms-inbound", - "mms-inbound-longcode", - "mms-inbound-shortcode", - "mms-messages-carrierfees", - "mms-outbound", - "mms-outbound-longcode", - "mms-outbound-shortcode", - "monitor-reads", - "monitor-storage", - "monitor-writes", - "notify", - "notify-actions-attempts", - "notify-channels", - "number-format-lookups", - "pchat", - "pchat-actions", - "pchat-aps", - "pchat-notifications", - "pchat-reads", - "pchat-users", - "pchat-messages", - "peer-to-peer-rooms-participant-minutes", - "pfax", - "pfax-minutes", - "pfax-minutes-inbound", - "pfax-minutes-outbound", - "pfax-pages", - "phonenumbers", - "phonenumbers-cps", - "phonenumbers-emergency", - "phonenumbers-local", - "phonenumbers-mobile", - "phonenumbers-setups", - "phonenumbers-tollfree", - "premiumsupport", - "proxy", - "proxy-active-sessions", - "pv", - "pv-composition-media-downloaded", - "pv-composition-media-encrypted", - "pv-composition-media-stored", - "pv-composition-minutes", - "pv-recording-compositions", - "pv-room-participants", - "pv-room-participants-au1", - "pv-room-participants-br1", - "pv-room-participants-ie1", - "pv-room-participants-jp1", - "pv-room-participants-sg1", - "pv-room-participants-us1", - "pv-room-participants-us2", - "pv-rooms", - "pv-sip-endpoint-registrations", - "recordings", - "recordingstorage", - "rooms-group-minutes", - "rooms-group-bandwidth", - "rooms-peer-to-peer-minutes", - "shortcodes", - "shortcodes-customerowned", - "shortcodes-mms-enablement", - "shortcodes-mps", - "shortcodes-random", - "shortcodes-uk", - "shortcodes-vanity", - "small-group-rooms", - "small-group-rooms-data-track", - "small-group-rooms-participant-minutes", - "sms", - "sms-inbound", - "sms-inbound-longcode", - "sms-inbound-shortcode", - "sms-messages-carrierfees", - "sms-messages-features", - "sms-messages-features-senderid", - "sms-outbound", - "sms-outbound-content-inspection", - "sms-outbound-longcode", - "sms-outbound-shortcode", - "speech-recognition", - "studio-engagements", - "sync", - "sync-actions", - "sync-endpoint-hours", - "sync-endpoint-hours-above-daily-cap", - "taskrouter-tasks", - "totalprice", - "transcriptions", - "trunking-cps", - "trunking-emergency-calls", - "trunking-origination", - "trunking-origination-local", - "trunking-origination-mobile", - "trunking-origination-tollfree", - "trunking-recordings", - "trunking-secure", - "trunking-termination", - "turnmegabytes", - "turnmegabytes-australia", - "turnmegabytes-brasil", - "turnmegabytes-germany", - "turnmegabytes-india", - "turnmegabytes-ireland", - "turnmegabytes-japan", - "turnmegabytes-singapore", - "turnmegabytes-useast", - "turnmegabytes-uswest", - "twilio-interconnect", - "video-recordings", - "voice-insights", - "voice-insights-client-insights-on-demand-minute", - "voice-insights-ptsn-insights-on-demand-minute", - "voice-insights-sip-interface-insights-on-demand-minute", - "voice-insights-sip-trunking-insights-on-demand-minute", - "wireless", - "wireless-orders", - "wireless-orders-artwork", - "wireless-orders-bulk", - "wireless-orders-esim", - "wireless-orders-starter", - "wireless-usage", - "wireless-usage-commands", - "wireless-usage-commands-africa", - "wireless-usage-commands-asia", - "wireless-usage-commands-centralandsouthamerica", - "wireless-usage-commands-europe", - "wireless-usage-commands-home", - "wireless-usage-commands-northamerica", - "wireless-usage-commands-oceania", - "wireless-usage-commands-roaming", - "wireless-usage-data", - "wireless-usage-data-africa", - "wireless-usage-data-asia", - "wireless-usage-data-centralandsouthamerica", - "wireless-usage-data-custom-additionalmb", - "wireless-usage-data-custom-first5mb", - "wireless-usage-data-domestic-roaming", - "wireless-usage-data-europe", - "wireless-usage-data-individual-additionalgb", - "wireless-usage-data-individual-firstgb", - "wireless-usage-data-international-roaming-canada", - "wireless-usage-data-international-roaming-india", - "wireless-usage-data-international-roaming-mexico", - "wireless-usage-data-northamerica", - "wireless-usage-data-oceania", - "wireless-usage-data-pooled", - "wireless-usage-data-pooled-downlink", - "wireless-usage-data-pooled-uplink", - "wireless-usage-mrc", - "wireless-usage-mrc-custom", - "wireless-usage-mrc-individual", - "wireless-usage-mrc-pooled", - "wireless-usage-mrc-suspended", - "wireless-usage-voice", - "wireless-usage-sms" - ], - "type": "string" - } - }, - { - "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", - "in": "query", - "name": "StartDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, + "/2010-04-01/Accounts/{AccountSid}/Transcriptions.json": { + "description": "Text transcriptions of call recordings", + "get": { + "description": "Retrieve a list of transcriptions belonging to the account used to make the request", + "parameters": [ { - "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", - "in": "query", - "name": "EndDate", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "format": "date-time", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, - { - "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", - "in": "query", - "name": "IncludeSubaccounts", - "required": false, - "schema": { - "type": "boolean" - } - }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -25852,21 +24100,22 @@ "start": { "type": "integer" }, - "uri": { - "format": "uri", - "type": "string" - }, - "usage_records": { + "transcriptions": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" + "$ref": "#/components/schemas/api.v2010.account.transcription" }, "type": "array" + }, + "uri": { + "format": "uri", + "type": "string" } }, "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -25884,18 +24133,123 @@ } ], "x-default-output-properties": [ - "category", - "start_date", - "end_date", - "count", - "count_unit" + "sid", + "type", + "status", + "duration" ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json": { - "description": "Usage records for all time", + "/2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json": { + "delete": { + "description": "Delete a transcription from the account used to make the request", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Transcription resource to delete.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "Text transcriptions of call recordings", "get": { - "description": "", + "description": "Fetch an instance of a Transcription", + "parameters": [ + { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch.", + "in": "path", + "name": "AccountSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The Twilio-provided string that uniquely identifies the Transcription resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^TR[0-9a-fA-F]{32}$", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/api.v2010.account.transcription" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "type", + "status", + "duration" + ], + "x-path-type": "instance" + }, + "/2010-04-01/Accounts/{AccountSid}/Usage/Records.json": { + "description": "Twilio account usage records", + "get": { + "description": "Retrieve a list of usage-records belonging to the account used to make the request", "parameters": [ { "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", @@ -25913,7 +24267,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -26169,7 +24522,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -26179,7 +24531,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -26189,7 +24540,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -26241,7 +24591,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record" }, "type": "array" } @@ -26249,7 +24599,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -26275,8 +24626,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json": { - "description": "Usage records summarized by day", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json": { + "description": "Usage records for all time", "get": { "description": "", "parameters": [ @@ -26296,7 +24647,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -26552,7 +24902,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -26562,7 +24911,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -26572,7 +24920,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -26624,7 +24971,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time" }, "type": "array" } @@ -26632,7 +24979,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -26658,8 +25006,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json": { - "description": "Usage records for last month", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json": { + "description": "Usage records summarized by day", "get": { "description": "", "parameters": [ @@ -26679,7 +25027,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -26935,7 +25282,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -26945,7 +25291,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -26955,7 +25300,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -27007,7 +25351,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily" }, "type": "array" } @@ -27015,7 +25359,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -27041,8 +25386,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json": { - "description": "Usage records summarized by month", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json": { + "description": "Usage records for last month", "get": { "description": "", "parameters": [ @@ -27062,7 +25407,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -27318,7 +25662,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -27328,7 +25671,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -27338,7 +25680,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -27390,7 +25731,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month" }, "type": "array" } @@ -27398,7 +25739,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -27424,8 +25766,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json": { - "description": "Usage records for this month", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json": { + "description": "Usage records summarized by month", "get": { "description": "", "parameters": [ @@ -27445,7 +25787,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -27701,7 +26042,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -27711,7 +26051,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -27721,7 +26060,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -27773,7 +26111,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly" }, "type": "array" } @@ -27781,7 +26119,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -27807,8 +26146,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json": { - "description": "Usage records for today", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json": { + "description": "Usage records for this month", "get": { "description": "", "parameters": [ @@ -27828,7 +26167,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -28084,7 +26422,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -28094,7 +26431,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -28104,7 +26440,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -28156,7 +26491,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month" }, "type": "array" } @@ -28164,7 +26499,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -28190,8 +26526,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json": { - "description": "Usage records summarized by year", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json": { + "description": "Usage records for today", "get": { "description": "", "parameters": [ @@ -28211,7 +26547,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -28467,7 +26802,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -28477,7 +26811,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -28487,7 +26820,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -28539,7 +26871,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today" }, "type": "array" } @@ -28547,7 +26879,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -28573,8 +26906,8 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json": { - "description": "Usage records for yesterday", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json": { + "description": "Usage records summarized by year", "get": { "description": "", "parameters": [ @@ -28594,7 +26927,6 @@ "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", "name": "Category", - "required": false, "schema": { "enum": [ "agent-conference", @@ -28850,7 +27182,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -28860,7 +27191,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -28870,7 +27200,6 @@ "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", "in": "query", "name": "IncludeSubaccounts", - "required": false, "schema": { "type": "boolean" } @@ -28922,7 +27251,7 @@ }, "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly" }, "type": "array" } @@ -28930,7 +27259,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -28956,57 +27286,27 @@ ], "x-path-type": "list" }, - "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json": { - "description": "Webhooks that notify you of usage thresholds", + "/2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json": { + "description": "Usage records for yesterday", "get": { - "description": "Retrieve a list of usage-triggers belonging to the account used to make the request", + "description": "", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to read.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read.", "in": "path", "name": "AccountSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.", - "in": "query", - "name": "Recurring", - "required": false, - "schema": { - "enum": [ - "daily", - "monthly", - "yearly", - "alltime" - ], - "type": "string" - } - }, - { - "description": "The trigger field of the UsageTriggers to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).", - "in": "query", - "name": "TriggerBy", - "required": false, - "schema": { - "enum": [ - "count", - "usage", - "price" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).", + "description": "The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.", "in": "query", - "name": "UsageCategory", - "required": false, + "name": "Category", "schema": { "enum": [ "agent-conference", @@ -29040,8 +27340,8 @@ "conversations-events", "conversations-participant-events", "conversations-participants", - "fraud-lookups", "cps", + "fraud-lookups", "group-rooms", "group-rooms-data-track", "group-rooms-encrypted-media-recorded", @@ -29258,6 +27558,32 @@ "type": "string" } }, + { + "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.", + "in": "query", + "name": "StartDate", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.", + "in": "query", + "name": "EndDate", + "schema": { + "format": "date-time", + "type": "string" + } + }, + { + "description": "Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.", + "in": "query", + "name": "IncludeSubaccounts", + "schema": { + "type": "boolean" + } + }, { "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", @@ -29303,9 +27629,9 @@ "format": "uri", "type": "string" }, - "usage_triggers": { + "usage_records": { "items": { - "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + "$ref": "#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday" }, "type": "array" } @@ -29313,7 +27639,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -29325,11 +27652,27 @@ "GA" ] }, - "post": { - "description": "Create a new UsageTrigger", + "servers": [ + { + "url": "https://api.twilio.com" + } + ], + "x-default-output-properties": [ + "category", + "start_date", + "end_date", + "count", + "count_unit" + ], + "x-path-type": "list" + }, + "/2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json": { + "description": "Webhooks that notify you of usage thresholds", + "get": { + "description": "Retrieve a list of usage-triggers belonging to the account used to make the request", "parameters": [ { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to read.", "in": "path", "name": "AccountSid", "required": true, @@ -29341,29 +27684,36 @@ } }, { - "description": "The URL we should call using `callback_method` when the trigger fires.", + "description": "The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.", "in": "query", - "name": "CallbackUrl", - "required": true, + "name": "Recurring", "schema": { - "format": "uri", + "enum": [ + "daily", + "monthly", + "yearly", + "alltime" + ], "type": "string" } }, { - "description": "The usage value at which the trigger should fire. For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`.", + "description": "The trigger field of the UsageTriggers to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).", "in": "query", - "name": "TriggerValue", - "required": true, + "name": "TriggerBy", "schema": { + "enum": [ + "count", + "usage", + "price" + ], "type": "string" } }, { - "description": "The usage category that the trigger should watch. Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value.", + "description": "The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).", "in": "query", "name": "UsageCategory", - "required": true, "schema": { "enum": [ "agent-conference", @@ -29616,67 +27966,406 @@ } }, { - "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "FriendlyName", - "required": false, + "name": "PageSize", "schema": { - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "end": { + "type": "integer" + }, + "first_page_uri": { + "format": "uri", + "type": "string" + }, + "next_page_uri": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_uri": { + "format": "uri", + "type": "string" + }, + "start": { + "type": "integer" + }, + "uri": { + "format": "uri", + "type": "string" + }, + "usage_triggers": { + "items": { + "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.", - "in": "query", - "name": "Recurring", - "required": false, - "schema": { - "enum": [ - "daily", - "monthly", - "yearly", - "alltime" - ], - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "Create a new UsageTrigger", + "parameters": [ { - "description": "The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that should fire the trigger. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). The default is `usage`.", - "in": "query", - "name": "TriggerBy", - "required": false, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.", + "in": "path", + "name": "AccountSid", + "required": true, "schema": { - "enum": [ - "count", - "usage", - "price" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CallbackUrl": { + "description": "The URL we should call using `callback_method` when the trigger fires.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Recurring": { + "description": "The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.", + "enum": [ + "daily", + "monthly", + "yearly", + "alltime" + ], + "type": "string" + }, + "TriggerBy": { + "description": "The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that should fire the trigger. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). The default is `usage`.", + "enum": [ + "count", + "usage", + "price" + ], + "type": "string" + }, + "TriggerValue": { + "description": "The usage value at which the trigger should fire. For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`.", + "type": "string" + }, + "UsageCategory": { + "description": "The usage category that the trigger should watch. Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value.", + "enum": [ + "agent-conference", + "answering-machine-detection", + "authy-authentications", + "authy-calls-outbound", + "authy-monthly-fees", + "authy-phone-intelligence", + "authy-phone-verifications", + "authy-sms-outbound", + "call-progess-events", + "calleridlookups", + "calls", + "calls-client", + "calls-globalconference", + "calls-inbound", + "calls-inbound-local", + "calls-inbound-mobile", + "calls-inbound-tollfree", + "calls-outbound", + "calls-pay-verb-transactions", + "calls-recordings", + "calls-sip", + "calls-sip-inbound", + "calls-sip-outbound", + "carrier-lookups", + "conversations", + "conversations-api-requests", + "conversations-conversation-events", + "conversations-endpoint-connectivity", + "conversations-events", + "conversations-participant-events", + "conversations-participants", + "fraud-lookups", + "cps", + "group-rooms", + "group-rooms-data-track", + "group-rooms-encrypted-media-recorded", + "group-rooms-media-downloaded", + "group-rooms-media-recorded", + "group-rooms-media-routed", + "group-rooms-media-stored", + "group-rooms-participant-minutes", + "group-rooms-recorded-minutes", + "ip-messaging", + "ip-messaging-commands", + "ip-messaging-data-storage", + "ip-messaging-data-transfer", + "ip-messaging-endpoint-connectivity", + "lookups", + "marketplace", + "marketplace-algorithmia-named-entity-recognition", + "marketplace-digital-segment-business-info", + "marketplace-google-speech-to-text", + "marketplace-ibm-watson-message-insights", + "marketplace-ibm-watson-message-sentiment", + "marketplace-ibm-watson-recording-analysis", + "marketplace-icehook-systems-scout", + "marketplace-infogroup-dataaxle-bizinfo", + "marketplace-cadence-transcription", + "marketplace-cadence-translation", + "marketplace-capio-speech-to-text", + "marketplace-facebook-offline-conversions", + "marketplace-keen-io-contact-center-analytics", + "marketplace-marchex-cleancall", + "marketplace-marchex-sentiment-analysis-for-sms", + "marketplace-marketplace-nextcaller-social-id", + "marketplace-mobile-commons-opt-out-classifier", + "marketplace-nexiwave-voicemail-to-text", + "marketplace-nextcaller-advanced-caller-identification", + "marketplace-nomorobo-spam-score", + "marketplace-payfone-tcpa-compliance", + "marketplace-telo-opencnam", + "marketplace-truecnam-true-spam", + "marketplace-twilio-caller-name-lookup-us", + "marketplace-twilio-carrier-information-lookup", + "marketplace-voicebase-pci", + "marketplace-voicebase-transcription", + "marketplace-whitepages-pro-caller-identification", + "marketplace-whitepages-pro-phone-intelligence", + "marketplace-whitepages-pro-phone-reputation", + "marketplace-wolfram-short-answer", + "marketplace-wolfarm-spoken-results", + "marketplace-deepgram-phrase-detector", + "marketplace-convriza-ababa", + "marketplace-ibm-watson-tone-analyzer", + "marketplace-remeeting-automatic-speech-recognition", + "marketplace-tcpa-defense-solutions-blacklist-feed", + "marketplace-voicebase-transcription-custom-vocabulary", + "marketplace-ytica-contact-center-reporting-analytics", + "mediastorage", + "mms", + "mms-inbound", + "mms-inbound-longcode", + "mms-inbound-shortcode", + "mms-messages-carrierfees", + "mms-outbound", + "mms-outbound-longcode", + "mms-outbound-shortcode", + "monitor-reads", + "monitor-storage", + "monitor-writes", + "notify", + "notify-actions-attempts", + "notify-channels", + "number-format-lookups", + "pchat", + "pchat-actions", + "pchat-aps", + "pchat-notifications", + "pchat-reads", + "pchat-users", + "pchat-messages", + "peer-to-peer-rooms-participant-minutes", + "pfax", + "pfax-minutes", + "pfax-minutes-inbound", + "pfax-minutes-outbound", + "pfax-pages", + "phonenumbers", + "phonenumbers-cps", + "phonenumbers-emergency", + "phonenumbers-local", + "phonenumbers-mobile", + "phonenumbers-setups", + "phonenumbers-tollfree", + "premiumsupport", + "proxy", + "proxy-active-sessions", + "pv", + "pv-composition-media-downloaded", + "pv-composition-media-encrypted", + "pv-composition-media-stored", + "pv-composition-minutes", + "pv-recording-compositions", + "pv-room-participants", + "pv-room-participants-au1", + "pv-room-participants-br1", + "pv-room-participants-ie1", + "pv-room-participants-jp1", + "pv-room-participants-sg1", + "pv-room-participants-us1", + "pv-room-participants-us2", + "pv-rooms", + "pv-sip-endpoint-registrations", + "recordings", + "recordingstorage", + "rooms-group-minutes", + "rooms-group-bandwidth", + "rooms-peer-to-peer-minutes", + "shortcodes", + "shortcodes-customerowned", + "shortcodes-mms-enablement", + "shortcodes-mps", + "shortcodes-random", + "shortcodes-uk", + "shortcodes-vanity", + "small-group-rooms", + "small-group-rooms-data-track", + "small-group-rooms-participant-minutes", + "sms", + "sms-inbound", + "sms-inbound-longcode", + "sms-inbound-shortcode", + "sms-messages-carrierfees", + "sms-messages-features", + "sms-messages-features-senderid", + "sms-outbound", + "sms-outbound-content-inspection", + "sms-outbound-longcode", + "sms-outbound-shortcode", + "speech-recognition", + "studio-engagements", + "sync", + "sync-actions", + "sync-endpoint-hours", + "sync-endpoint-hours-above-daily-cap", + "taskrouter-tasks", + "totalprice", + "transcriptions", + "trunking-cps", + "trunking-emergency-calls", + "trunking-origination", + "trunking-origination-local", + "trunking-origination-mobile", + "trunking-origination-tollfree", + "trunking-recordings", + "trunking-secure", + "trunking-termination", + "turnmegabytes", + "turnmegabytes-australia", + "turnmegabytes-brasil", + "turnmegabytes-germany", + "turnmegabytes-india", + "turnmegabytes-ireland", + "turnmegabytes-japan", + "turnmegabytes-singapore", + "turnmegabytes-useast", + "turnmegabytes-uswest", + "twilio-interconnect", + "video-recordings", + "voice-insights", + "voice-insights-client-insights-on-demand-minute", + "voice-insights-ptsn-insights-on-demand-minute", + "voice-insights-sip-interface-insights-on-demand-minute", + "voice-insights-sip-trunking-insights-on-demand-minute", + "wireless", + "wireless-orders", + "wireless-orders-artwork", + "wireless-orders-bulk", + "wireless-orders-esim", + "wireless-orders-starter", + "wireless-usage", + "wireless-usage-commands", + "wireless-usage-commands-africa", + "wireless-usage-commands-asia", + "wireless-usage-commands-centralandsouthamerica", + "wireless-usage-commands-europe", + "wireless-usage-commands-home", + "wireless-usage-commands-northamerica", + "wireless-usage-commands-oceania", + "wireless-usage-commands-roaming", + "wireless-usage-data", + "wireless-usage-data-africa", + "wireless-usage-data-asia", + "wireless-usage-data-centralandsouthamerica", + "wireless-usage-data-custom-additionalmb", + "wireless-usage-data-custom-first5mb", + "wireless-usage-data-domestic-roaming", + "wireless-usage-data-europe", + "wireless-usage-data-individual-additionalgb", + "wireless-usage-data-individual-firstgb", + "wireless-usage-data-international-roaming-canada", + "wireless-usage-data-international-roaming-india", + "wireless-usage-data-international-roaming-mexico", + "wireless-usage-data-northamerica", + "wireless-usage-data-oceania", + "wireless-usage-data-pooled", + "wireless-usage-data-pooled-downlink", + "wireless-usage-data-pooled-uplink", + "wireless-usage-mrc", + "wireless-usage-mrc-custom", + "wireless-usage-mrc-individual", + "wireless-usage-mrc-pooled", + "wireless-usage-mrc-suspended", + "wireless-usage-voice", + "wireless-usage-sms" + ], + "type": "string" + } + }, + "required": [ + "CallbackUrl", + "TriggerValue", + "UsageCategory" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -29685,7 +28374,8 @@ "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" } } - } + }, + "description": "Created" } }, "security": [ @@ -29790,7 +28480,8 @@ "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" } } - } + }, + "description": "OK" } }, "security": [ @@ -29828,50 +28519,46 @@ "pattern": "^UT[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using `callback_method` when the trigger fires.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CallbackUrl": { + "description": "The URL we should call using `callback_method` when the trigger fires.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -29880,7 +28567,8 @@ "$ref": "#/components/schemas/api.v2010.account.usage.usage_trigger" } } - } + }, + "description": "OK" } }, "security": [ @@ -29931,7 +28619,8 @@ "$ref": "#/components/schemas/api.v2010.account" } } - } + }, + "description": "OK" } }, "security": [ @@ -29957,31 +28646,32 @@ "pattern": "^AC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Update the human-readable description of this Account", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "active", - "suspended", - "closed" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Update the human-readable description of this Account", + "type": "string" + }, + "Status": { + "description": "Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.", + "enum": [ + "active", + "suspended", + "closed" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -29990,7 +28680,8 @@ "$ref": "#/components/schemas/api.v2010.account" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_authy.json b/src/services/twilio-api/twilio_authy.json index 6d71eb3a..f06c0fd2 100644 --- a/src/services/twilio-api/twilio_authy.json +++ b/src/services/twilio-api/twilio_authy.json @@ -315,7 +315,8 @@ "$ref": "#/components/schemas/authy.v1.form" } } - } + }, + "description": "OK" } }, "security": [ @@ -399,7 +400,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -413,26 +415,28 @@ }, "post": { "description": "Create a new Service for the Account", - "parameters": [ - { - "description": "A human readable description of this resource, up to 64 characters.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The optional service level push factors configuration. If present it must be a json string with the following format: {\"notify_service_sid\": \"ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\", \"include_date\": true}", - "in": "query", - "name": "Push", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable description of this resource, up to 64 characters.", + "type": "string" + }, + "Push": { + "description": "The optional service level push factors configuration. If present it must be a json string with the following format: {\"notify_service_sid\": \"ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\", \"include_date\": true}", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -441,7 +445,8 @@ "$ref": "#/components/schemas/authy.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -539,7 +544,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -565,17 +571,26 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Customer unique identity for the Entity of the Service", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "Customer unique identity for the Entity of the Service", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -584,7 +599,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity" } } - } + }, + "description": "Created" } }, "security": [ @@ -682,7 +698,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity" } } - } + }, + "description": "OK" } }, "security": [ @@ -789,7 +806,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -824,50 +842,47 @@ "schema": { "type": "string" } - }, - { - "description": "A unique binding for this Factor that identifies it. E.g. a phone number for `sms` factors. It must be a json string with the required properties for the given factor type. Required when creating a new Factor. This value is never returned because it can contain customer secrets.", - "in": "query", - "name": "Binding", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The friendly name of this Factor", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Type of this Factor. One of `app-push`, `sms`, `totp`, etc.", - "in": "query", - "name": "FactorType", - "required": true, - "schema": { - "enum": [ - "app-push", - "sms", - "totp", - "push" - ], - "type": "string" - } - }, - { - "description": "The config required for this Factor. It must be a json string with the required properties for the given factor type", - "in": "query", - "name": "Config", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Binding": { + "description": "A unique binding for this Factor that identifies it. E.g. a phone number for `sms` factors. It must be a json string with the required properties for the given factor type. Required when creating a new Factor. This value is never returned because it can contain customer secrets.", + "type": "string" + }, + "Config": { + "description": "The config required for this Factor. It must be a json string with the required properties for the given factor type", + "type": "string" + }, + "FactorType": { + "description": "The Type of this Factor. One of `app-push`, `sms`, `totp`, etc.", + "enum": [ + "app-push", + "sms", + "totp", + "push" + ], + "type": "string" + }, + "FriendlyName": { + "description": "The friendly name of this Factor", + "type": "string" + } + }, + "required": [ + "Binding", + "FriendlyName", + "FactorType", + "Config" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -876,7 +891,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity.factor" } } - } + }, + "description": "Created" } }, "security": [ @@ -943,7 +959,6 @@ "description": "The Status of the Challenges to fetch. One of `pending`, `expired`, `approved` or `denied`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "pending", @@ -1011,7 +1026,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1058,36 +1074,32 @@ "pattern": "^YF[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The future date in which this Challenge will expire, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", - "in": "query", - "name": "ExpirationDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Details provided to give context about the Challenge. Shown to the end user.", - "in": "query", - "name": "Details", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Details provided to give context about the Challenge. Not shown to the end user.", - "in": "query", - "name": "HiddenDetails", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Details": { + "description": "Details provided to give context about the Challenge. Shown to the end user.", + "type": "string" + }, + "ExpirationDate": { + "description": "The future date in which this Challenge will expire, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "date-time", + "type": "string" + }, + "HiddenDetails": { + "description": "Details provided to give context about the Challenge. Not shown to the end user.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1096,7 +1108,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity.factor.challenge" } } - } + }, + "description": "Created" } }, "security": [ @@ -1237,7 +1250,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity.factor.challenge" } } - } + }, + "description": "OK" } }, "security": [ @@ -1293,17 +1307,23 @@ "schema": { "type": "string" } - }, - { - "description": "The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code.", - "in": "query", - "name": "AuthPayload", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AuthPayload": { + "description": "The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1312,7 +1332,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity.factor.challenge" } } - } + }, + "description": "OK" } }, "security": [ @@ -1435,7 +1456,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity.factor" } } - } + }, + "description": "OK" } }, "security": [ @@ -1482,35 +1504,31 @@ "pattern": "^YF[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.", - "in": "query", - "name": "AuthPayload", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The new friendly name of this Factor", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The new config for this Factor. It must be a json string with the required properties for the given factor type", - "in": "query", - "name": "Config", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AuthPayload": { + "description": "The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.", + "type": "string" + }, + "Config": { + "description": "The new config for this Factor. It must be a json string with the required properties for the given factor type", + "type": "string" + }, + "FriendlyName": { + "description": "The new friendly name of this Factor", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1519,7 +1537,8 @@ "$ref": "#/components/schemas/authy.v1.service.entity.factor" } } - } + }, + "description": "OK" } }, "security": [ @@ -1600,7 +1619,8 @@ "$ref": "#/components/schemas/authy.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -1626,26 +1646,27 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A human readable description of this resource, up to 64 characters.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The optional service level push factors configuration. If present it must be a json string with the following format: {\"notify_service_sid\": \"ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\", \"include_date\": true}", - "in": "query", - "name": "Push", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A human readable description of this resource, up to 64 characters.", + "type": "string" + }, + "Push": { + "description": "The optional service level push factors configuration. If present it must be a json string with the following format: {\"notify_service_sid\": \"ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\", \"include_date\": true}", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1654,7 +1675,8 @@ "$ref": "#/components/schemas/authy.v1.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_autopilot.json b/src/services/twilio-api/twilio_autopilot.json index f01571ae..690d2e7a 100644 --- a/src/services/twilio-api/twilio_autopilot.json +++ b/src/services/twilio-api/twilio_autopilot.json @@ -742,7 +742,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -756,72 +757,46 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.", - "in": "query", - "name": "LogQueries", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "CallbackEvents", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)", - "in": "query", - "name": "StyleSheet", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks.", - "in": "query", - "name": "Defaults", - "required": false, - "schema": { - "type": "object" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Reserved.", + "type": "string" + }, + "CallbackUrl": { + "description": "Reserved.", + "format": "uri", + "type": "string" + }, + "Defaults": { + "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks.", + "type": "object" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.", + "type": "string" + }, + "LogQueries": { + "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -830,7 +805,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant" } } - } + }, + "description": "Created" } }, "security": [ @@ -877,7 +853,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" } } - } + }, + "description": "OK" } }, "security": [ @@ -900,17 +877,23 @@ "schema": { "type": "string" } - }, - { - "description": "A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations.", - "in": "query", - "name": "Defaults", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Defaults": { + "description": "A JSON string that describes the default task links for the `assistant_initiation`, `collect`, and `fallback` situations.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -919,7 +902,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.defaults" } } - } + }, + "description": "OK" } }, "security": [ @@ -973,7 +957,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.dialogue" } } - } + }, + "description": "OK" } }, "security": [ @@ -1019,7 +1004,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.export" } } - } + }, + "description": "OK" } }, "security": [ @@ -1116,7 +1102,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1139,26 +1126,30 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1167,7 +1158,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" } } - } + }, + "description": "Created" } }, "security": [ @@ -1218,7 +1210,6 @@ "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`", "in": "query", "name": "Language", - "required": false, "schema": { "type": "string" } @@ -1280,7 +1271,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1312,35 +1304,35 @@ "schema": { "type": "string" } - }, - { - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`", - "in": "query", - "name": "Language", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Field Value data.", - "in": "query", - "name": "Value", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The string value that indicates which word the field value is a synonym of.", - "in": "query", - "name": "SynonymOf", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) tag that specifies the language of the value. Currently supported tags: `en-US`", + "type": "string" + }, + "SynonymOf": { + "description": "The string value that indicates which word the field value is a synonym of.", + "type": "string" + }, + "Value": { + "description": "The Field Value data.", + "type": "string" + } + }, + "required": [ + "Language", + "Value" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1349,7 +1341,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" } } - } + }, + "description": "Created" } }, "security": [ @@ -1459,7 +1452,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.field_type.field_value" } } - } + }, + "description": "OK" } }, "security": [ @@ -1551,7 +1545,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" } } - } + }, + "description": "OK" } }, "security": [ @@ -1583,26 +1578,27 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1611,7 +1607,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.field_type" } } - } + }, + "description": "OK" } }, "security": [ @@ -1706,7 +1703,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1729,27 +1727,28 @@ "schema": { "type": "string" } - }, - { - "description": "The URL we should call using a POST method to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StatusCallback": { + "description": "The URL we should call using a POST method to send status information to your application.", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1758,7 +1757,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" } } - } + }, + "description": "Created" } }, "security": [ @@ -1851,7 +1851,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" } } - } + }, + "description": "OK" } }, "security": [ @@ -1883,17 +1884,23 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1902,7 +1909,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.model_build" } } - } + }, + "description": "OK" } }, "security": [ @@ -1945,7 +1953,6 @@ "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used by the Query resources to read. For example: `en-US`.", "in": "query", "name": "Language", - "required": false, "schema": { "type": "string" } @@ -1954,7 +1961,6 @@ "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", "in": "query", "name": "ModelBuild", - "required": false, "schema": { "type": "string" } @@ -1963,7 +1969,6 @@ "description": "The status of the resources to read. Can be: `pending-review`, `reviewed`, or `discarded`", "in": "query", "name": "Status", - "required": false, "schema": { "type": "string" } @@ -2025,7 +2030,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2048,44 +2054,39 @@ "schema": { "type": "string" } - }, - { - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new query. For example: `en-US`.", - "in": "query", - "name": "Language", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The end-user's natural language input. It can be up to 2048 characters long.", - "in": "query", - "name": "Query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The list of tasks to limit the new query to. Tasks are expressed as a comma-separated list of task `unique_name` values. For example, `task-unique_name-1, task-unique_name-2`. Listing specific tasks is useful to constrain the paths that a user can take.", - "in": "query", - "name": "Tasks", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", - "in": "query", - "name": "ModelBuild", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new query. For example: `en-US`.", + "type": "string" + }, + "ModelBuild": { + "description": "The SID or unique name of the [Model Build](https://www.twilio.com/docs/autopilot/api/model-build) to be queried.", + "type": "string" + }, + "Query": { + "description": "The end-user's natural language input. It can be up to 2048 characters long.", + "type": "string" + }, + "Tasks": { + "description": "The list of tasks to limit the new query to. Tasks are expressed as a comma-separated list of task `unique_name` values. For example, `task-unique_name-1, task-unique_name-2`. Listing specific tasks is useful to constrain the paths that a user can take.", + "type": "string" + } + }, + "required": [ + "Language", + "Query" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2094,7 +2095,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.query" } } - } + }, + "description": "Created" } }, "security": [ @@ -2187,7 +2189,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.query" } } - } + }, + "description": "OK" } }, "security": [ @@ -2219,29 +2222,30 @@ "schema": { "type": "string" } - }, - { - "description": "The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query.", - "in": "query", - "name": "SampleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded`", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "SampleSid": { + "description": "The SID of an optional reference to the [Sample](https://www.twilio.com/docs/autopilot/api/task-sample) created from the query.", + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "Status": { + "description": "The new status of the resource. Can be: `pending-review`, `reviewed`, or `discarded`", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2250,7 +2254,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.query" } } - } + }, + "description": "OK" } }, "security": [ @@ -2298,7 +2303,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" } } - } + }, + "description": "OK" } }, "security": [ @@ -2321,17 +2327,23 @@ "schema": { "type": "string" } - }, - { - "description": "The JSON string that describes the style sheet object.", - "in": "query", - "name": "StyleSheet", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StyleSheet": { + "description": "The JSON string that describes the style sheet object.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2340,7 +2352,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.style_sheet" } } - } + }, + "description": "OK" } }, "security": [ @@ -2433,7 +2446,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2456,45 +2470,39 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task. It is optional and not unique.", - "in": "query", - "name": "Actions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The URL from which the Assistant can fetch actions.", - "in": "query", - "name": "ActionsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task. It is optional and not unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "The URL from which the Assistant can fetch actions.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It is not unique and can be up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -2503,7 +2511,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task" } } - } + }, + "description": "Created" } }, "security": [ @@ -2595,7 +2604,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task" } } - } + }, + "description": "OK" } }, "security": [ @@ -2627,45 +2637,36 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be 64 characters or less in length and be unique. It can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task.", - "in": "query", - "name": "Actions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The URL from which the Assistant can fetch actions.", - "in": "query", - "name": "ActionsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task.", + "type": "object" + }, + "ActionsUrl": { + "description": "The URL from which the Assistant can fetch actions.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be 64 characters or less in length and be unique. It can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2674,7 +2675,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task" } } - } + }, + "description": "OK" } }, "security": [ @@ -2730,7 +2732,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -2762,17 +2765,23 @@ "schema": { "type": "string" } - }, - { - "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task.", - "in": "query", - "name": "Actions", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "The JSON string that specifies the [actions](https://www.twilio.com/docs/autopilot/actions) that instruct the Assistant on how to perform the task.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2781,7 +2790,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -2883,7 +2893,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2915,26 +2926,31 @@ "schema": { "type": "string" } - }, - { - "description": "The Field Type of the new field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the `unique_name`, or the `sid` of a custom Field Type.", - "in": "query", - "name": "FieldType", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FieldType": { + "description": "The Field Type of the new field. Can be: a [Built-in Field Type](https://www.twilio.com/docs/autopilot/built-in-field-types), the `unique_name`, or the `sid` of a custom Field Type.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "required": [ + "FieldType", + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2943,7 +2959,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" } } - } + }, + "description": "Created" } }, "security": [ @@ -3053,7 +3070,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.field" } } - } + }, + "description": "OK" } }, "security": [ @@ -3104,7 +3122,6 @@ "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.", "in": "query", "name": "Language", - "required": false, "schema": { "type": "string" } @@ -3166,7 +3183,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3198,35 +3216,35 @@ "schema": { "type": "string" } - }, - { - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new sample. For example: `en-US`.", - "in": "query", - "name": "Language", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).", - "in": "query", - "name": "TaggedText", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The communication channel from which the new sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.", - "in": "query", - "name": "SourceChannel", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the new sample. For example: `en-US`.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel from which the new sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).", + "type": "string" + } + }, + "required": [ + "Language", + "TaggedText" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3235,7 +3253,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" } } - } + }, + "description": "Created" } }, "security": [ @@ -3352,7 +3371,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" } } - } + }, + "description": "OK" } }, "security": [ @@ -3396,35 +3416,31 @@ "pattern": "^UF[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.", - "in": "query", - "name": "Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).", - "in": "query", - "name": "TaggedText", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.", - "in": "query", - "name": "SourceChannel", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "The [ISO language-country](https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html) string that specifies the language used for the sample. For example: `en-US`.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel from which the sample was captured. Can be: `voice`, `sms`, `chat`, `alexa`, `google-assistant`, `slack`, or null if not included.", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end users might express the task. The sample can contain [Field tag blocks](https://www.twilio.com/docs/autopilot/api/task-sample#field-tagging).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3433,7 +3449,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.sample" } } - } + }, + "description": "OK" } }, "security": [ @@ -3490,7 +3507,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.task.task_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -3584,7 +3602,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3607,45 +3626,41 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The list of space-separated events that this Webhook will subscribe to.", - "in": "query", - "name": "Events", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL associated with this Webhook.", - "in": "query", - "name": "WebhookUrl", - "required": true, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The method to be used when calling the webhook's URL.", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Events": { + "description": "The list of space-separated events that this Webhook will subscribe to.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.", + "type": "string" + }, + "WebhookMethod": { + "description": "The method to be used when calling the webhook's URL.", + "type": "string" + }, + "WebhookUrl": { + "description": "The URL associated with this Webhook.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "UniqueName", + "Events", + "WebhookUrl" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3654,7 +3669,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" } } - } + }, + "description": "Created" } }, "security": [ @@ -3748,7 +3764,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -3780,45 +3797,36 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The list of space-separated events that this Webhook will subscribe to.", - "in": "query", - "name": "Events", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL associated with this Webhook.", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The method to be used when calling the webhook's URL.", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Events": { + "description": "The list of space-separated events that this Webhook will subscribe to.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the new resource. It can be used as an alternative to the `sid` in the URL path to address the resource. This value must be unique and 64 characters or less in length.", + "type": "string" + }, + "WebhookMethod": { + "description": "The method to be used when calling the webhook's URL.", + "type": "string" + }, + "WebhookUrl": { + "description": "The URL associated with this Webhook.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3827,7 +3835,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant.webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -3903,7 +3912,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant" } } - } + }, + "description": "OK" } }, "security": [ @@ -3926,81 +3936,52 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.", - "in": "query", - "name": "LogQueries", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "CallbackEvents", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)", - "in": "query", - "name": "StyleSheet", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks.", - "in": "query", - "name": "Defaults", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "A string describing the state of the assistant.", - "in": "query", - "name": "DevelopmentStage", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Reserved.", + "type": "string" + }, + "CallbackUrl": { + "description": "Reserved.", + "format": "uri", + "type": "string" + }, + "Defaults": { + "description": "A JSON object that defines the Assistant's [default tasks](https://www.twilio.com/docs/autopilot/api/assistant/defaults) for various scenarios, including initiation actions and fallback tasks.", + "type": "object" + }, + "DevelopmentStage": { + "description": "A string describing the state of the assistant.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It is not unique and can be up to 255 characters long.", + "type": "string" + }, + "LogQueries": { + "description": "Whether queries should be logged and kept after training. Can be: `true` or `false` and defaults to `true`. If `true`, queries are stored for 30 days, and then deleted. If `false`, no queries are stored.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON string that defines the Assistant's [style sheet](https://www.twilio.com/docs/autopilot/api/assistant/stylesheet)", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource. The first 64 characters must be unique.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -4009,7 +3990,8 @@ "$ref": "#/components/schemas/autopilot.v1.assistant" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_bulkexports.json b/src/services/twilio-api/twilio_bulkexports.json index c64450b8..c52c9025 100644 --- a/src/services/twilio-api/twilio_bulkexports.json +++ b/src/services/twilio-api/twilio_bulkexports.json @@ -222,7 +222,8 @@ "$ref": "#/components/schemas/bulkexports.v1.export.job" } } - } + }, + "description": "OK" } }, "security": [ @@ -265,7 +266,8 @@ "$ref": "#/components/schemas/bulkexports.v1.export" } } - } + }, + "description": "OK" } }, "security": [ @@ -308,7 +310,8 @@ "$ref": "#/components/schemas/bulkexports.v1.export_configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -331,36 +334,32 @@ "schema": { "type": "string" } - }, - { - "description": "If true, Twilio will automatically generate every day's file when the day is over.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Stores the URL destination for the method specified in webhook_method.", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "If true, Twilio will automatically generate every day's file when the day is over.", + "type": "boolean" + }, + "WebhookMethod": { + "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", + "type": "string" + }, + "WebhookUrl": { + "description": "Stores the URL destination for the method specified in webhook_method.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -369,7 +368,8 @@ "$ref": "#/components/schemas/bulkexports.v1.export_configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -407,7 +407,6 @@ "description": "", "in": "query", "name": "NextToken", - "required": false, "schema": { "type": "string" } @@ -416,7 +415,6 @@ "description": "", "in": "query", "name": "PreviousToken", - "required": false, "schema": { "type": "string" } @@ -478,7 +476,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -530,7 +529,8 @@ "$ref": "#/components/schemas/bulkexports.v1.export.day|instance" } } - } + }, + "description": "Temporary Redirect" } }, "security": [ @@ -568,7 +568,6 @@ "description": "The token for the next page of job results, and may be null if there are no more pages", "in": "query", "name": "NextToken", - "required": false, "schema": { "type": "string" } @@ -577,7 +576,6 @@ "description": "The token for the previous page of results, and may be null if this is the first page", "in": "query", "name": "PreviousToken", - "required": false, "schema": { "type": "string" } @@ -639,7 +637,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -662,62 +661,43 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "StartDay", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "EndDay", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Email", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Email": { + "description": "", + "type": "string" + }, + "EndDay": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "StartDay": { + "description": "", + "type": "string" + }, + "WebhookMethod": { + "description": "", + "type": "string" + }, + "WebhookUrl": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -726,7 +706,8 @@ "$ref": "#/components/schemas/bulkexports.v1.export.export_custom_job" } } - } + }, + "description": "Created" } }, "security": [ diff --git a/src/services/twilio-api/twilio_chat.json b/src/services/twilio-api/twilio_chat.json index 95c68a92..79e6e145 100644 --- a/src/services/twilio-api/twilio_chat.json +++ b/src/services/twilio-api/twilio_chat.json @@ -1359,7 +1359,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1373,76 +1374,53 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", - "in": "query", - "name": "Certificate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", - "in": "query", - "name": "PrivateKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "in": "query", - "name": "Sandbox", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", - "in": "query", - "name": "ApiKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", - "in": "query", - "name": "Secret", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", + "type": "string" + }, + "Type": { + "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.", + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1451,7 +1429,8 @@ "$ref": "#/components/schemas/chat.v1.credential" } } - } + }, + "description": "Created" } }, "security": [ @@ -1531,7 +1510,8 @@ "$ref": "#/components/schemas/chat.v1.credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -1557,62 +1537,43 @@ "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", - "in": "query", - "name": "Certificate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", - "in": "query", - "name": "PrivateKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "in": "query", - "name": "Sandbox", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", - "in": "query", - "name": "ApiKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", - "in": "query", - "name": "Secret", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==\n-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR.\n-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1621,7 +1582,8 @@ "$ref": "#/components/schemas/chat.v1.credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -1707,7 +1669,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1721,17 +1684,24 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1740,7 +1710,8 @@ "$ref": "#/components/schemas/chat.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -1785,7 +1756,6 @@ "description": "The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.", "in": "query", "name": "Type", - "required": false, "schema": { "items": { "enum": [ @@ -1854,7 +1824,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1880,48 +1851,39 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`.", - "in": "query", - "name": "Type", - "required": false, - "schema": { - "enum": [ - "public", - "private" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "Type": { + "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`.", + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1930,7 +1892,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel" } } - } + }, + "description": "Created" } }, "security": [ @@ -1984,7 +1947,6 @@ "description": "The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", "in": "query", "name": "Identity", - "required": false, "schema": { "items": { "type": "string" @@ -2049,7 +2011,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2084,29 +2047,33 @@ "schema": { "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new member.", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more info.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new member.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2115,7 +2082,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.invite" } } - } + }, + "description": "Created" } }, "security": [ @@ -2237,7 +2205,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.invite" } } - } + }, + "description": "OK" } }, "security": [ @@ -2291,7 +2260,6 @@ "description": "The [User](https://www.twilio.com/docs/api/chat/rest/v1/user)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", "in": "query", "name": "Identity", - "required": false, "schema": { "items": { "type": "string" @@ -2356,7 +2324,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2391,29 +2360,33 @@ "schema": { "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/services). See [access tokens](https://www.twilio.com/docs/api/chat/guides/create-tokens) for more details.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2422,7 +2395,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.member" } } - } + }, + "description": "Created" } }, "security": [ @@ -2544,7 +2518,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.member" } } - } + }, + "description": "OK" } }, "security": [ @@ -2591,30 +2566,31 @@ "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels).", - "in": "query", - "name": "LastConsumedMessageIndex", - "required": false, - "schema": { - "nullable": true, - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "LastConsumedMessageIndex": { + "description": "The index of the last [Message](https://www.twilio.com/docs/api/chat/rest/messages) that the Member has read within the [Channel](https://www.twilio.com/docs/api/chat/rest/channels).", + "nullable": true, + "type": "integer" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/api/services).", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2623,7 +2599,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.member" } } - } + }, + "description": "OK" } }, "security": [ @@ -2680,7 +2657,6 @@ "description": "The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.", "in": "query", "name": "Order", - "required": false, "schema": { "enum": [ "asc", @@ -2746,7 +2722,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2784,35 +2761,34 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", - "in": "query", - "name": "Body", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.", - "in": "query", - "name": "From", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "Body": { + "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", + "type": "string" + }, + "From": { + "description": "The [identity](https://www.twilio.com/docs/api/chat/guides/identity) of the new message's author. The default value is `system`.", + "type": "string" + } + }, + "required": [ + "Body" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -2821,7 +2797,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.message" } } - } + }, + "description": "Created" } }, "security": [ @@ -2950,7 +2927,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.message" } } - } + }, + "description": "OK" } }, "security": [ @@ -3000,26 +2978,27 @@ "pattern": "^IM[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "Body": { + "description": "The message to send to the channel. Can also be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3028,7 +3007,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel.message" } } - } + }, + "description": "OK" } }, "security": [ @@ -3127,7 +3107,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -3162,35 +3143,31 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3199,7 +3176,8 @@ "$ref": "#/components/schemas/chat.v1.service.channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -3297,7 +3275,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3323,42 +3302,43 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) roles.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "channel", - "deployment" - ], - "type": "string" - } - }, - { - "description": "A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", - "in": "query", - "name": "Permission", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "Permission": { + "description": "A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Type": { + "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/api/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/api/services) roles.", + "enum": [ + "channel", + "deployment" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Type", + "Permission" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3367,7 +3347,8 @@ "$ref": "#/components/schemas/chat.v1.service.role" } } - } + }, + "description": "Created" } }, "security": [ @@ -3471,7 +3452,8 @@ "$ref": "#/components/schemas/chat.v1.service.role" } } - } + }, + "description": "OK" } }, "security": [ @@ -3509,20 +3491,29 @@ "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", - "in": "query", - "name": "Permission", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Permission": { + "description": "A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type` and are described in the documentation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Permission" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3531,7 +3522,8 @@ "$ref": "#/components/schemas/chat.v1.service.role" } } - } + }, + "description": "OK" } }, "security": [ @@ -3629,7 +3621,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3655,47 +3648,41 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is often a username or email address. See the Identity documentation for more details.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new User.", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new resource. This value is often used for display purposes.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. This value is often used for display purposes.", + "type": "string" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/api/chat/rest/v1/user) within the [Service](https://www.twilio.com/docs/api/chat/rest/v1/service). This value is often a username or email address. See the Identity documentation for more details.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to the new User.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3704,7 +3691,8 @@ "$ref": "#/components/schemas/chat.v1.service.user" } } - } + }, + "description": "Created" } }, "security": [ @@ -3802,7 +3790,8 @@ "$ref": "#/components/schemas/chat.v1.service.user" } } - } + }, + "description": "OK" } }, "security": [ @@ -3837,38 +3826,34 @@ "schema": { "type": "string" } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It is often used for display purposes.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It is often used for display purposes.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/api/chat/rest/roles) assigned to this user.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3877,7 +3862,8 @@ "$ref": "#/components/schemas/chat.v1.service.user" } } - } + }, + "description": "OK" } }, "security": [ @@ -3984,7 +3970,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -4063,7 +4050,8 @@ "$ref": "#/components/schemas/chat.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -4089,762 +4077,503 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", - "in": "query", - "name": "DefaultServiceRoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", - "in": "query", - "name": "DefaultChannelRoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", - "in": "query", - "name": "DefaultChannelCreatorRoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.", - "in": "query", - "name": "ReadStatusEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.", - "in": "query", - "name": "ReachabilityEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.", - "in": "query", - "name": "TypingIndicatorTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.", - "in": "query", - "name": "ConsumptionReportInterval", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "Notifications.NewMessage.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", - "in": "query", - "name": "Notifications.NewMessage.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "Notifications.AddedToChannel.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.AddedToChannel.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "Notifications.RemovedFromChannel.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.RemovedFromChannel.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.", - "in": "query", - "name": "Notifications.InvitedToChannel.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.InvitedToChannel.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", - "in": "query", - "name": "PreWebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", - "in": "query", - "name": "PostWebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "in": "query", - "name": "WebhookFilters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMessageSend.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_message_send.url`.", - "in": "query", - "name": "Webhooks.OnMessageSend.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMessageUpdate.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_message_update.url`.", - "in": "query", - "name": "Webhooks.OnMessageUpdate.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMessageRemove.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_message_remove.url`.", - "in": "query", - "name": "Webhooks.OnMessageRemove.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnChannelAdd.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_channel_add.url`.", - "in": "query", - "name": "Webhooks.OnChannelAdd.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnChannelDestroy.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.", - "in": "query", - "name": "Webhooks.OnChannelDestroy.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnChannelUpdate.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_channel_update.url`.", - "in": "query", - "name": "Webhooks.OnChannelUpdate.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMemberAdd.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_member_add.url`.", - "in": "query", - "name": "Webhooks.OnMemberAdd.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMemberRemove.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_member_remove.url`.", - "in": "query", - "name": "Webhooks.OnMemberRemove.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMessageSent.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_sent` event`.", - "in": "query", - "name": "Webhooks.OnMessageSent.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMessageUpdated.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_message_updated.url`.", - "in": "query", - "name": "Webhooks.OnMessageUpdated.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMessageRemoved.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_message_removed.url`.", - "in": "query", - "name": "Webhooks.OnMessageRemoved.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnChannelAdded.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_added` event`.", - "in": "query", - "name": "Webhooks.OnChannelAdded.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnChannelDestroyed.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.", - "in": "query", - "name": "Webhooks.OnChannelDestroyed.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnChannelUpdated.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", - "in": "query", - "name": "Webhooks.OnChannelUpdated.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMemberAdded.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", - "in": "query", - "name": "Webhooks.OnMemberAdded.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.", - "in": "query", - "name": "Webhooks.OnMemberRemoved.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use when calling the `webhooks.on_member_removed.url`.", - "in": "query", - "name": "Webhooks.OnMemberRemoved.Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.", - "in": "query", - "name": "Limits.ChannelMembers", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.", - "in": "query", - "name": "Limits.UserChannels", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ConsumptionReportInterval": { + "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.", + "type": "integer" + }, + "DefaultChannelCreatorRoleSid": { + "description": "The channel role assigned to a channel creator when they join a new channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultChannelRoleSid": { + "description": "The channel role assigned to users when they are added to a channel. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultServiceRoleSid": { + "description": "The service role assigned to users when they are added to the service. See the [Roles endpoint](https://www.twilio.com/docs/chat/api/roles) for more details.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Limits.ChannelMembers": { + "description": "The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.", + "type": "integer" + }, + "Limits.UserChannels": { + "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.", + "type": "integer" + }, + "Notifications.AddedToChannel.Enabled": { + "description": "Whether to send a notification when a member is added to a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.AddedToChannel.Template": { + "description": "The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.InvitedToChannel.Enabled": { + "description": "Whether to send a notification when a user is invited to a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.InvitedToChannel.Template": { + "description": "The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.NewMessage.Enabled": { + "description": "Whether to send a notification when a new message is added to a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.NewMessage.Template": { + "description": "The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", + "type": "string" + }, + "Notifications.RemovedFromChannel.Enabled": { + "description": "Whether to send a notification to a user when they are removed from a channel. Can be: `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "Notifications.RemovedFromChannel.Template": { + "description": "The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", + "type": "string" + }, + "PostWebhookUrl": { + "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", + "format": "uri", + "type": "string" + }, + "PreWebhookUrl": { + "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/api/chat/webhooks) for more details.", + "format": "uri", + "type": "string" + }, + "ReachabilityEnabled": { + "description": "Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.", + "type": "boolean" + }, + "ReadStatusEnabled": { + "description": "Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.", + "type": "boolean" + }, + "TypingIndicatorTimeout": { + "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.", + "type": "integer" + }, + "WebhookFilters": { + "description": "The list of WebHook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "WebhookMethod": { + "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdd.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_add.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdd.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_add` event using the `webhooks.on_channel_add.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelAdded.Method": { + "description": "The URL of the webhook to call in response to the `on_channel_added` event`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelAdded.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_added.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelDestroy.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_destroy.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelDestroy.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_destroy` event using the `webhooks.on_channel_destroy.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelDestroyed.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_destroyed.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelDestroyed.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_added` event using the `webhooks.on_channel_destroyed.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelUpdate.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_update.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelUpdate.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_update` event using the `webhooks.on_channel_update.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnChannelUpdated.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnChannelUpdated.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberAdd.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_member_add.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberAdd.Url": { + "description": "The URL of the webhook to call in response to the `on_member_add` event using the `webhooks.on_member_add.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberAdded.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_channel_updated.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberAdded.Url": { + "description": "The URL of the webhook to call in response to the `on_channel_updated` event using the `webhooks.on_channel_updated.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberRemove.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_member_remove.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberRemove.Url": { + "description": "The URL of the webhook to call in response to the `on_member_remove` event using the `webhooks.on_member_remove.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMemberRemoved.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_member_removed.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMemberRemoved.Url": { + "description": "The URL of the webhook to call in response to the `on_member_removed` event using the `webhooks.on_member_removed.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageRemove.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_remove.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageRemove.Url": { + "description": "The URL of the webhook to call in response to the `on_message_remove` event using the `webhooks.on_message_remove.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageRemoved.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_removed.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageRemoved.Url": { + "description": "The URL of the webhook to call in response to the `on_message_removed` event using the `webhooks.on_message_removed.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageSend.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_send.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageSend.Url": { + "description": "The URL of the webhook to call in response to the `on_message_send` event using the `webhooks.on_message_send.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageSent.Method": { + "description": "The URL of the webhook to call in response to the `on_message_sent` event`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageSent.Url": { + "description": "The URL of the webhook to call in response to the `on_message_sent` event using the `webhooks.on_message_sent.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageUpdate.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_update.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageUpdate.Url": { + "description": "The URL of the webhook to call in response to the `on_message_update` event using the `webhooks.on_message_update.method` HTTP method.", + "format": "uri", + "type": "string" + }, + "Webhooks.OnMessageUpdated.Method": { + "description": "The HTTP method to use when calling the `webhooks.on_message_updated.url`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Webhooks.OnMessageUpdated.Url": { + "description": "The URL of the webhook to call in response to the `on_message_updated` event using the `webhooks.on_message_updated.method` HTTP method.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -4853,7 +4582,8 @@ "$ref": "#/components/schemas/chat.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -4939,7 +4669,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -4953,76 +4684,53 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n-----END CERTIFICATE-----`", - "in": "query", - "name": "Certificate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...\n-----END RSA PRIVATE KEY-----`", - "in": "query", - "name": "PrivateKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "in": "query", - "name": "Sandbox", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", - "in": "query", - "name": "ApiKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", - "in": "query", - "name": "Secret", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...\n-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", + "type": "string" + }, + "Type": { + "description": "The type of push-notification service the credential is for. Can be: `gcm`, `fcm`, or `apn`.", + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -5031,7 +4739,8 @@ "$ref": "#/components/schemas/chat.v2.credential" } } - } + }, + "description": "Created" } }, "security": [ @@ -5111,88 +4820,70 @@ "$ref": "#/components/schemas/chat.v2.credential" } } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the Credential resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n-----END CERTIFICATE-----`", - "in": "query", - "name": "Certificate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...\n-----END RSA PRIVATE KEY-----`", - "in": "query", - "name": "PrivateKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "in": "query", - "name": "Sandbox", - "required": false, - "schema": { - "type": "boolean" - } - }, + }, + "description": "OK" + } + }, + "security": [ { - "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", - "in": "query", - "name": "ApiKey", - "required": false, - "schema": { - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ { - "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", - "in": "query", - "name": "Secret", - "required": false, + "description": "The SID of the Credential resource to update.", + "in": "path", + "name": "Sid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL encoded representation of the certificate. For example, \n`-----BEGIN CERTIFICATE-----\nMIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A==\n-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL encoded representation of the private key. For example,\n`-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG...\n-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The **Server key** of your project from the Firebase console, found under Settings / Cloud messaging.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -5201,7 +4892,8 @@ "$ref": "#/components/schemas/chat.v2.credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -5287,7 +4979,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5301,17 +4994,24 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the new resource.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -5320,7 +5020,8 @@ "$ref": "#/components/schemas/chat.v2.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -5365,7 +5066,6 @@ "description": "The push technology used by the Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.", "in": "query", "name": "BindingType", - "required": false, "schema": { "items": { "enum": [ @@ -5382,7 +5082,6 @@ "description": "The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.", "in": "query", "name": "Identity", - "required": false, "schema": { "items": { "type": "string" @@ -5447,7 +5146,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5551,7 +5251,8 @@ "$ref": "#/components/schemas/chat.v2.service.binding" } } - } + }, + "description": "OK" } }, "security": [ @@ -5596,7 +5297,6 @@ "description": "The visibility of the Channels to read. Can be: `public` or `private` and defaults to `public`.", "in": "query", "name": "Type", - "required": false, "schema": { "items": { "enum": [ @@ -5665,7 +5365,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5691,77 +5392,53 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`.", - "in": "query", - "name": "Type", - "required": false, - "schema": { - "enum": [ - "public", - "private" - ], - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source and where a Message was previously updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The `identity` of the User that created the channel. Default is: `system`.", - "in": "query", - "name": "CreatedBy", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "CreatedBy": { + "description": "The `identity` of the User that created the channel. Default is: `system`.", + "type": "string" + }, + "DateCreated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used in cases where a Channel is being recreated from a backup/separate source and where a Message was previously updated.", + "format": "date-time", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "Type": { + "description": "The visibility of the channel. Can be: `public` or `private` and defaults to `public`.", + "enum": [ + "public", + "private" + ], + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the Channel resource's `sid` in the URL. This value must be 64 characters or less in length and be unique within the Service.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -5770,7 +5447,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel" } } - } + }, + "description": "Created" } }, "security": [ @@ -5824,7 +5502,6 @@ "description": "The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.", "in": "query", "name": "Identity", - "required": false, "schema": { "items": { "type": "string" @@ -5889,7 +5566,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5924,29 +5602,33 @@ "schema": { "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the new member.", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) assigned to the new member.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -5955,7 +5637,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.invite" } } - } + }, + "description": "Created" } }, "security": [ @@ -6077,7 +5760,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.invite" } } - } + }, + "description": "OK" } }, "security": [ @@ -6131,7 +5815,6 @@ "description": "The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the Member resources to read. See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more details.", "in": "query", "name": "Identity", - "required": false, "schema": { "items": { "type": "string" @@ -6196,7 +5879,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -6231,78 +5915,57 @@ "schema": { "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source.", - "in": "query", - "name": "LastConsumedMessageIndex", - "required": false, - "schema": { - "nullable": true, - "type": "integer" - } - }, - { - "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).", - "in": "query", - "name": "LastConsumptionTimestamp", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "DateCreated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated. The default value is `null`. Note that this parameter should only be used when a Member is being recreated from a backup/separate source and where a Member was previously updated.", + "format": "date-time", + "type": "string" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). See [access tokens](https://www.twilio.com/docs/chat/create-tokens) for more info.", + "type": "string" + }, + "LastConsumedMessageIndex": { + "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read. This parameter should only be used when recreating a Member from a backup/separate source.", + "nullable": true, + "type": "integer" + }, + "LastConsumptionTimestamp": { + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).", + "format": "date-time", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -6311,7 +5974,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.member" } } - } + }, + "description": "Created" } }, "security": [ @@ -6427,7 +6091,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.member" } } - } + }, + "description": "OK" } }, "security": [ @@ -6448,92 +6113,73 @@ "name": "ServiceSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels).", - "in": "query", - "name": "LastConsumedMessageIndex", - "required": false, - "schema": { - "nullable": true, - "type": "integer" - } - }, - { - "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).", - "in": "query", - "name": "LastConsumptionTimestamp", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Member resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, "schema": { - "format": "date-time", "type": "string" } }, { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, + "description": "The SID of the Member resource to update. This value can be either the Member's `sid` or its `identity` value.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "DateCreated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this parameter should only be used when a Member is being recreated from a backup/separate source.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", + "format": "date-time", + "type": "string" + }, + "LastConsumedMessageIndex": { + "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) that the Member has read within the [Channel](https://www.twilio.com/docs/chat/channels).", + "nullable": true, + "type": "integer" + }, + "LastConsumptionTimestamp": { + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).", + "format": "date-time", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the member. The default roles are those specified on the [Service](https://www.twilio.com/docs/chat/rest/service-resource).", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -6542,7 +6188,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.member" } } - } + }, + "description": "OK" } }, "security": [ @@ -6596,7 +6243,6 @@ "description": "The sort order of the returned messages. Can be: `asc` (ascending) or `desc` (descending) with `asc` as the default.", "in": "query", "name": "Order", - "required": false, "schema": { "enum": [ "asc", @@ -6662,7 +6308,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -6697,76 +6344,52 @@ "schema": { "type": "string" } - }, - { - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the new message's author. The default value is `system`.", - "in": "query", - "name": "From", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", - "in": "query", - "name": "LastUpdatedBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The message to send to the channel. Can be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message.", - "in": "query", - "name": "MediaSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "Body": { + "description": "The message to send to the channel. Can be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", + "type": "string" + }, + "DateCreated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", + "format": "date-time", + "type": "string" + }, + "From": { + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the new message's author. The default value is `system`.", + "type": "string" + }, + "LastUpdatedBy": { + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", + "type": "string" + }, + "MediaSid": { + "description": "The SID of the [Media](https://www.twilio.com/docs/chat/rest/media) to attach to the new Message.", + "maxLength": 34, + "minLength": 34, + "pattern": "^ME[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -6775,7 +6398,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.message" } } - } + }, + "description": "Created" } }, "security": [ @@ -6898,7 +6522,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.message" } } - } + }, + "description": "OK" } }, "security": [ @@ -6945,64 +6570,45 @@ "pattern": "^IM[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The message to send to the channel. Can be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", - "in": "query", - "name": "LastUpdatedBy", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author.", - "in": "query", - "name": "From", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "Body": { + "description": "The message to send to the channel. Can be an empty string or `null`, which sets the value as an empty string. You can send structured data in the body by serializing it as a string.", + "type": "string" + }, + "DateCreated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. This parameter should only be used when a Chat's history is being recreated from a backup/separate source.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", + "format": "date-time", + "type": "string" + }, + "From": { + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the message's author.", + "type": "string" + }, + "LastUpdatedBy": { + "description": "The [Identity](https://www.twilio.com/docs/chat/identity) of the User who last updated the Message, if applicable.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7011,7 +6617,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.message" } } - } + }, + "description": "OK" } }, "security": [ @@ -7119,7 +6726,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7154,89 +6762,68 @@ "schema": { "type": "string" } - }, - { - "description": "The type of webhook. Can be: `webhook`, `studio`, or `trigger`.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "webhook", - "trigger", - "studio" - ], - "type": "string" - } - }, - { - "description": "The URL of the webhook to call using the `configuration.method`.", - "in": "query", - "name": "Configuration.Url", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "Configuration.Method", - "required": false, - "schema": { - "enum": [ - "GET", - "POST" - ], - "type": "string" - } - }, - { - "description": "The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).", - "in": "query", - "name": "Configuration.Filters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.", - "in": "query", - "name": "Configuration.Triggers", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`.", - "in": "query", - "name": "Configuration.FlowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", - "in": "query", - "name": "Configuration.RetryCount", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Configuration.Filters": { + "description": "The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.FlowSid": { + "description": "The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` is `studio`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration.Method": { + "description": "The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "GET", + "POST" + ], + "type": "string" + }, + "Configuration.RetryCount": { + "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", + "type": "integer" + }, + "Configuration.Triggers": { + "description": "A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.Url": { + "description": "The URL of the webhook to call using the `configuration.method`.", + "type": "string" + }, + "Type": { + "description": "The type of webhook. Can be: `webhook`, `studio`, or `trigger`.", + "enum": [ + "webhook", + "trigger", + "studio" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -7245,7 +6832,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" } } - } + }, + "description": "Created" } }, "security": [ @@ -7366,7 +6954,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -7385,103 +6974,84 @@ "description": "The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) with the Channel that has the Webhook resource to update.", "in": "path", "name": "ServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Channel Webhook resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WH[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The URL of the webhook to call using the `configuration.method`.", - "in": "query", - "name": "Configuration.Url", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "Configuration.Method", - "required": false, - "schema": { - "enum": [ - "GET", - "POST" - ], - "type": "string" - } - }, - { - "description": "The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).", - "in": "query", - "name": "Configuration.Filters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" } }, { - "description": "A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.", - "in": "query", - "name": "Configuration.Triggers", - "required": false, + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) the Channel Webhook resource to update belongs to. This value can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, "schema": { - "items": { - "type": "string" - }, - "type": "array" + "type": "string" } }, { - "description": "The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` = `studio`.", - "in": "query", - "name": "Configuration.FlowSid", - "required": false, + "description": "The SID of the Channel Webhook resource to update.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", + "pattern": "^WH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", - "in": "query", - "name": "Configuration.RetryCount", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Configuration.Filters": { + "description": "The events that cause us to call the Channel Webhook. Used when `type` is `webhook`. This parameter takes only one event. To specify more than one event, repeat this parameter for each event. For the list of possible events, see [Webhook Event Triggers](https://www.twilio.com/docs/chat/webhook-events#webhook-event-trigger).", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.FlowSid": { + "description": "The SID of the Studio [Flow](https://www.twilio.com/docs/studio/rest-api/flow) to call when an event in `configuration.filters` occurs. Used only when `type` = `studio`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration.Method": { + "description": "The HTTP method used to call `configuration.url`. Can be: `GET` or `POST` and the default is `POST`.", + "enum": [ + "GET", + "POST" + ], + "type": "string" + }, + "Configuration.RetryCount": { + "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", + "type": "integer" + }, + "Configuration.Triggers": { + "description": "A string that will cause us to call the webhook when it is present in a message body. This parameter takes only one trigger string. To specify more than one, repeat this parameter for each trigger string up to a total of 5 trigger strings. Used only when `type` = `trigger`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.Url": { + "description": "The URL of the webhook to call using the `configuration.method`.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7490,7 +7060,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel.channel_webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -7587,7 +7158,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -7622,64 +7194,45 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 256 characters or less in length and unique within the Service.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The `identity` of the User that created the channel. Default is: `system`.", - "in": "query", - "name": "CreatedBy", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "CreatedBy": { + "description": "The `identity` of the User that created the channel. Default is: `system`.", + "type": "string" + }, + "DateCreated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was created. The default value is the current time set by the Chat service. Note that this should only be used in cases where a Channel is being recreated from a backup/separate source.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, to assign to the resource as the date it was last updated.", + "format": "date-time", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 256 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's `sid` in the URL. This value must be 256 characters or less in length and unique within the Service.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7688,7 +7241,8 @@ "$ref": "#/components/schemas/chat.v2.service.channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -7786,7 +7340,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7812,42 +7367,43 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "channel", - "deployment" - ], - "type": "string" - } - }, - { - "description": "A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.", - "in": "query", - "name": "Permission", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. It can be up to 64 characters long.", + "type": "string" + }, + "Permission": { + "description": "A permission that you grant to the new role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. The values for this parameter depend on the role's `type`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Type": { + "description": "The type of role. Can be: `channel` for [Channel](https://www.twilio.com/docs/chat/channels) roles or `deployment` for [Service](https://www.twilio.com/docs/chat/rest/service-resource) roles.", + "enum": [ + "channel", + "deployment" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Type", + "Permission" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -7856,7 +7412,8 @@ "$ref": "#/components/schemas/chat.v2.service.role" } } - } + }, + "description": "Created" } }, "security": [ @@ -7960,7 +7517,8 @@ "$ref": "#/components/schemas/chat.v2.service.role" } } - } + }, + "description": "OK" } }, "security": [ @@ -7998,20 +7556,29 @@ "pattern": "^RL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.", - "in": "query", - "name": "Permission", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Permission": { + "description": "A permission that you grant to the role. Only one permission can be granted per parameter. To assign more than one permission, repeat this parameter for each permission value. Note that the update action replaces all previously assigned permissions with those defined in the update action. To remove a permission, do not include it in the subsequent update action. The values for this parameter depend on the role's `type`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Permission" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -8020,7 +7587,8 @@ "$ref": "#/components/schemas/chat.v2.service.role" } } - } + }, + "description": "OK" } }, "security": [ @@ -8118,7 +7686,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -8144,47 +7713,41 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or email address. See the Identity documentation for more info.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new User.", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the new resource. This value is often used for display purposes.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new resource. This value is often used for display purposes.", + "type": "string" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/chat/rest/service-resource). This value is often a username or email address. See the Identity documentation for more info.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the new User.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identity" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -8193,7 +7756,8 @@ "$ref": "#/components/schemas/chat.v2.service.user" } } - } + }, + "description": "Created" } }, "security": [ @@ -8292,7 +7856,8 @@ "$ref": "#/components/schemas/chat.v2.service.user" } } - } + }, + "description": "OK" } }, "security": [ @@ -8327,38 +7892,34 @@ "schema": { "type": "string" } - }, - { - "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the User.", - "in": "query", - "name": "RoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A valid JSON string that contains application-specific data.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It is often used for display purposes.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A valid JSON string that contains application-specific data.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It is often used for display purposes.", + "type": "string" + }, + "RoleSid": { + "description": "The SID of the [Role](https://www.twilio.com/docs/chat/rest/role-resource) to assign to the User.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -8367,7 +7928,8 @@ "$ref": "#/components/schemas/chat.v2.service.user" } } - } + }, + "description": "OK" } }, "security": [ @@ -8422,7 +7984,6 @@ "description": "The push technology used by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`. See [push notification configuration](https://www.twilio.com/docs/chat/push-notification-configuration) for more info.", "in": "query", "name": "BindingType", - "required": false, "schema": { "items": { "enum": [ @@ -8492,7 +8053,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -8615,7 +8177,8 @@ "$ref": "#/components/schemas/chat.v2.service.user.user_binding" } } - } + }, + "description": "OK" } }, "security": [ @@ -8723,7 +8286,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -8838,7 +8402,8 @@ "$ref": "#/components/schemas/chat.v2.service.user.user_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -8859,64 +8424,60 @@ "name": "ServiceSid", "required": true, "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to update the User Channel resource from. This value can be either the `sid` or the `identity` of the User resource.", - "in": "path", - "name": "UserSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) with the User Channel resource to update. This value can be the Channel resource's `sid` or `unique_name`.", - "in": "path", - "name": "ChannelSid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The push notification level to assign to the User Channel. Can be: `default` or `muted`.", - "in": "query", - "name": "NotificationLevel", - "required": false, - "schema": { - "enum": [ - "default", - "muted" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.", - "in": "query", - "name": "LastConsumedMessageIndex", - "required": false, + "description": "The SID of the [User](https://www.twilio.com/docs/chat/rest/user-resource) to update the User Channel resource from. This value can be either the `sid` or the `identity` of the User resource.", + "in": "path", + "name": "UserSid", + "required": true, "schema": { - "nullable": true, - "type": "integer" + "type": "string" } }, { - "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).", - "in": "query", - "name": "LastConsumptionTimestamp", - "required": false, + "description": "The SID of the [Channel](https://www.twilio.com/docs/chat/channels) with the User Channel resource to update. This value can be the Channel resource's `sid` or `unique_name`.", + "in": "path", + "name": "ChannelSid", + "required": true, "schema": { - "format": "date-time", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "LastConsumedMessageIndex": { + "description": "The index of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) in the [Channel](https://www.twilio.com/docs/chat/channels) that the Member has read.", + "nullable": true, + "type": "integer" + }, + "LastConsumptionTimestamp": { + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp of the last [Message](https://www.twilio.com/docs/chat/rest/message-resource) read event for the Member within the [Channel](https://www.twilio.com/docs/chat/channels).", + "format": "date-time", + "type": "string" + }, + "NotificationLevel": { + "description": "The push notification level to assign to the User Channel. Can be: `default` or `muted`.", + "enum": [ + "default", + "muted" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -8925,7 +8486,8 @@ "$ref": "#/components/schemas/chat.v2.service.user.user_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -9004,7 +8566,8 @@ "$ref": "#/components/schemas/chat.v2.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -9030,315 +8593,171 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The service role assigned to users when they are added to the service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.", - "in": "query", - "name": "DefaultServiceRoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The channel role assigned to users when they are added to a channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.", - "in": "query", - "name": "DefaultChannelRoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The channel role assigned to a channel creator when they join a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.", - "in": "query", - "name": "DefaultChannelCreatorRoleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.", - "in": "query", - "name": "ReadStatusEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.", - "in": "query", - "name": "ReachabilityEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.", - "in": "query", - "name": "TypingIndicatorTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.", - "in": "query", - "name": "ConsumptionReportInterval", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to send a notification when a new message is added to a channel. The default is `false`.", - "in": "query", - "name": "Notifications.NewMessage.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", - "in": "query", - "name": "Notifications.NewMessage.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The name of the sound to play when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", - "in": "query", - "name": "Notifications.NewMessage.Sound", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the new message badge is enabled. The default is `false`.", - "in": "query", - "name": "Notifications.NewMessage.BadgeCountEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to send a notification when a member is added to a channel. The default is `false`.", - "in": "query", - "name": "Notifications.AddedToChannel.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.AddedToChannel.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The name of the sound to play when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.AddedToChannel.Sound", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to send a notification to a user when they are removed from a channel. The default is `false`.", - "in": "query", - "name": "Notifications.RemovedFromChannel.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.RemovedFromChannel.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The name of the sound to play to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.RemovedFromChannel.Sound", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to send a notification when a user is invited to a channel. The default is `false`.", - "in": "query", - "name": "Notifications.InvitedToChannel.Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.InvitedToChannel.Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The name of the sound to play when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", - "in": "query", - "name": "Notifications.InvitedToChannel.Sound", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "in": "query", - "name": "PreWebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "in": "query", - "name": "PostWebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The list of webhook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", - "in": "query", - "name": "WebhookFilters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.", - "in": "query", - "name": "Limits.ChannelMembers", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.", - "in": "query", - "name": "Limits.UserChannels", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The message to send when a media message has no text. Can be used as placeholder message.", - "in": "query", - "name": "Media.CompatibilityMessage", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.", - "in": "query", - "name": "PreWebhookRetryCount", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.", - "in": "query", - "name": "PostWebhookRetryCount", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to log notifications. The default is `false`.", - "in": "query", - "name": "Notifications.LogEnabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ConsumptionReportInterval": { + "description": "DEPRECATED. The interval in seconds between consumption reports submission batches from client endpoints.", + "type": "integer" + }, + "DefaultChannelCreatorRoleSid": { + "description": "The channel role assigned to a channel creator when they join a new channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultChannelRoleSid": { + "description": "The channel role assigned to users when they are added to a channel. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultServiceRoleSid": { + "description": "The service role assigned to users when they are added to the service. See the [Role resource](https://www.twilio.com/docs/chat/rest/role-resource) for more info about roles.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource.", + "type": "string" + }, + "Limits.ChannelMembers": { + "description": "The maximum number of Members that can be added to Channels within this Service. Can be up to 1,000.", + "type": "integer" + }, + "Limits.UserChannels": { + "description": "The maximum number of Channels Users can be a Member of within this Service. Can be up to 1,000.", + "type": "integer" + }, + "Media.CompatibilityMessage": { + "description": "The message to send when a media message has no text. Can be used as placeholder message.", + "type": "string" + }, + "Notifications.AddedToChannel.Enabled": { + "description": "Whether to send a notification when a member is added to a channel. The default is `false`.", + "type": "boolean" + }, + "Notifications.AddedToChannel.Sound": { + "description": "The name of the sound to play when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.AddedToChannel.Template": { + "description": "The template to use to create the notification text displayed when a member is added to a channel and `notifications.added_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.InvitedToChannel.Enabled": { + "description": "Whether to send a notification when a user is invited to a channel. The default is `false`.", + "type": "boolean" + }, + "Notifications.InvitedToChannel.Sound": { + "description": "The name of the sound to play when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.InvitedToChannel.Template": { + "description": "The template to use to create the notification text displayed when a user is invited to a channel and `notifications.invited_to_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.LogEnabled": { + "description": "Whether to log notifications. The default is `false`.", + "type": "boolean" + }, + "Notifications.NewMessage.BadgeCountEnabled": { + "description": "Whether the new message badge is enabled. The default is `false`.", + "type": "boolean" + }, + "Notifications.NewMessage.Enabled": { + "description": "Whether to send a notification when a new message is added to a channel. The default is `false`.", + "type": "boolean" + }, + "Notifications.NewMessage.Sound": { + "description": "The name of the sound to play when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", + "type": "string" + }, + "Notifications.NewMessage.Template": { + "description": "The template to use to create the notification text displayed when a new message is added to a channel and `notifications.new_message.enabled` is `true`.", + "type": "string" + }, + "Notifications.RemovedFromChannel.Enabled": { + "description": "Whether to send a notification to a user when they are removed from a channel. The default is `false`.", + "type": "boolean" + }, + "Notifications.RemovedFromChannel.Sound": { + "description": "The name of the sound to play to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", + "type": "string" + }, + "Notifications.RemovedFromChannel.Template": { + "description": "The template to use to create the notification text displayed to a user when they are removed from a channel and `notifications.removed_from_channel.enabled` is `true`.", + "type": "string" + }, + "PostWebhookRetryCount": { + "description": "The number of times to retry a call to the `post_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. The default is 0, which means the call won't be retried.", + "type": "integer" + }, + "PostWebhookUrl": { + "description": "The URL for post-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "format": "uri", + "type": "string" + }, + "PreWebhookRetryCount": { + "description": "The number of times to retry a call to the `pre_webhook_url` if the request times out (after 5 seconds) or it receives a 429, 503, or 504 HTTP response. Default retry count is 0 times, which means the call won't be retried.", + "type": "integer" + }, + "PreWebhookUrl": { + "description": "The URL for pre-event webhooks, which are called by using the `webhook_method`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "format": "uri", + "type": "string" + }, + "ReachabilityEnabled": { + "description": "Whether to enable the [Reachability Indicator](https://www.twilio.com/docs/chat/reachability-indicator) for this Service instance. The default is `false`.", + "type": "boolean" + }, + "ReadStatusEnabled": { + "description": "Whether to enable the [Message Consumption Horizon](https://www.twilio.com/docs/chat/consumption-horizon) feature. The default is `true`.", + "type": "boolean" + }, + "TypingIndicatorTimeout": { + "description": "How long in seconds after a `started typing` event until clients should assume that user is no longer typing, even if no `ended typing` message was received. The default is 5 seconds.", + "type": "integer" + }, + "WebhookFilters": { + "description": "The list of webhook events that are enabled for this Service instance. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "items": { + "type": "string" + }, + "type": "array" + }, + "WebhookMethod": { + "description": "The HTTP method to use for calls to the `pre_webhook_url` and `post_webhook_url` webhooks. Can be: `POST` or `GET` and the default is `POST`. See [Webhook Events](https://www.twilio.com/docs/chat/webhook-events) for more details.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -9347,7 +8766,8 @@ "$ref": "#/components/schemas/chat.v2.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_conversations.json b/src/services/twilio-api/twilio_conversations.json index e09254a6..ffd30eea 100644 --- a/src/services/twilio-api/twilio_conversations.json +++ b/src/services/twilio-api/twilio_conversations.json @@ -323,7 +323,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -337,58 +338,42 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date that this resource was created.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date that this resource was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The unique id of the [SMS Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to.", - "in": "query", - "name": "MessagingServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "type": "string" + }, + "DateCreated": { + "description": "The date that this resource was created.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date that this resource was last updated.", + "format": "date-time", + "type": "string" + }, + "FriendlyName": { + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "type": "string" + }, + "MessagingServiceSid": { + "description": "The unique id of the [SMS Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -397,7 +382,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation" } } - } + }, + "description": "Created" } }, "security": [ @@ -426,7 +412,6 @@ "description": "TODO: Resource-level docs", "get": { "description": "", - "parameters": [], "responses": { "200": { "content": { @@ -435,7 +420,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation_webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -449,60 +435,44 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The HTTP method to be used when sending a webhook request.", - "in": "query", - "name": "Method", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`", - "in": "query", - "name": "Filters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The absolute url the pre-event webhook request should be sent to.", - "in": "query", - "name": "PreWebhookUrl", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The absolute url the post-event webhook request should be sent to.", - "in": "query", - "name": "PostWebhookUrl", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The routing target of the webhook. Can be ordinary or route internally to Flex", - "in": "query", - "name": "Target", - "required": false, - "schema": { - "enum": [ - "webhook", - "flex" - ], - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Filters": { + "description": "The list of webhook event triggers that are enabled for this Service: `onMessageAdded`, `onMessageUpdated`, `onMessageRemoved`, `onConversationUpdated`, `onConversationRemoved`, `onParticipantAdded`, `onParticipantUpdated`, `onParticipantRemoved`", + "items": { + "type": "string" + }, + "type": "array" + }, + "Method": { + "description": "The HTTP method to be used when sending a webhook request.", + "type": "string" + }, + "PostWebhookUrl": { + "description": "The absolute url the post-event webhook request should be sent to.", + "type": "string" + }, + "PreWebhookUrl": { + "description": "The absolute url the pre-event webhook request should be sent to.", + "type": "string" + }, + "Target": { + "description": "The routing target of the webhook. Can be ordinary or route internally to Flex", + "enum": [ + "webhook", + "flex" + ], + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "200": { "content": { @@ -511,7 +481,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation_webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -610,7 +581,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -636,67 +608,48 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The channel specific identifier of the message's author. Defaults to `system`.", - "in": "query", - "name": "Author", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The content of the message, can be up to 1,600 characters long.", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date that this resource was created.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date that this resource was last updated. `null` if the message has not been edited.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The Media Sid to be attached to the new Message.", - "in": "query", - "name": "MediaSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ME[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "type": "string" + }, + "Author": { + "description": "The channel specific identifier of the message's author. Defaults to `system`.", + "type": "string" + }, + "Body": { + "description": "The content of the message, can be up to 1,600 characters long.", + "type": "string" + }, + "DateCreated": { + "description": "The date that this resource was created.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date that this resource was last updated. `null` if the message has not been edited.", + "format": "date-time", + "type": "string" + }, + "MediaSid": { + "description": "The Media Sid to be attached to the new Message.", + "maxLength": 34, + "minLength": 34, + "pattern": "^ME[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -705,7 +658,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message" } } - } + }, + "description": "Created" } }, "security": [ @@ -810,7 +764,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message" } } - } + }, + "description": "OK" } }, "security": [ @@ -848,55 +803,41 @@ "pattern": "^IM[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The channel specific identifier of the message's author. Defaults to `system`.", - "in": "query", - "name": "Author", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The content of the message, can be up to 1,600 characters long.", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date that this resource was created.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date that this resource was last updated. `null` if the message has not been edited.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "type": "string" + }, + "Author": { + "description": "The channel specific identifier of the message's author. Defaults to `system`.", + "type": "string" + }, + "Body": { + "description": "The content of the message, can be up to 1,600 characters long.", + "type": "string" + }, + "DateCreated": { + "description": "The date that this resource was created.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date that this resource was last updated. `null` if the message has not been edited.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -905,7 +846,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_message" } } - } + }, + "description": "OK" } }, "security": [ @@ -1004,7 +946,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1030,73 +973,49 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A unique string identifier for the conversation participant as [Chat User](https://www.twilio.com/docs/chat/rest/user-resource). This parameter is non-null if (and only if) the participant is using the Programmable Chat SDK to communicate. Limited to 256 characters.", - "in": "query", - "name": "Identity", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The address of the participant's device, e.g. a phone number or Messenger ID. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from a Chat endpoint (see the 'identity' field).", - "in": "query", - "name": "MessagingBinding.Address", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The address of the Twilio phone number (or WhatsApp number, or Messenger Page ID) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from a Chat endpoint (see the 'identity' field).", - "in": "query", - "name": "MessagingBinding.ProxyAddress", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date that this resource was created.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date that this resource was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The address of the Twilio phone number that is used in Group MMS. Communication mask for the Chat participant with Identity.", - "in": "query", - "name": "MessagingBinding.ProjectedAddress", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "type": "string" + }, + "DateCreated": { + "description": "The date that this resource was created.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date that this resource was last updated.", + "format": "date-time", + "type": "string" + }, + "Identity": { + "description": "A unique string identifier for the conversation participant as [Chat User](https://www.twilio.com/docs/chat/rest/user-resource). This parameter is non-null if (and only if) the participant is using the Programmable Chat SDK to communicate. Limited to 256 characters.", + "type": "string" + }, + "MessagingBinding.Address": { + "description": "The address of the participant's device, e.g. a phone number or Messenger ID. Together with the Proxy address, this determines a participant uniquely. This field (with proxy_address) is only null when the participant is interacting from a Chat endpoint (see the 'identity' field).", + "type": "string" + }, + "MessagingBinding.ProjectedAddress": { + "description": "The address of the Twilio phone number that is used in Group MMS. Communication mask for the Chat participant with Identity.", + "type": "string" + }, + "MessagingBinding.ProxyAddress": { + "description": "The address of the Twilio phone number (or WhatsApp number, or Messenger Page ID) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from a Chat endpoint (see the 'identity' field).", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1105,7 +1024,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" } } - } + }, + "description": "Created" } }, "security": [ @@ -1208,7 +1128,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" } } - } + }, + "description": "OK" } }, "security": [ @@ -1246,37 +1167,33 @@ "pattern": "^MB[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The date that this resource was created.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date that this resource was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "type": "string" + }, + "DateCreated": { + "description": "The date that this resource was created.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date that this resource was last updated.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1285,7 +1202,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_participant" } } - } + }, + "description": "OK" } }, "security": [ @@ -1382,7 +1300,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1408,89 +1327,68 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The target of this webhook: `webhook`, `studio`, `trigger`", - "in": "query", - "name": "Target", - "required": true, - "schema": { - "enum": [ - "webhook", - "trigger", - "studio" - ], - "type": "string" - } - }, - { - "description": "The absolute url the webhook request should be sent to.", - "in": "query", - "name": "Configuration.Url", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method to be used when sending a webhook request.", - "in": "query", - "name": "Configuration.Method", - "required": false, - "schema": { - "enum": [ - "GET", - "POST" - ], - "type": "string" - } - }, - { - "description": "The list of events, firing webhook event for this Conversation.", - "in": "query", - "name": "Configuration.Filters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The list of keywords, firing webhook event for this Conversation.", - "in": "query", - "name": "Configuration.Triggers", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The studio flow sid, where the webhook should be sent to.", - "in": "query", - "name": "Configuration.FlowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The message index for which and it's successors the webhook will be replayed. Not set by default", - "in": "query", - "name": "Configuration.ReplayAfter", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Configuration.Filters": { + "description": "The list of events, firing webhook event for this Conversation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.FlowSid": { + "description": "The studio flow sid, where the webhook should be sent to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration.Method": { + "description": "The HTTP method to be used when sending a webhook request.", + "enum": [ + "GET", + "POST" + ], + "type": "string" + }, + "Configuration.ReplayAfter": { + "description": "The message index for which and it's successors the webhook will be replayed. Not set by default", + "type": "integer" + }, + "Configuration.Triggers": { + "description": "The list of keywords, firing webhook event for this Conversation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.Url": { + "description": "The absolute url the webhook request should be sent to.", + "type": "string" + }, + "Target": { + "description": "The target of this webhook: `webhook`, `studio`, `trigger`", + "enum": [ + "webhook", + "trigger", + "studio" + ], + "type": "string" + } + }, + "required": [ + "Target" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1499,7 +1397,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" } } - } + }, + "description": "Created" } }, "security": [ @@ -1602,7 +1501,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -1640,66 +1540,52 @@ "pattern": "^WH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The absolute url the webhook request should be sent to.", - "in": "query", - "name": "Configuration.Url", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method to be used when sending a webhook request.", - "in": "query", - "name": "Configuration.Method", - "required": false, - "schema": { - "enum": [ - "GET", - "POST" - ], - "type": "string" - } - }, - { - "description": "The list of events, firing webhook event for this Conversation.", - "in": "query", - "name": "Configuration.Filters", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The list of keywords, firing webhook event for this Conversation.", - "in": "query", - "name": "Configuration.Triggers", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The studio flow sid, where the webhook should be sent to.", - "in": "query", - "name": "Configuration.FlowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Configuration.Filters": { + "description": "The list of events, firing webhook event for this Conversation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.FlowSid": { + "description": "The studio flow sid, where the webhook should be sent to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration.Method": { + "description": "The HTTP method to be used when sending a webhook request.", + "enum": [ + "GET", + "POST" + ], + "type": "string" + }, + "Configuration.Triggers": { + "description": "The list of keywords, firing webhook event for this Conversation.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Configuration.Url": { + "description": "The absolute url the webhook request should be sent to.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1708,7 +1594,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation.conversation_scoped_webhook" } } - } + }, + "description": "OK" } }, "security": [ @@ -1787,7 +1674,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation" } } - } + }, + "description": "OK" } }, "security": [ @@ -1813,58 +1701,44 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The date that this resource was created.", - "in": "query", - "name": "DateCreated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The date that this resource was last updated.", - "in": "query", - "name": "DateUpdated", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique id of the [SMS Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to.", - "in": "query", - "name": "MessagingServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. **Note** that if the attributes are not set \"{}\" will be returned.", + "type": "string" + }, + "DateCreated": { + "description": "The date that this resource was created.", + "format": "date-time", + "type": "string" + }, + "DateUpdated": { + "description": "The date that this resource was last updated.", + "format": "date-time", + "type": "string" + }, + "FriendlyName": { + "description": "The human-readable name of this conversation, limited to 256 characters. Optional.", + "type": "string" + }, + "MessagingServiceSid": { + "description": "The unique id of the [SMS Service](https://www.twilio.com/docs/sms/services/api) this conversation belongs to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1873,7 +1747,8 @@ "$ref": "#/components/schemas/conversations.v1.conversation" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_fax.json b/src/services/twilio-api/twilio_fax.json index bc2de99f..b28b03fa 100644 --- a/src/services/twilio-api/twilio_fax.json +++ b/src/services/twilio-api/twilio_fax.json @@ -167,7 +167,6 @@ "description": "Retrieve only those faxes sent from this phone number, specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.", "in": "query", "name": "From", - "required": false, "schema": { "type": "string" } @@ -176,7 +175,6 @@ "description": "Retrieve only those faxes sent to this phone number, specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format.", "in": "query", "name": "To", - "required": false, "schema": { "type": "string" } @@ -185,7 +183,6 @@ "description": "Retrieve only those faxes with a `date_created` that is before or equal to this value, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "DateCreatedOnOrBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -195,7 +192,6 @@ "description": "Retrieve only those faxes with a `date_created` that is later than this value, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -258,7 +254,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -272,96 +269,64 @@ }, "post": { "description": "Create a new fax to send to a phone number or SIP endpoint.", - "parameters": [ - { - "description": "The phone number to receive the fax in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the recipient's SIP URI.", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL of the PDF that contains the fax. See our [security](https://www.twilio.com/docs/usage/security) page for information on how to ensure the request for your media comes from Twilio.", - "in": "query", - "name": "MediaUrl", - "required": true, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The [Fax Quality value](https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values) that describes the fax quality. Can be: `standard`, `fine`, or `superfine` and defaults to `fine`.", - "in": "query", - "name": "Quality", - "required": false, - "schema": { - "enum": [ - "standard", - "fine", - "superfine" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `POST` method to send [status information](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback) to your application when the status of the fax changes.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The number the fax was sent from. Can be the phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the SIP `from` value. The caller ID displayed to the recipient uses this value. If this is a phone number, it must be a Twilio number or a verified outgoing caller id from your account. If `to` is a SIP address, this can be any alphanumeric string (and also the characters `+`, `_`, `.`, and `-`), which will be used in the `from` header of the SIP request.", - "in": "query", - "name": "From", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The username to use with the `sip_auth_password` to authenticate faxes sent to a SIP address.", - "in": "query", - "name": "SipAuthUsername", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The password to use with `sip_auth_username` to authenticate faxes sent to a SIP address.", - "in": "query", - "name": "SipAuthPassword", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to store a copy of the sent media on our servers for later retrieval. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "StoreMedia", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "How long in minutes from when the fax is initiated that we should try to send the fax.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The number the fax was sent from. Can be the phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the SIP `from` value. The caller ID displayed to the recipient uses this value. If this is a phone number, it must be a Twilio number or a verified outgoing caller id from your account. If `to` is a SIP address, this can be any alphanumeric string (and also the characters `+`, `_`, `.`, and `-`), which will be used in the `from` header of the SIP request.", + "type": "string" + }, + "MediaUrl": { + "description": "The URL of the PDF that contains the fax. See our [security](https://www.twilio.com/docs/usage/security) page for information on how to ensure the request for your media comes from Twilio.", + "format": "uri", + "type": "string" + }, + "Quality": { + "description": "The [Fax Quality value](https://www.twilio.com/docs/fax/api/fax-resource#fax-quality-values) that describes the fax quality. Can be: `standard`, `fine`, or `superfine` and defaults to `fine`.", + "enum": [ + "standard", + "fine", + "superfine" + ], + "type": "string" + }, + "SipAuthPassword": { + "description": "The password to use with `sip_auth_username` to authenticate faxes sent to a SIP address.", + "type": "string" + }, + "SipAuthUsername": { + "description": "The username to use with the `sip_auth_password` to authenticate faxes sent to a SIP address.", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `POST` method to send [status information](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-callback) to your application when the status of the fax changes.", + "format": "uri", + "type": "string" + }, + "StoreMedia": { + "description": "Whether to store a copy of the sent media on our servers for later retrieval. Can be: `true` or `false` and the default is `true`.", + "type": "boolean" + }, + "To": { + "description": "The phone number to receive the fax in [E.164](https://www.twilio.com/docs/glossary/what-e164) format or the recipient's SIP URI.", + "type": "string" + }, + "Ttl": { + "description": "How long in minutes from when the fax is initiated that we should try to send the fax.", + "type": "integer" + } + }, + "required": [ + "To", + "MediaUrl" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -370,7 +335,8 @@ "$ref": "#/components/schemas/fax.v1.fax" } } - } + }, + "description": "Created" } }, "security": [ @@ -470,7 +436,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -573,7 +540,8 @@ "$ref": "#/components/schemas/fax.v1.fax.fax_media" } } - } + }, + "description": "OK" } }, "security": [ @@ -652,7 +620,8 @@ "$ref": "#/components/schemas/fax.v1.fax" } } - } + }, + "description": "OK" } }, "security": [ @@ -678,20 +647,26 @@ "pattern": "^FX[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The new [status](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values) of the resource. Can be only `canceled`. This may fail if transmission has already started.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "canceled" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The new [status](https://www.twilio.com/docs/fax/api/fax-resource#fax-status-values) of the resource. Can be only `canceled`. This may fail if transmission has already started.", + "enum": [ + "canceled" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -700,7 +675,8 @@ "$ref": "#/components/schemas/fax.v1.fax" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_flex.json b/src/services/twilio-api/twilio_flex.json index 4814e9c7..36c5bfdd 100644 --- a/src/services/twilio-api/twilio_flex.json +++ b/src/services/twilio-api/twilio_flex.json @@ -409,7 +409,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -423,104 +424,69 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The SID of the FlexFlow.", - "in": "query", - "name": "FlexFlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's chat User.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The chat participant's friendly name.", - "in": "query", - "name": "ChatUserFriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The chat channel's friendly name.", - "in": "query", - "name": "ChatFriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Target Contact Identity, for example the phone number of an SMS.", - "in": "query", - "name": "Target", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The chat channel's unique name.", - "in": "query", - "name": "ChatUniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The pre-engagement data.", - "in": "query", - "name": "PreEngagementData", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the TaskRouter task.", - "in": "query", - "name": "TaskSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WT[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The task attributes to be added for the TaskRouter Task.", - "in": "query", - "name": "TaskAttributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to create the channel as long-lived.", - "in": "query", - "name": "LongLived", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChatFriendlyName": { + "description": "The chat channel's friendly name.", + "type": "string" + }, + "ChatUniqueName": { + "description": "The chat channel's unique name.", + "type": "string" + }, + "ChatUserFriendlyName": { + "description": "The chat participant's friendly name.", + "type": "string" + }, + "FlexFlowSid": { + "description": "The SID of the FlexFlow.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$", + "type": "string" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's chat User.", + "type": "string" + }, + "LongLived": { + "description": "Whether to create the channel as long-lived.", + "type": "boolean" + }, + "PreEngagementData": { + "description": "The pre-engagement data.", + "type": "string" + }, + "Target": { + "description": "The Target Contact Identity, for example the phone number of an SMS.", + "type": "string" + }, + "TaskAttributes": { + "description": "The task attributes to be added for the TaskRouter Task.", + "type": "string" + }, + "TaskSid": { + "description": "The SID of the TaskRouter task.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WT[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "FlexFlowSid", + "Identity", + "ChatUserFriendlyName", + "ChatFriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -529,7 +495,8 @@ "$ref": "#/components/schemas/flex.v1.channel" } } - } + }, + "description": "Created" } }, "security": [ @@ -610,7 +577,8 @@ "$ref": "#/components/schemas/flex.v1.channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -644,7 +612,6 @@ "description": "The Pinned UI version of the Configuration resource to fetch.", "in": "query", "name": "UiVersion", - "required": false, "schema": { "type": "string" } @@ -658,7 +625,8 @@ "$ref": "#/components/schemas/flex.v1.configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -672,7 +640,16 @@ }, "post": { "description": "", - "parameters": [], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": {}, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -681,7 +658,8 @@ "$ref": "#/components/schemas/flex.v1.configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -715,7 +693,6 @@ "description": "The `friendly_name` of the FlexFlow resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -777,7 +754,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -791,187 +769,116 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the FlexFlow resource.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the chat service.", - "in": "query", - "name": "ChatServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The channel type. Can be: `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`.", - "in": "query", - "name": "ChannelType", - "required": true, - "schema": { - "enum": [ - "web", - "sms", - "facebook", - "whatsapp", - "line", - "custom" - ], - "type": "string" - } - }, - { - "description": "The channel contact's Identity.", - "in": "query", - "name": "ContactIdentity", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the new FlexFlow is enabled.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The integration type. Can be: `studio`, `external`, or `task`.", - "in": "query", - "name": "IntegrationType", - "required": false, - "schema": { - "enum": [ - "studio", - "external", - "task" - ], - "type": "string" - } - }, - { - "description": "The SID of the Flow when `integration_type` is `studio`.", - "in": "query", - "name": "Integration.FlowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The External Webhook URL when `integration_type` is `external`.", - "in": "query", - "name": "Integration.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The Workspace SID for a new task for Task `integration_type`.", - "in": "query", - "name": "Integration.WorkspaceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Workflow SID for a new task when `integration_type` is `task`.", - "in": "query", - "name": "Integration.WorkflowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The task channel for a new task when `integration_type` is `task`. The default is `default`.", - "in": "query", - "name": "Integration.Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The task timeout in seconds for a new task when `integration_type` is `task`. The default is `86,400` seconds (24 hours).", - "in": "query", - "name": "Integration.Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The task priority of a new task when `integration_type` is `task`. The default priority is `0`.", - "in": "query", - "name": "Integration.Priority", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to create a task when the first message arrives when `integration_type` is `task`. If `false`, the task is created with the channel. **Note** that does not apply when channel type is `web`. Setting the value to `true` for channel type `web` will result in misconfigured Flex Flow and no tasks will be created.", - "in": "query", - "name": "Integration.CreationOnMessage", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether new channels are long-lived.", - "in": "query", - "name": "LongLived", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag for enabling or disabling the Janitor.", - "in": "query", - "name": "JanitorEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", - "in": "query", - "name": "Integration.RetryCount", - "required": false, - "schema": { - "type": "integer" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChannelType": { + "description": "The channel type. Can be: `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`.", + "enum": [ + "web", + "sms", + "facebook", + "whatsapp", + "line", + "custom" + ], + "type": "string" + }, + "ChatServiceSid": { + "description": "The SID of the chat service.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "ContactIdentity": { + "description": "The channel contact's Identity.", + "type": "string" + }, + "Enabled": { + "description": "Whether the new FlexFlow is enabled.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the FlexFlow resource.", + "type": "string" + }, + "Integration.Channel": { + "description": "The task channel for a new task when `integration_type` is `task`. The default is `default`.", + "type": "string" + }, + "Integration.CreationOnMessage": { + "description": "Whether to create a task when the first message arrives when `integration_type` is `task`. If `false`, the task is created with the channel. **Note** that does not apply when channel type is `web`. Setting the value to `true` for channel type `web` will result in misconfigured Flex Flow and no tasks will be created.", + "type": "boolean" + }, + "Integration.FlowSid": { + "description": "The SID of the Flow when `integration_type` is `studio`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Integration.Priority": { + "description": "The task priority of a new task when `integration_type` is `task`. The default priority is `0`.", + "type": "integer" + }, + "Integration.RetryCount": { + "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", + "type": "integer" + }, + "Integration.Timeout": { + "description": "The task timeout in seconds for a new task when `integration_type` is `task`. The default is `86,400` seconds (24 hours).", + "type": "integer" + }, + "Integration.Url": { + "description": "The External Webhook URL when `integration_type` is `external`.", + "format": "uri", + "type": "string" + }, + "Integration.WorkflowSid": { + "description": "The Workflow SID for a new task when `integration_type` is `task`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Integration.WorkspaceSid": { + "description": "The Workspace SID for a new task for Task `integration_type`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "type": "string" + }, + "IntegrationType": { + "description": "The integration type. Can be: `studio`, `external`, or `task`.", + "enum": [ + "studio", + "external", + "task" + ], + "type": "string" + }, + "JanitorEnabled": { + "description": "Boolean flag for enabling or disabling the Janitor.", + "type": "boolean" + }, + "LongLived": { + "description": "Whether new channels are long-lived.", + "type": "boolean" + } + }, + "required": [ + "FriendlyName", + "ChatServiceSid", + "ChannelType" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -980,7 +887,8 @@ "$ref": "#/components/schemas/flex.v1.flex_flow" } } - } + }, + "description": "Created" } }, "security": [ @@ -1061,7 +969,8 @@ "$ref": "#/components/schemas/flex.v1.flex_flow" } } - } + }, + "description": "OK" } }, "security": [ @@ -1087,187 +996,113 @@ "pattern": "^FO[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the FlexFlow resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the chat service.", - "in": "query", - "name": "ChatServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The channel type. Can be: `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`.", - "in": "query", - "name": "ChannelType", - "required": false, - "schema": { - "enum": [ - "web", - "sms", - "facebook", - "whatsapp", - "line", - "custom" - ], - "type": "string" - } - }, - { - "description": "The channel contact's Identity.", - "in": "query", - "name": "ContactIdentity", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the FlexFlow is enabled.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The integration type. Can be: `studio`, `external`, or `task`.", - "in": "query", - "name": "IntegrationType", - "required": false, - "schema": { - "enum": [ - "studio", - "external", - "task" - ], - "type": "string" - } - }, - { - "description": "The SID of the Flow when `integration_type` is `studio`.", - "in": "query", - "name": "Integration.FlowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The External Webhook URL when `integration_type` is `external`.", - "in": "query", - "name": "Integration.Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The Workspace SID for a new task when `integration_type` is `task`.", - "in": "query", - "name": "Integration.WorkspaceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Workflow SID for a new task when `integration_type` is `task`.", - "in": "query", - "name": "Integration.WorkflowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The task channel for a new task when `integration_type` is `task`. The default is `default`.", - "in": "query", - "name": "Integration.Channel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The task timeout in seconds for a new task when `integration_type` is `task`. The default is `86,400` seconds (24 hours).", - "in": "query", - "name": "Integration.Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The task priority of a new task when `integration_type` is `task`. The default priority is `0`.", - "in": "query", - "name": "Integration.Priority", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to create a task when the first message arrives when `integration_type` is `task`. If `false`, the task is created with the channel. **Note** that does not apply when channel type is `web`. Setting the value to `true` for channel type `web` will result in misconfigured Flex Flow and no tasks will be created.", - "in": "query", - "name": "Integration.CreationOnMessage", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether new channels created are long-lived.", - "in": "query", - "name": "LongLived", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag for enabling or disabling the Janitor.", - "in": "query", - "name": "JanitorEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", - "in": "query", - "name": "Integration.RetryCount", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChannelType": { + "description": "The channel type. Can be: `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`.", + "enum": [ + "web", + "sms", + "facebook", + "whatsapp", + "line", + "custom" + ], + "type": "string" + }, + "ChatServiceSid": { + "description": "The SID of the chat service.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "ContactIdentity": { + "description": "The channel contact's Identity.", + "type": "string" + }, + "Enabled": { + "description": "Whether the FlexFlow is enabled.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the FlexFlow resource.", + "type": "string" + }, + "Integration.Channel": { + "description": "The task channel for a new task when `integration_type` is `task`. The default is `default`.", + "type": "string" + }, + "Integration.CreationOnMessage": { + "description": "Whether to create a task when the first message arrives when `integration_type` is `task`. If `false`, the task is created with the channel. **Note** that does not apply when channel type is `web`. Setting the value to `true` for channel type `web` will result in misconfigured Flex Flow and no tasks will be created.", + "type": "boolean" + }, + "Integration.FlowSid": { + "description": "The SID of the Flow when `integration_type` is `studio`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Integration.Priority": { + "description": "The task priority of a new task when `integration_type` is `task`. The default priority is `0`.", + "type": "integer" + }, + "Integration.RetryCount": { + "description": "The number of times to retry the webhook if the first attempt fails. Can be an integer between 0 and 3, inclusive, and the default is 0.", + "type": "integer" + }, + "Integration.Timeout": { + "description": "The task timeout in seconds for a new task when `integration_type` is `task`. The default is `86,400` seconds (24 hours).", + "type": "integer" + }, + "Integration.Url": { + "description": "The External Webhook URL when `integration_type` is `external`.", + "format": "uri", + "type": "string" + }, + "Integration.WorkflowSid": { + "description": "The Workflow SID for a new task when `integration_type` is `task`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "type": "string" + }, + "Integration.WorkspaceSid": { + "description": "The Workspace SID for a new task when `integration_type` is `task`.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "type": "string" + }, + "IntegrationType": { + "description": "The integration type. Can be: `studio`, `external`, or `task`.", + "enum": [ + "studio", + "external", + "task" + ], + "type": "string" + }, + "JanitorEnabled": { + "description": "Boolean flag for enabling or disabling the Janitor.", + "type": "boolean" + }, + "LongLived": { + "description": "Whether new channels created are long-lived.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1276,7 +1111,8 @@ "$ref": "#/components/schemas/flex.v1.flex_flow" } } - } + }, + "description": "OK" } }, "security": [ @@ -1363,7 +1199,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1377,65 +1214,50 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The SID of the FlexFlow.", - "in": "query", - "name": "FlexFlowSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The chat identity.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The chat participant's friendly name.", - "in": "query", - "name": "CustomerFriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The chat channel's friendly name.", - "in": "query", - "name": "ChatFriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The chat channel's unique name.", - "in": "query", - "name": "ChatUniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The pre-engagement data.", - "in": "query", - "name": "PreEngagementData", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChatFriendlyName": { + "description": "The chat channel's friendly name.", + "type": "string" + }, + "ChatUniqueName": { + "description": "The chat channel's unique name.", + "type": "string" + }, + "CustomerFriendlyName": { + "description": "The chat participant's friendly name.", + "type": "string" + }, + "FlexFlowSid": { + "description": "The SID of the FlexFlow.", + "maxLength": 34, + "minLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$", + "type": "string" + }, + "Identity": { + "description": "The chat identity.", + "type": "string" + }, + "PreEngagementData": { + "description": "The pre-engagement data.", + "type": "string" + } + }, + "required": [ + "FlexFlowSid", + "Identity", + "CustomerFriendlyName", + "ChatFriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1444,7 +1266,8 @@ "$ref": "#/components/schemas/flex.v1.web_channel" } } - } + }, + "description": "Created" } }, "security": [ @@ -1523,7 +1346,8 @@ "$ref": "#/components/schemas/flex.v1.web_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -1549,29 +1373,30 @@ "pattern": "^CH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The chat status. Can only be `inactive`.", - "in": "query", - "name": "ChatStatus", - "required": false, - "schema": { - "enum": [ - "inactive" - ], - "type": "string" - } - }, - { - "description": "The post-engagement data.", - "in": "query", - "name": "PostEngagementData", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChatStatus": { + "description": "The chat status. Can only be `inactive`.", + "enum": [ + "inactive" + ], + "type": "string" + }, + "PostEngagementData": { + "description": "The post-engagement data.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1580,7 +1405,8 @@ "$ref": "#/components/schemas/flex.v1.web_channel" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_insights.json b/src/services/twilio-api/twilio_insights.json index 7b370f69..da43f2c5 100644 --- a/src/services/twilio-api/twilio_insights.json +++ b/src/services/twilio-api/twilio_insights.json @@ -270,7 +270,6 @@ "description": "", "in": "query", "name": "Edge", - "required": false, "schema": { "enum": [ "unknown_edge", @@ -339,7 +338,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -386,7 +386,6 @@ "description": "", "in": "query", "name": "Edge", - "required": false, "schema": { "enum": [ "unknown_edge", @@ -402,7 +401,6 @@ "description": "", "in": "query", "name": "Direction", - "required": false, "schema": { "enum": [ "unknown", @@ -470,7 +468,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -517,7 +516,6 @@ "description": "", "in": "query", "name": "ProcessingState", - "required": false, "schema": { "enum": [ "complete", @@ -535,7 +533,8 @@ "$ref": "#/components/schemas/insights.v1.call.summary" } } - } + }, + "description": "OK" } }, "security": [ @@ -586,7 +585,8 @@ "$ref": "#/components/schemas/insights.v1.call" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_lookups.json b/src/services/twilio-api/twilio_lookups.json index 052bbd71..8b739fcb 100644 --- a/src/services/twilio-api/twilio_lookups.json +++ b/src/services/twilio-api/twilio_lookups.json @@ -71,7 +71,6 @@ "description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.", "in": "query", "name": "CountryCode", - "required": false, "schema": { "type": "string" } @@ -80,7 +79,6 @@ "description": "The type of information to return. Can be: `carrier` or `caller-name`. The default is null. Carrier information costs $0.005 per phone number looked up. Caller Name information is currently available only in the US and costs $0.01 per phone number looked up. To retrieve both types on information, specify this parameter twice; once with `carrier` and once with `caller-name` as the value.", "in": "query", "name": "Type", - "required": false, "schema": { "items": { "type": "string" @@ -92,7 +90,6 @@ "description": "The `unique_name` of an Add-on you would like to invoke. Can be the `unique_name` of an Add-on that is installed on your account. You can specify multiple instances of this parameter to invoke multiple Add-ons. For more information about Add-ons, see the [Add-ons documentation](https://www.twilio.com/docs/add-ons).", "in": "query", "name": "AddOns", - "required": false, "schema": { "items": { "type": "string" @@ -104,7 +101,6 @@ "description": "Data specific to the add-on you would like to invoke. The content and format of this value depends on the add-on.", "in": "query", "name": "AddOnsData", - "required": false, "schema": { "type": "object" } @@ -118,7 +114,8 @@ "$ref": "#/components/schemas/lookups.v1.phone_number" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_messaging.json b/src/services/twilio-api/twilio_messaging.json index 462a7967..cdf9e5c7 100644 --- a/src/services/twilio-api/twilio_messaging.json +++ b/src/services/twilio-api/twilio_messaging.json @@ -336,7 +336,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -350,170 +351,112 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled.", - "in": "query", - "name": "InboundRequestUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "InboundMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL.", - "in": "query", - "name": "FallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "FallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.", - "in": "query", - "name": "StickySender", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.", - "in": "query", - "name": "MmsConverter", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.", - "in": "query", - "name": "SmartEncoding", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "ScanMessageContent", - "required": false, - "schema": { - "enum": [ - "inherit", - "enable", - "disable" - ], - "type": "string" - } - }, - { - "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.", - "in": "query", - "name": "FallbackToLongCode", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.", - "in": "query", - "name": "AreaCodeGeomatch", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.", - "in": "query", - "name": "ValidityPeriod", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "SynchronousValidation", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AreaCodeGeomatch": { + "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.", + "type": "boolean" + }, + "FallbackMethod": { + "description": "The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackToLongCode": { + "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.", + "type": "boolean" + }, + "FallbackUrl": { + "description": "The URL that we should call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "InboundMethod": { + "description": "The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "InboundRequestUrl": { + "description": "The URL we should call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled.", + "format": "uri", + "type": "string" + }, + "MmsConverter": { + "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.", + "type": "boolean" + }, + "ScanMessageContent": { + "description": "Reserved.", + "enum": [ + "inherit", + "enable", + "disable" + ], + "type": "string" + }, + "SmartEncoding": { + "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.", + "format": "uri", + "type": "string" + }, + "StickySender": { + "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.", + "type": "boolean" + }, + "SynchronousValidation": { + "description": "Reserved.", + "type": "boolean" + }, + "ValidityPeriod": { + "description": "How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.", + "type": "integer" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -522,7 +465,8 @@ "$ref": "#/components/schemas/messaging.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -620,7 +564,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -646,17 +591,26 @@ "pattern": "^MG[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, and hyphen `-`. This value cannot contain only numbers.", - "in": "query", - "name": "AlphaSender", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AlphaSender": { + "description": "The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, and hyphen `-`. This value cannot contain only numbers.", + "type": "string" + } + }, + "required": [ + "AlphaSender" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -665,7 +619,8 @@ "$ref": "#/components/schemas/messaging.v1.service.alpha_sender" } } - } + }, + "description": "Created" } }, "security": [ @@ -762,7 +717,8 @@ "$ref": "#/components/schemas/messaging.v1.service.alpha_sender" } } - } + }, + "description": "OK" } }, "security": [ @@ -859,7 +815,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -885,20 +842,29 @@ "pattern": "^MG[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the Phone Number being added to the Service.", - "in": "query", - "name": "PhoneNumberSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "PhoneNumberSid": { + "description": "The SID of the Phone Number being added to the Service.", + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "PhoneNumberSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -907,7 +873,8 @@ "$ref": "#/components/schemas/messaging.v1.service.phone_number" } } - } + }, + "description": "Created" } }, "security": [ @@ -1005,7 +972,8 @@ "$ref": "#/components/schemas/messaging.v1.service.phone_number" } } - } + }, + "description": "OK" } }, "security": [ @@ -1103,7 +1071,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1129,20 +1098,29 @@ "pattern": "^MG[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the ShortCode resource being added to the Service.", - "in": "query", - "name": "ShortCodeSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SC[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ShortCodeSid": { + "description": "The SID of the ShortCode resource being added to the Service.", + "maxLength": 34, + "minLength": 34, + "pattern": "^SC[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "ShortCodeSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1151,7 +1129,8 @@ "$ref": "#/components/schemas/messaging.v1.service.short_code" } } - } + }, + "description": "Created" } }, "security": [ @@ -1249,7 +1228,8 @@ "$ref": "#/components/schemas/messaging.v1.service.short_code" } } - } + }, + "description": "OK" } }, "security": [ @@ -1329,7 +1309,8 @@ "$ref": "#/components/schemas/messaging.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -1355,170 +1336,111 @@ "pattern": "^MG[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled.", - "in": "query", - "name": "InboundRequestUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.", - "in": "query", - "name": "InboundMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL that we should call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL.", - "in": "query", - "name": "FallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "FallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.", - "in": "query", - "name": "StickySender", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.", - "in": "query", - "name": "MmsConverter", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.", - "in": "query", - "name": "SmartEncoding", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "ScanMessageContent", - "required": false, - "schema": { - "enum": [ - "inherit", - "enable", - "disable" - ], - "type": "string" - } - }, - { - "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.", - "in": "query", - "name": "FallbackToLongCode", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.", - "in": "query", - "name": "AreaCodeGeomatch", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.", - "in": "query", - "name": "ValidityPeriod", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Reserved.", - "in": "query", - "name": "SynchronousValidation", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AreaCodeGeomatch": { + "description": "Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/sms/services#area-code-geomatch) on the Service Instance.", + "type": "boolean" + }, + "FallbackMethod": { + "description": "The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackToLongCode": { + "description": "Whether to enable [Fallback to Long Code](https://www.twilio.com/docs/sms/services#fallback-to-long-code) for messages sent through the Service instance.", + "type": "boolean" + }, + "FallbackUrl": { + "description": "The URL that we should call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "InboundMethod": { + "description": "The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "InboundRequestUrl": { + "description": "The URL we should call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled.", + "format": "uri", + "type": "string" + }, + "MmsConverter": { + "description": "Whether to enable the [MMS Converter](https://www.twilio.com/docs/sms/services#mms-converter) for messages sent through the Service instance.", + "type": "boolean" + }, + "ScanMessageContent": { + "description": "Reserved.", + "enum": [ + "inherit", + "enable", + "disable" + ], + "type": "string" + }, + "SmartEncoding": { + "description": "Whether to enable [Smart Encoding](https://www.twilio.com/docs/sms/services#smart-encoding) for messages sent through the Service instance.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery.", + "format": "uri", + "type": "string" + }, + "StickySender": { + "description": "Whether to enable [Sticky Sender](https://www.twilio.com/docs/sms/services#sticky-sender) on the Service instance.", + "type": "boolean" + }, + "SynchronousValidation": { + "description": "Reserved.", + "type": "boolean" + }, + "ValidityPeriod": { + "description": "How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1527,7 +1449,8 @@ "$ref": "#/components/schemas/messaging.v1.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_monitor.json b/src/services/twilio-api/twilio_monitor.json index d9cf49c9..b6b59ef0 100644 --- a/src/services/twilio-api/twilio_monitor.json +++ b/src/services/twilio-api/twilio_monitor.json @@ -270,7 +270,6 @@ "description": "Only show alerts for this log-level. Can be: `error`, `warning`, `notice`, or `debug`.", "in": "query", "name": "LogLevel", - "required": false, "schema": { "type": "string" } @@ -279,7 +278,6 @@ "description": "Only include alerts that occurred on or after this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -289,7 +287,6 @@ "description": "Only include alerts that occurred on or before this date and time. Specify the date and time in GMT and format as `YYYY-MM-DD` or `YYYY-MM-DDThh:mm:ssZ`. Queries for alerts older than 30 days are not supported.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -352,7 +349,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -403,7 +401,8 @@ "$ref": "#/components/schemas/monitor.v1.alert|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -437,7 +436,6 @@ "description": "Only include events initiated by this Actor. Useful for auditing actions taken by specific users or API credentials.", "in": "query", "name": "ActorSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -449,7 +447,6 @@ "description": "Only include events of this [Event Type](https://www.twilio.com/docs/usage/monitor-events#event-types).", "in": "query", "name": "EventType", - "required": false, "schema": { "type": "string" } @@ -458,7 +455,6 @@ "description": "Only include events that refer to this resource. Useful for discovering the history of a specific resource.", "in": "query", "name": "ResourceSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -470,7 +466,6 @@ "description": "Only include events that originated from this IP address. Useful for tracking suspicious activity originating from the API or the Twilio Console.", "in": "query", "name": "SourceIpAddress", - "required": false, "schema": { "type": "string" } @@ -479,7 +474,6 @@ "description": "Only include events that occurred on or after this date. Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -489,7 +483,6 @@ "description": "Only include events that occurred on or before this date. Specify the date in GMT and [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -552,7 +545,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -603,7 +597,8 @@ "$ref": "#/components/schemas/monitor.v1.event" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_notify.json b/src/services/twilio-api/twilio_notify.json index d3e33675..ca5237ce 100644 --- a/src/services/twilio-api/twilio_notify.json +++ b/src/services/twilio-api/twilio_notify.json @@ -364,7 +364,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -378,76 +379,53 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "The Credential type. Can be: `gcm`, `fcm`, or `apn`.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "gcm", - "apn", - "fcm" - ], - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`", - "in": "query", - "name": "Certificate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\n.-----END RSA PRIVATE KEY-----`", - "in": "query", - "name": "PrivateKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "in": "query", - "name": "Sandbox", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "[GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", - "in": "query", - "name": "ApiKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", - "in": "query", - "name": "Secret", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\n.-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", + "type": "string" + }, + "Type": { + "description": "The Credential type. Can be: `gcm`, `fcm`, or `apn`.", + "enum": [ + "gcm", + "apn", + "fcm" + ], + "type": "string" + } + }, + "required": [ + "Type" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -456,7 +434,8 @@ "$ref": "#/components/schemas/notify.v1.credential" } } - } + }, + "description": "Created" } }, "security": [ @@ -536,7 +515,8 @@ "$ref": "#/components/schemas/notify.v1.credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -562,62 +542,43 @@ "pattern": "^CR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`", - "in": "query", - "name": "Certificate", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\n.-----END RSA PRIVATE KEY-----`", - "in": "query", - "name": "PrivateKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", - "in": "query", - "name": "Sandbox", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "[GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", - "in": "query", - "name": "ApiKey", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", - "in": "query", - "name": "Secret", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApiKey": { + "description": "[GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", + "type": "string" + }, + "Certificate": { + "description": "[APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "PrivateKey": { + "description": "[APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\n.-----END RSA PRIVATE KEY-----`", + "type": "string" + }, + "Sandbox": { + "description": "[APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.", + "type": "boolean" + }, + "Secret": { + "description": "[FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -626,7 +587,8 @@ "$ref": "#/components/schemas/notify.v1.credential" } } - } + }, + "description": "OK" } }, "security": [ @@ -659,7 +621,6 @@ "description": "The string that identifies the Service resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -721,7 +682,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -735,128 +697,77 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.", - "in": "query", - "name": "ApnCredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.", - "in": "query", - "name": "GcmCredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.", - "in": "query", - "name": "MessagingServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "FacebookMessengerPageId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", - "in": "query", - "name": "DefaultApnNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", - "in": "query", - "name": "DefaultGcmNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.", - "in": "query", - "name": "FcmCredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", - "in": "query", - "name": "DefaultFcmNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to log notifications. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "LogEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "AlexaSkillId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "DefaultAlexaNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AlexaSkillId": { + "description": "Deprecated.", + "type": "string" + }, + "ApnCredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultAlexaNotificationProtocolVersion": { + "description": "Deprecated.", + "type": "string" + }, + "DefaultApnNotificationProtocolVersion": { + "description": "The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", + "type": "string" + }, + "DefaultFcmNotificationProtocolVersion": { + "description": "The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", + "type": "string" + }, + "DefaultGcmNotificationProtocolVersion": { + "description": "The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", + "type": "string" + }, + "FacebookMessengerPageId": { + "description": "Deprecated.", + "type": "string" + }, + "FcmCredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "GcmCredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "LogEnabled": { + "description": "Whether to log notifications. Can be: `true` or `false` and the default is `true`.", + "type": "boolean" + }, + "MessagingServiceSid": { + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -865,7 +776,8 @@ "$ref": "#/components/schemas/notify.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -910,7 +822,6 @@ "description": "Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -920,7 +831,6 @@ "description": "Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -930,7 +840,6 @@ "description": "The [User](https://www.twilio.com/docs/chat/rest/user-resource)'s `identity` value of the resources to read.", "in": "query", "name": "Identity", - "required": false, "schema": { "items": { "type": "string" @@ -942,7 +851,6 @@ "description": "Only list Bindings that have all of the specified Tags. The following implicit tags are available: `all`, `apn`, `fcm`, `gcm`, `sms`, `facebook-messenger`. Up to 5 tags are allowed.", "in": "query", "name": "Tag", - "required": false, "schema": { "items": { "type": "string" @@ -1007,7 +915,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1033,97 +942,79 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.", - "in": "query", - "name": "Identity", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.", - "in": "query", - "name": "BindingType", - "required": true, - "schema": { - "enum": [ - "apn", - "gcm", - "sms", - "fcm", - "facebook-messenger", - "alexa" - ], - "type": "string" - } - }, - { - "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.", - "in": "query", - "name": "Address", - "required": true, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Address": { + "description": "The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.", + "type": "string" + }, + "BindingType": { + "description": "The transport technology to use for the Binding. Can be: `apn`, `fcm`, `gcm`, `sms`, or `facebook-messenger`.", + "enum": [ + "apn", + "gcm", + "sms", + "fcm", + "facebook-messenger", + "alexa" + ], + "type": "string" + }, + "CredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only `apn`, `fcm`, and `gcm` type Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "Endpoint": { + "description": "Deprecated.", + "type": "string" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Up to 20 Bindings can be created for the same Identity in a given Service.", + "type": "string" + }, + "NotificationProtocolVersion": { + "description": "The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). The current version is `\"3\"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed.", + "type": "string" + }, + "Tag": { + "description": "A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "Identity", + "BindingType", + "Address" + ], + "type": "object" + } } - }, - { - "description": "A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.", - "in": "query", - "name": "Tag", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The protocol version to use to send the notification. This defaults to the value of `default_xxxx_notification_protocol_version` for the protocol in the [Service](https://www.twilio.com/docs/notify/api/service-resource). The current version is `\"3\"` for `apn`, `fcm`, and `gcm` type Bindings. The parameter is not applicable to `sms` and `facebook-messenger` type Bindings as the data format is fixed.", - "in": "query", - "name": "NotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only `apn`, `fcm`, and `gcm` type Bindings.", - "in": "query", - "name": "CredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "Endpoint", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/notify.v1.service.binding" - } - } - } - } - }, - "security": [ + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/notify.v1.service.binding" + } + } + }, + "description": "Created" + } + }, + "security": [ { "accountSid_authToken": [] } @@ -1226,7 +1117,8 @@ "$ref": "#/components/schemas/notify.v1.service.binding" } } - } + }, + "description": "OK" } }, "security": [ @@ -1268,186 +1160,107 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` priority is the same as `5`. A value of `high` sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, `high` is the same as `High` priority. For APNS, `high` is a priority `10`. SMS does not support this property.", - "in": "query", - "name": "Priority", - "required": false, - "schema": { - "enum": [ - "high", - "low" - ], - "type": "string" - } - }, - { - "description": "How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.", - "in": "query", - "name": "Title", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates to `aps.sound`. SMS does not support this property.", - "in": "query", - "name": "Sound", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.", - "in": "query", - "name": "Action", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.", - "in": "query", - "name": "Data", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.", - "in": "query", - "name": "Apn", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref).", - "in": "query", - "name": "Gcm", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.", - "in": "query", - "name": "Sms", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "FacebookMessenger", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.", - "in": "query", - "name": "Fcm", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The Segment resource is deprecated. Use the `tag` parameter, instead.", - "in": "query", - "name": "Segment", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "Alexa", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The destination address specified as a JSON string. Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers.", - "in": "query", - "name": "ToBinding", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "URL to send webhooks.", - "in": "query", - "name": "DeliveryCallbackUrl", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items are allowed in this list.", - "in": "query", - "name": "Identity", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel.", - "in": "query", - "name": "Tag", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Action": { + "description": "The actions to display for the notification. For APNS, translates to the `aps.category` value. For GCM, translates to the `data.twi_action` value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.", + "type": "string" + }, + "Alexa": { + "description": "Deprecated.", + "type": "object" + }, + "Apn": { + "description": "The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.", + "type": "object" + }, + "Body": { + "description": "The notification text. For FCM and GCM, translates to `data.twi_body`. For APNS, translates to `aps.alert.body`. For SMS, translates to `body`. SMS requires either this `body` value, or `media_urls` attribute defined in the `sms` parameter of the notification.", + "type": "string" + }, + "Data": { + "description": "The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.", + "type": "object" + }, + "DeliveryCallbackUrl": { + "description": "URL to send webhooks.", + "type": "string" + }, + "FacebookMessenger": { + "description": "Deprecated.", + "type": "object" + }, + "Fcm": { + "description": "The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.", + "type": "object" + }, + "Gcm": { + "description": "The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. See the [GCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref) for more details. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. GCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref).", + "type": "object" + }, + "Identity": { + "description": "The `identity` value that uniquely identifies the new resource's [User](https://www.twilio.com/docs/chat/rest/user-resource) within the [Service](https://www.twilio.com/docs/notify/api/service-resource). Delivery will be attempted only to Bindings with an Identity in this list. No more than 20 items are allowed in this list.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Priority": { + "description": "The priority of the notification. Can be: `low` or `high` and the default is `high`. A value of `low` optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, `low` priority is the same as `Normal` priority. For APNS `low` priority is the same as `5`. A value of `high` sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, `high` is the same as `High` priority. For APNS, `high` is a priority `10`. SMS does not support this property.", + "enum": [ + "high", + "low" + ], + "type": "string" + }, + "Segment": { + "description": "The Segment resource is deprecated. Use the `tag` parameter, instead.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Sms": { + "description": "The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/send-messages) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.", + "type": "object" + }, + "Sound": { + "description": "The name of the sound to be played for the notification. For FCM and GCM, this Translates to `data.twi_sound`. For APNS, this translates to `aps.sound`. SMS does not support this property.", + "type": "string" + }, + "Tag": { + "description": "A tag that selects the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 5 tags. The implicit tag `all` is available to notify all Bindings in a Service instance. Similarly, the implicit tags `apn`, `fcm`, `gcm`, `sms` and `facebook-messenger` are available to notify all Bindings in a specific channel.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Title": { + "description": "The notification title. For FCM and GCM, this translates to the `data.twi_title` value. For APNS, this translates to the `aps.alert.title` value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.", + "type": "string" + }, + "ToBinding": { + "description": "The destination address specified as a JSON string. Multiple `to_binding` parameters can be included but the total size of the request entity should not exceed 1MB. This is typically sufficient for 10,000 phone numbers.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Ttl": { + "description": "How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1456,7 +1269,8 @@ "$ref": "#/components/schemas/notify.v1.service.notification" } } - } + }, + "description": "Created" } }, "security": [ @@ -1536,7 +1350,8 @@ "$ref": "#/components/schemas/notify.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -1562,146 +1377,87 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.", - "in": "query", - "name": "ApnCredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.", - "in": "query", - "name": "GcmCredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.", - "in": "query", - "name": "MessagingServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "FacebookMessengerPageId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", - "in": "query", - "name": "DefaultApnNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", - "in": "query", - "name": "DefaultGcmNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.", - "in": "query", - "name": "FcmCredentialSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", - "in": "query", - "name": "DefaultFcmNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to log notifications. Can be: `true` or `false` and the default is `true`.", - "in": "query", - "name": "LogEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "AlexaSkillId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Deprecated.", - "in": "query", - "name": "DefaultAlexaNotificationProtocolVersion", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "URL to send delivery status callback.", - "in": "query", - "name": "DeliveryCallbackUrl", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Callback configuration that enables delivery callbacks, default false", - "in": "query", - "name": "DeliveryCallbackEnabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AlexaSkillId": { + "description": "Deprecated.", + "type": "string" + }, + "ApnCredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for APN Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultAlexaNotificationProtocolVersion": { + "description": "Deprecated.", + "type": "string" + }, + "DefaultApnNotificationProtocolVersion": { + "description": "The protocol version to use for sending APNS notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", + "type": "string" + }, + "DefaultFcmNotificationProtocolVersion": { + "description": "The protocol version to use for sending FCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", + "type": "string" + }, + "DefaultGcmNotificationProtocolVersion": { + "description": "The protocol version to use for sending GCM notifications. Can be overridden on a Binding by Binding basis when creating a [Binding](https://www.twilio.com/docs/notify/api/binding-resource) resource.", + "type": "string" + }, + "DeliveryCallbackEnabled": { + "description": "Callback configuration that enables delivery callbacks, default false", + "type": "boolean" + }, + "DeliveryCallbackUrl": { + "description": "URL to send delivery status callback.", + "type": "string" + }, + "FacebookMessengerPageId": { + "description": "Deprecated.", + "type": "string" + }, + "FcmCredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for FCM Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "GcmCredentialSid": { + "description": "The SID of the [Credential](https://www.twilio.com/docs/notify/api/credential-resource) to use for GCM Bindings.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "LogEnabled": { + "description": "Whether to log notifications. Can be: `true` or `false` and the default is `true`.", + "type": "boolean" + }, + "MessagingServiceSid": { + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/send-messages#messaging-services) to use for SMS Bindings. This parameter must be set in order to send SMS notifications.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1710,7 +1466,8 @@ "$ref": "#/components/schemas/notify.v1.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_numbers.json b/src/services/twilio-api/twilio_numbers.json index 415adcac..23f8b41f 100644 --- a/src/services/twilio-api/twilio_numbers.json +++ b/src/services/twilio-api/twilio_numbers.json @@ -315,7 +315,6 @@ "description": "The verification status of the Bundle resource.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "draft", @@ -331,7 +330,6 @@ "description": "The string that you assigned to describe the resource.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -340,7 +338,6 @@ "description": "The unique string of a regulation that is associated to the Bundle resource.", "in": "query", "name": "RegulationSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -352,7 +349,6 @@ "description": "The ISO country code of the Bundle's phone number country ownership request.", "in": "query", "name": "IsoCountry", - "required": false, "schema": { "type": "string" } @@ -361,7 +357,6 @@ "description": "The type of phone number of the Bundle's ownership request.", "in": "query", "name": "NumberType", - "required": false, "schema": { "type": "string" } @@ -423,7 +418,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -437,79 +433,57 @@ }, "post": { "description": "Create a new Bundle.", - "parameters": [ - { - "description": "The string that you assigned to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The email address that will receive updates when the Bundle resource changes status.", - "in": "query", - "name": "Email", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we call to inform your application of status changes.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The unique string of a regulation that is associated to the Bundle resource.", - "in": "query", - "name": "RegulationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The ISO country code of the Bundle's phone number country ownership request.", - "in": "query", - "name": "IsoCountry", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The type of End User of the Bundle resource.", - "in": "query", - "name": "EndUserType", - "required": false, - "schema": { - "enum": [ - "individual", - "business" - ], - "type": "string" - } - }, - { - "description": "The type of phone number of the Bundle's ownership request.", - "in": "query", - "name": "NumberType", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Email": { + "description": "The email address that will receive updates when the Bundle resource changes status.", + "type": "string" + }, + "EndUserType": { + "description": "The type of End User of the Bundle resource.", + "enum": [ + "individual", + "business" + ], + "type": "string" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the resource.", + "type": "string" + }, + "IsoCountry": { + "description": "The ISO country code of the Bundle's phone number country ownership request.", + "type": "string" + }, + "NumberType": { + "description": "The type of phone number of the Bundle's ownership request.", + "type": "string" + }, + "RegulationSid": { + "description": "The unique string of a regulation that is associated to the Bundle resource.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RN[0-9a-fA-F]{32}$", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we call to inform your application of status changes.", + "format": "uri", + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Email" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -518,7 +492,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" } } - } + }, + "description": "Created" } }, "security": [ @@ -616,7 +591,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -642,20 +618,29 @@ "pattern": "^BU[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of an object bag that holds information of the different items.", - "in": "query", - "name": "ObjectSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ObjectSid": { + "description": "The SID of an object bag that holds information of the different items.", + "maxLength": 34, + "minLength": 34, + "pattern": "^[a-zA-Z]{2}[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "ObjectSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -664,7 +649,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment" } } - } + }, + "description": "Created" } }, "security": [ @@ -766,7 +752,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle.item_assignment" } } - } + }, + "description": "OK" } }, "security": [ @@ -814,7 +801,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" } } - } + }, + "description": "OK" } }, "security": [ @@ -840,52 +828,43 @@ "pattern": "^BU[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The verification status of the Bundle resource.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "draft", - "pending-review", - "in-review", - "twilio-rejected", - "twilio-approved" - ], - "type": "string" - } - }, - { - "description": "The URL we call to inform your application of status changes.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The string that you assigned to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The email address that will receive updates when the Bundle resource changes status.", - "in": "query", - "name": "Email", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Email": { + "description": "The email address that will receive updates when the Bundle resource changes status.", + "type": "string" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the resource.", + "type": "string" + }, + "Status": { + "description": "The verification status of the Bundle resource.", + "enum": [ + "draft", + "pending-review", + "in-review", + "twilio-rejected", + "twilio-approved" + ], + "type": "string" + }, + "StatusCallback": { + "description": "The URL we call to inform your application of status changes.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -894,7 +873,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.bundle" } } - } + }, + "description": "OK" } }, "security": [ @@ -980,7 +960,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1026,7 +1007,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user_type" } } - } + }, + "description": "OK" } }, "security": [ @@ -1111,7 +1093,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1125,39 +1108,37 @@ }, "post": { "description": "Create a new End User.", - "parameters": [ - { - "description": "The string that you assigned to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The type of end user of the Bundle resource - can be `individual` or `business`.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "enum": [ - "individual", - "business" - ], - "type": "string" - } - }, - { - "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "object" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the resource.", + "type": "string" + }, + "Type": { + "description": "The type of end user of the Bundle resource - can be `individual` or `business`.", + "enum": [ + "individual", + "business" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Type" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1166,7 +1147,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" } } - } + }, + "description": "Created" } }, "security": [ @@ -1215,7 +1197,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" } } - } + }, + "description": "OK" } }, "security": [ @@ -1241,26 +1224,27 @@ "pattern": "^IT[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The string that you assigned to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "The set of parameters that are the attributes of the End User resource which are derived End User Types.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1269,7 +1253,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.end_user" } } - } + }, + "description": "OK" } }, "security": [ @@ -1301,7 +1286,6 @@ "description": "The type of End User the regulation requires - can be `individual` or `business`.", "in": "query", "name": "EndUserType", - "required": false, "schema": { "enum": [ "individual", @@ -1314,7 +1298,6 @@ "description": "The ISO country code of the phone number's country.", "in": "query", "name": "IsoCountry", - "required": false, "schema": { "type": "string" } @@ -1323,7 +1306,6 @@ "description": "The type of phone number that the regulatory requiremnt is restricting.", "in": "query", "name": "NumberType", - "required": false, "schema": { "type": "string" } @@ -1385,7 +1367,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1434,7 +1417,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.regulation" } } - } + }, + "description": "OK" } }, "security": [ @@ -1519,7 +1503,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1565,7 +1550,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document_type" } } - } + }, + "description": "OK" } }, "security": [ @@ -1650,7 +1636,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1664,35 +1651,33 @@ }, "post": { "description": "Create a new Supporting Document.", - "parameters": [ - { - "description": "The string that you assigned to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The type of the Supporting Document.", - "in": "query", - "name": "Type", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "object" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "The set of parameters that are the attributes of the Supporting Documents resource which are derived Supporting Document Types.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the resource.", + "type": "string" + }, + "Type": { + "description": "The type of the Supporting Document.", + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Type" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1701,7 +1686,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" } } - } + }, + "description": "Created" } }, "security": [ @@ -1750,7 +1736,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" } } - } + }, + "description": "OK" } }, "security": [ @@ -1776,26 +1763,27 @@ "pattern": "^RD[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The string that you assigned to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "The set of parameters that are the attributes of the Supporting Document resource which are derived Supporting Document Types.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1804,7 +1792,8 @@ "$ref": "#/components/schemas/numbers.v2.regulatory_compliance.supporting_document" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_preview.json b/src/services/twilio-api/twilio_preview.json index 9cc11f36..41bc6fef 100644 --- a/src/services/twilio-api/twilio_preview.json +++ b/src/services/twilio-api/twilio_preview.json @@ -2441,7 +2441,8 @@ "$ref": "#/components/schemas/preview.bulk_exports.export.job" } } - } + }, + "description": "OK" } }, "security": [ @@ -2484,7 +2485,8 @@ "$ref": "#/components/schemas/preview.bulk_exports.export" } } - } + }, + "description": "OK" } }, "security": [ @@ -2527,7 +2529,8 @@ "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -2550,36 +2553,32 @@ "schema": { "type": "string" } - }, - { - "description": "If true, Twilio will automatically generate every day's file when the day is over.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Stores the URL destination for the method specified in webhook_method.", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "If true, Twilio will automatically generate every day's file when the day is over.", + "type": "boolean" + }, + "WebhookMethod": { + "description": "Sets whether Twilio should call a webhook URL when the automatic generation is complete, using GET or POST. The actual destination is set in the webhook_url", + "type": "string" + }, + "WebhookUrl": { + "description": "Stores the URL destination for the method specified in webhook_method.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2588,7 +2587,8 @@ "$ref": "#/components/schemas/preview.bulk_exports.export_configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -2626,7 +2626,6 @@ "description": "", "in": "query", "name": "NextToken", - "required": false, "schema": { "type": "string" } @@ -2635,7 +2634,6 @@ "description": "", "in": "query", "name": "PreviousToken", - "required": false, "schema": { "type": "string" } @@ -2697,7 +2695,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2749,7 +2748,8 @@ "$ref": "#/components/schemas/preview.bulk_exports.export.day|instance" } } - } + }, + "description": "Temporary Redirect" } }, "security": [ @@ -2787,7 +2787,6 @@ "description": "The token for the next page of job results, and may be null if there are no more pages", "in": "query", "name": "NextToken", - "required": false, "schema": { "type": "string" } @@ -2796,7 +2795,6 @@ "description": "The token for the previous page of results, and may be null if this is the first page", "in": "query", "name": "PreviousToken", - "required": false, "schema": { "type": "string" } @@ -2858,7 +2856,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2881,62 +2880,43 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "StartDay", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "EndDay", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "WebhookMethod", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Email", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Email": { + "description": "", + "type": "string" + }, + "EndDay": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "StartDay": { + "description": "", + "type": "string" + }, + "WebhookMethod": { + "description": "", + "type": "string" + }, + "WebhookUrl": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2945,7 +2925,8 @@ "$ref": "#/components/schemas/preview.bulk_exports.export.export_custom_job" } } - } + }, + "description": "Created" } }, "security": [ @@ -3027,7 +3008,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3041,17 +3023,21 @@ }, "post": { "description": "Create a new Fleet for scoping of deployed devices within your account.", - "parameters": [ - { - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -3060,7 +3046,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet" } } - } + }, + "description": "Created" } }, "security": [ @@ -3098,7 +3085,6 @@ "description": "Filters the resulting list of Certificates by a unique string identifier of an authenticated Device.", "in": "query", "name": "DeviceSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -3163,7 +3149,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3186,38 +3173,37 @@ "schema": { "type": "string" } - }, - { - "description": "Provides a URL encoded representation of the public certificate in PEM format.", - "in": "query", - "name": "CertificateData", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", - "in": "query", - "name": "DeviceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CertificateData": { + "description": "Provides a URL encoded representation of the public certificate in PEM format.", + "type": "string" + }, + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", + "type": "string" + } + }, + "required": [ + "CertificateData" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3226,7 +3212,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } } - } + }, + "description": "Created" } }, "security": [ @@ -3320,7 +3307,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } } - } + }, + "description": "OK" } }, "security": [ @@ -3355,29 +3343,30 @@ "pattern": "^CY[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", - "in": "query", - "name": "DeviceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Certificate credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Certificate credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3386,7 +3375,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.certificate" } } - } + }, + "description": "OK" } }, "security": [ @@ -3477,7 +3467,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3500,29 +3491,30 @@ "schema": { "type": "string" } - }, - { - "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", - "in": "query", - "name": "SyncServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Deployment, up to 256 characters long.", + "type": "string" + }, + "SyncServiceSid": { + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3531,7 +3523,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } } - } + }, + "description": "Created" } }, "security": [ @@ -3625,7 +3618,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } } - } + }, + "description": "OK" } }, "security": [ @@ -3660,29 +3654,30 @@ "pattern": "^DL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", - "in": "query", - "name": "SyncServiceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Deployment, up to 64 characters long", + "type": "string" + }, + "SyncServiceSid": { + "description": "Provides the unique string identifier of the Twilio Sync service instance that will be linked to and accessible by this Deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3691,7 +3686,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.deployment" } } - } + }, + "description": "OK" } }, "security": [ @@ -3729,7 +3725,6 @@ "description": "Filters the resulting list of Devices by a unique string identifier of the Deployment they are associated with.", "in": "query", "name": "DeploymentSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -3794,7 +3789,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3817,65 +3813,52 @@ "schema": { "type": "string" } - }, - { - "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", - "in": "query", - "name": "Identity", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", - "in": "query", - "name": "DeploymentSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } } ], - "responses": { - "201": { + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeploymentSid": { + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "Enabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", + "type": "string" + }, + "Identity": { + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "Provides a unique and addressable name to be assigned to this Device, to be used in addition to SID, up to 128 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } } - } + }, + "description": "Created" } }, "security": [ @@ -3963,7 +3946,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } } - } + }, + "description": "OK" } }, "security": [ @@ -3995,47 +3979,38 @@ "schema": { "type": "string" } - }, - { - "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", - "in": "query", - "name": "Identity", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", - "in": "query", - "name": "DeploymentSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeploymentSid": { + "description": "Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "Enabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.", + "type": "string" + }, + "Identity": { + "description": "Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -4044,7 +4019,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.device" } } - } + }, + "description": "OK" } }, "security": [ @@ -4082,7 +4058,6 @@ "description": "Filters the resulting list of Keys by a unique string identifier of an authenticated Device.", "in": "query", "name": "DeviceSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -4147,7 +4122,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -4170,29 +4146,30 @@ "schema": { "type": "string" } - }, - { - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", - "in": "query", - "name": "DeviceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -4201,7 +4178,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } } - } + }, + "description": "Created" } }, "security": [ @@ -4295,7 +4273,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } } - } + }, + "description": "OK" } }, "security": [ @@ -4330,29 +4309,30 @@ "pattern": "^KY[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", - "in": "query", - "name": "DeviceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^TH[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DeviceSid": { + "description": "Provides the unique string identifier of an existing Device to become authenticated with this Key credential.", + "maxLength": 34, + "minLength": 34, + "pattern": "^TH[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Key credential, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -4361,7 +4341,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet.key" } } - } + }, + "description": "OK" } }, "security": [ @@ -4431,7 +4412,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet" } } - } + }, + "description": "OK" } }, "security": [ @@ -4454,29 +4436,30 @@ "schema": { "type": "string" } - }, - { - "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.", - "in": "query", - "name": "DefaultDeploymentSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^DL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DefaultDeploymentSid": { + "description": "Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.", + "maxLength": 34, + "minLength": 34, + "pattern": "^DL[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "Provides a human readable descriptive text for this Fleet, up to 256 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -4485,7 +4468,8 @@ "$ref": "#/components/schemas/preview.deployed_devices.fleet" } } - } + }, + "description": "OK" } }, "security": [ @@ -4514,7 +4498,6 @@ "description": "Email that this AuthorizationDocument will be sent to for signing.", "in": "query", "name": "Email", - "required": false, "schema": { "type": "string" } @@ -4523,7 +4506,6 @@ "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "opened", @@ -4592,7 +4574,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -4606,71 +4589,57 @@ }, "post": { "description": "Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.", - "parameters": [ - { - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", - "in": "query", - "name": "HostedNumberOrderSids", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", - "in": "query", - "name": "AddressSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Email that this AuthorizationDocument will be sent to for signing.", - "in": "query", - "name": "Email", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The title of the person authorized to sign the Authorization Document for this phone number.", - "in": "query", - "name": "ContactTitle", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The contact phone number of the person authorized to sign the Authorization Document.", - "in": "query", - "name": "ContactPhoneNumber", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", - "in": "query", - "name": "CcEmails", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ContactPhoneNumber": { + "description": "The contact phone number of the person authorized to sign the Authorization Document.", + "type": "string" + }, + "ContactTitle": { + "description": "The title of the person authorized to sign the Authorization Document for this phone number.", + "type": "string" + }, + "Email": { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "type": "string" + }, + "HostedNumberOrderSids": { + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "HostedNumberOrderSids", + "AddressSid", + "Email", + "ContactTitle", + "ContactPhoneNumber" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -4679,7 +4648,8 @@ "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" } } - } + }, + "description": "Created" } }, "security": [ @@ -4725,7 +4695,8 @@ "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" } } - } + }, + "description": "OK" } }, "security": [ @@ -4751,137 +4722,113 @@ "pattern": "^PX[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", - "in": "query", - "name": "HostedNumberOrderSids", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AddressSid": { + "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", + "items": { + "type": "string" + }, + "type": "array" + }, + "ContactPhoneNumber": { + "description": "The contact phone number of the person authorized to sign the Authorization Document.", + "type": "string" + }, + "ContactTitle": { + "description": "The title of the person authorized to sign the Authorization Document for this phone number.", + "type": "string" + }, + "Email": { + "description": "Email that this AuthorizationDocument will be sent to for signing.", + "type": "string" + }, + "HostedNumberOrderSids": { + "description": "A list of HostedNumberOrder sids that this AuthorizationDocument will authorize for hosting phone number capabilities on Twilio's platform.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Status": { + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", + "enum": [ + "opened", + "signing", + "signed", + "canceled", + "failed" + ], + "type": "string" + } + }, + "type": "object" + } } - }, + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "A 34 character string that uniquely identifies the Address resource that is associated with this AuthorizationDocument.", - "in": "query", - "name": "AddressSid", - "required": false, + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [], + "x-path-type": "instance" + }, + "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", + "parameters": [ + { + "description": "", + "in": "path", + "name": "SigningDocumentSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", + "pattern": "^PX[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Email that this AuthorizationDocument will be sent to for signing.", + "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", "in": "query", - "name": "Email", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Email recipients who will be informed when an Authorization Document has been sent and signed", - "in": "query", - "name": "CcEmails", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "opened", - "signing", - "signed", - "canceled", - "failed" - ], - "type": "string" - } - }, - { - "description": "The title of the person authorized to sign the Authorization Document for this phone number.", - "in": "query", - "name": "ContactTitle", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The contact phone number of the person authorized to sign the Authorization Document.", - "in": "query", - "name": "ContactPhoneNumber", - "required": false, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.hosted_numbers.authorization_document" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [], - "x-path-type": "instance" - }, - "/HostedNumbers/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.", - "parameters": [ - { - "description": "", - "in": "path", - "name": "SigningDocumentSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PX[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA, 4. canceled, 5. failed. See the section entitled [Status Values](https://www.twilio.com/docs/api/phone-numbers/hosted-number-authorization-documents#status-values) for more information on each of these statuses.", - "in": "query", - "name": "Status", - "required": false, + "name": "Status", "schema": { "enum": [ "received", @@ -4901,7 +4848,6 @@ "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "in": "query", "name": "PhoneNumber", - "required": false, "schema": { "type": "string" } @@ -4910,7 +4856,6 @@ "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "in": "query", "name": "IncomingPhoneNumberSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -4922,7 +4867,6 @@ "description": "A human readable description of this resource, up to 64 characters.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -4931,7 +4875,6 @@ "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "in": "query", "name": "UniqueName", - "required": false, "schema": { "type": "string" } @@ -4993,7 +4936,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5022,7 +4966,6 @@ "description": "The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`, `carrier-processing`, `testing`, `completed`, `failed`, or `action-required`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "received", @@ -5042,7 +4985,6 @@ "description": "An E164 formatted phone number hosted by this HostedNumberOrder.", "in": "query", "name": "PhoneNumber", - "required": false, "schema": { "type": "string" } @@ -5051,7 +4993,6 @@ "description": "A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.", "in": "query", "name": "IncomingPhoneNumberSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -5063,7 +5004,6 @@ "description": "A human readable description of this resource, up to 64 characters.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -5072,7 +5012,6 @@ "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", "in": "query", "name": "UniqueName", - "required": false, "schema": { "type": "string" } @@ -5134,7 +5073,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5148,225 +5088,153 @@ }, "post": { "description": "Host a phone number's capability on Twilio's platform.", - "parameters": [ - { - "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format", - "in": "query", - "name": "PhoneNumber", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Used to specify that the SMS capability will be hosted on Twilio's platform.", - "in": "query", - "name": "SmsCapability", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.", - "in": "query", - "name": "AccountSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AC[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A 64 character string that is a human readable text that describes this resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.", - "in": "query", - "name": "CcEmails", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.", - "in": "query", - "name": "StatusCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.", - "in": "query", - "name": "SmsApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.", - "in": "query", - "name": "AddressSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AD[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Optional. Email of the owner of this phone number that is being hosted.", - "in": "query", - "name": "Email", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", - "in": "query", - "name": "VerificationType", - "required": false, - "schema": { - "enum": [ - "phone-call", - "phone-bill" - ], - "type": "string" - } - }, - { - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.", - "in": "query", - "name": "VerificationDocumentSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + }, + "AddressSid": { + "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AD[0-9a-fA-F]{32}$", + "type": "string" + }, + "CcEmails": { + "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Email": { + "description": "Optional. Email of the owner of this phone number that is being hosted.", + "type": "string" + }, + "FriendlyName": { + "description": "A 64 character string that is a human readable text that describes this resource.", + "type": "string" + }, + "PhoneNumber": { + "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format", + "type": "string" + }, + "SmsApplicationSid": { + "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "SmsCapability": { + "description": "Used to specify that the SMS capability will be hosted on Twilio's platform.", + "type": "boolean" + }, + "SmsFallbackMethod": { + "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "StatusCallbackUrl": { + "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource.", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "Optional. Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "type": "string" + }, + "VerificationDocumentSid": { + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "VerificationType": { + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "required": [ + "PhoneNumber", + "SmsCapability" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -5375,7 +5243,8 @@ "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } } - } + }, + "description": "Created" } }, "security": [ @@ -5451,7 +5320,8 @@ "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } } - } + }, + "description": "OK" } }, "security": [ @@ -5477,119 +5347,80 @@ "pattern": "^HR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A 64 character string that is a human readable text that describes this resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Email of the owner of this phone number that is being hosted.", - "in": "query", - "name": "Email", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", - "in": "query", - "name": "CcEmails", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "received", - "pending-verification", - "verified", - "pending-loa", - "carrier-processing", - "testing", - "completed", - "failed", - "action-required" - ], - "type": "string" - } - }, - { - "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted.", - "in": "query", - "name": "VerificationCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", - "in": "query", - "name": "VerificationType", - "required": false, - "schema": { - "enum": [ - "phone-call", - "phone-bill" - ], - "type": "string" - } - }, - { - "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.", - "in": "query", - "name": "VerificationDocumentSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RI[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Digits to dial after connecting the verification call.", - "in": "query", - "name": "Extension", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.", - "in": "query", - "name": "CallDelay", - "required": false, - "schema": { - "type": "integer" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallDelay": { + "description": "The number of seconds, between 0 and 60, to delay before initiating the verification call. Defaults to 0.", + "type": "integer" + }, + "CcEmails": { + "description": "Optional. A list of emails that LOA document for this HostedNumberOrder will be carbon copied to.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Email": { + "description": "Email of the owner of this phone number that is being hosted.", + "type": "string" + }, + "Extension": { + "description": "Digits to dial after connecting the verification call.", + "type": "string" + }, + "FriendlyName": { + "description": "A 64 character string that is a human readable text that describes this resource.", + "type": "string" + }, + "Status": { + "description": "User can only post to `pending-verification` status to transition the HostedNumberOrder to initiate a verification call or verification of ownership with a copy of a phone bill.", + "enum": [ + "received", + "pending-verification", + "verified", + "pending-loa", + "carrier-processing", + "testing", + "completed", + "failed", + "action-required" + ], + "type": "string" + }, + "UniqueName": { + "description": "Provides a unique and addressable name to be assigned to this HostedNumberOrder, assigned by the developer, to be optionally used in addition to SID.", + "type": "string" + }, + "VerificationCode": { + "description": "A verification code that is given to the user via a phone call to the phone number that is being hosted.", + "type": "string" + }, + "VerificationDocumentSid": { + "description": "Optional. The unique sid identifier of the Identity Document that represents the document for verifying ownership of the number to be hosted. Required when VerificationType is phone-bill.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + }, + "VerificationType": { + "description": "Optional. The method used for verifying ownership of the number to be hosted. One of phone-call (default) or phone-bill.", + "enum": [ + "phone-call", + "phone-bill" + ], + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "200": { "content": { @@ -5598,7 +5429,8 @@ "$ref": "#/components/schemas/preview.hosted_numbers.hosted_number_order" } } - } + }, + "description": "OK" } }, "security": [ @@ -5680,7 +5512,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5694,45 +5527,34 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "ReachabilityWebhooksEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "AclEnabled", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "ReachabilityWebhooksEnabled": { + "description": "", + "type": "boolean" + }, + "WebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -5741,7 +5563,8 @@ "$ref": "#/components/schemas/preview.sync.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -5835,7 +5658,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5861,26 +5685,27 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Data", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -5889,7 +5714,8 @@ "$ref": "#/components/schemas/preview.sync.service.document" } } - } + }, + "description": "Created" } }, "security": [ @@ -5992,7 +5818,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -6104,7 +5931,8 @@ "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -6148,35 +5976,36 @@ "schema": { "type": "string" } - }, - { - "description": "Boolean flag specifying whether the identity can read the Sync Document.", - "in": "query", - "name": "Read", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag specifying whether the identity can update the Sync Document.", - "in": "query", - "name": "Write", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag specifying whether the identity can delete the Sync Document.", - "in": "query", - "name": "Manage", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync Document.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync Document.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can update the Sync Document.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -6185,7 +6014,8 @@ "$ref": "#/components/schemas/preview.sync.service.document.document_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -6279,7 +6109,8 @@ "$ref": "#/components/schemas/preview.sync.service.document" } } - } + }, + "description": "OK" } }, "security": [ @@ -6314,17 +6145,26 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -6333,7 +6173,8 @@ "$ref": "#/components/schemas/preview.sync.service.document" } } - } + }, + "description": "OK" } }, "security": [ @@ -6427,7 +6268,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -6453,17 +6295,23 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -6472,7 +6320,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list" } } - } + }, + "description": "Created" } }, "security": [ @@ -6522,7 +6371,6 @@ "description": "", "in": "query", "name": "Order", - "required": false, "schema": { "enum": [ "asc", @@ -6535,7 +6383,6 @@ "description": "", "in": "query", "name": "From", - "required": false, "schema": { "type": "string" } @@ -6544,7 +6391,6 @@ "description": "", "in": "query", "name": "Bounds", - "required": false, "schema": { "enum": [ "inclusive", @@ -6610,7 +6456,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -6645,17 +6492,26 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -6664,7 +6520,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } } - } + }, + "description": "Created" } }, "security": [ @@ -6776,7 +6633,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -6820,17 +6678,26 @@ "schema": { "type": "integer" } - }, - { - "description": "", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -6839,7 +6706,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -6942,7 +6810,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7054,7 +6923,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -7098,35 +6968,36 @@ "schema": { "type": "string" } - }, - { - "description": "Boolean flag specifying whether the identity can read the Sync List.", - "in": "query", - "name": "Read", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.", - "in": "query", - "name": "Write", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag specifying whether the identity can delete the Sync List.", - "in": "query", - "name": "Manage", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync List.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync List.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync List.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7135,7 +7006,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list.sync_list_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -7229,7 +7101,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -7323,7 +7196,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7349,17 +7223,23 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -7368,7 +7248,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map" } } - } + }, + "description": "Created" } }, "security": [ @@ -7418,7 +7299,6 @@ "description": "", "in": "query", "name": "Order", - "required": false, "schema": { "enum": [ "asc", @@ -7431,7 +7311,6 @@ "description": "", "in": "query", "name": "From", - "required": false, "schema": { "type": "string" } @@ -7440,7 +7319,6 @@ "description": "", "in": "query", "name": "Bounds", - "required": false, "schema": { "enum": [ "inclusive", @@ -7506,7 +7384,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7541,26 +7420,31 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "Key", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + }, + "Key": { + "description": "", + "type": "string" + } + }, + "required": [ + "Key", + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -7569,7 +7453,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } } - } + }, + "description": "Created" } }, "security": [ @@ -7681,7 +7566,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -7725,17 +7611,26 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7744,7 +7639,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -7847,7 +7743,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7959,7 +7856,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -8003,35 +7901,36 @@ "schema": { "type": "string" } - }, - { - "description": "Boolean flag specifying whether the identity can read the Sync Map.", - "in": "query", - "name": "Read", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.", - "in": "query", - "name": "Write", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Boolean flag specifying whether the identity can delete the Sync Map.", - "in": "query", - "name": "Manage", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Boolean flag specifying whether the identity can delete the Sync Map.", + "type": "boolean" + }, + "Read": { + "description": "Boolean flag specifying whether the identity can read the Sync Map.", + "type": "boolean" + }, + "Write": { + "description": "Boolean flag specifying whether the identity can create, update and delete Items of the Sync Map.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -8040,7 +7939,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map.sync_map_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -8134,7 +8034,8 @@ "$ref": "#/components/schemas/preview.sync.service.sync_map" } } - } + }, + "description": "OK" } }, "security": [ @@ -8210,7 +8111,8 @@ "$ref": "#/components/schemas/preview.sync.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -8236,45 +8138,36 @@ "pattern": "^IS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "ReachabilityWebhooksEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "AclEnabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "", + "type": "boolean" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "ReachabilityWebhooksEnabled": { + "description": "", + "type": "boolean" + }, + "WebhookUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -8283,7 +8176,8 @@ "$ref": "#/components/schemas/preview.sync.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -8307,47 +8201,41 @@ "description": "TODO: Resource-level docs", "post": { "description": "Brands a Call without actually placing it. Useful for cases when the Customer wants to initiate the call themselves right after calling this endpoint. This can be used also through a TwiML using `+1500456`, and right after doing `+1500456`", - "parameters": [ - { - "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", - "in": "query", - "name": "From", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", - "in": "query", - "name": "Reason", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Call sid this Branded Call should link to.", - "in": "query", - "name": "CallSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallSid": { + "description": "The Call sid this Branded Call should link to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "From": { + "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", + "type": "string" + }, + "Reason": { + "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", + "type": "string" + }, + "To": { + "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + } + }, + "required": [ + "From", + "To", + "Reason" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -8356,7 +8244,8 @@ "$ref": "#/components/schemas/preview.trusted_comms.branded_call" } } - } + }, + "description": "Created" } }, "security": [ @@ -8399,388 +8288,266 @@ "description": "TODO: Resource-level docs", "post": { "description": "Initiates a Branded Call.", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ApplicationSid": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "maxLength": 34, + "minLength": 34, + "pattern": "^AP[0-9a-fA-F]{32}$", + "type": "string" + }, + "CallerId": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "FallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "FallbackUrl": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + }, + "From": { + "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", + "type": "string" + }, + "MachineDetection": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "MachineDetectionSilenceTimeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionSpeechEndThreshold": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionSpeechThreshold": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "MachineDetectionTimeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "Method": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Reason": { + "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", + "type": "string" + }, + "Record": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "boolean" + }, + "RecordingChannels": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "RecordingStatusCallbackEvent": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "items": { + "type": "string" + }, + "type": "array" + }, + "RecordingStatusCallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SendDigits": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "SipAuthPassword": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "SipAuthUsername": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "StatusCallback": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "items": { + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Timeout": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "integer" + }, + "To": { + "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + }, + "Trim": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "type": "string" + }, + "Url": { + "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", + "format": "uri", + "type": "string" + } + }, + "required": [ + "From", + "To" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/preview.trusted_comms.phone_call" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "servers": [ + { + "url": "https://preview.twilio.com" + } + ], + "x-default-output-properties": [ + "account_sid", + "bg_color", + "brand_sid", + "branded_channel_sid", + "business_sid", + "call_sid", + "caller", + "created_at", + "font_color", + "from", + "logo", + "phone_number_sid", + "reason", + "sid", + "status", + "to", + "url", + "use_case" + ], + "x-path-type": "list" + }, + "/TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate": { + "description": "TODO: Resource-level docs", + "get": { + "description": "Fetch a specific Impressions Rate.", "parameters": [ { - "description": "The phone number to use as the caller id, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164). It must be a Twilio number that has been set up as a Branded Number in the Business Profile section for your account.", - "in": "query", - "name": "From", + "description": "The unique SID identifier of the Business to filter by.", + "in": "path", + "name": "BusinessSid", "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^BX[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The terminating Phone Number, given in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The business reason for this phone call that will appear in the terminating device's screen. Max 50 characters.", - "in": "query", - "name": "Reason", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "ApplicationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AP[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "CallerId", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "FallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "FallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "MachineDetection", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "MachineDetectionSilenceTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "MachineDetectionSpeechEndThreshold", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "MachineDetectionSpeechThreshold", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "MachineDetectionTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "Method", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "Record", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "RecordingChannels", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "RecordingStatusCallback", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "RecordingStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "RecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "SendDigits", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "SipAuthPassword", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "SipAuthUsername", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "StatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "Trim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Refers to the parameter with the same name when [initiating a call via Voice API](https://www.twilio.com/docs/voice/api/call#create-a-call-resource)", - "in": "query", - "name": "Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/preview.trusted_comms.phone_call" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "servers": [ - { - "url": "https://preview.twilio.com" - } - ], - "x-default-output-properties": [ - "account_sid", - "bg_color", - "brand_sid", - "branded_channel_sid", - "business_sid", - "call_sid", - "caller", - "created_at", - "font_color", - "from", - "logo", - "phone_number_sid", - "reason", - "sid", - "status", - "to", - "url", - "use_case" - ], - "x-path-type": "list" - }, - "/TrustedComms/Businesses/{BusinessSid}/Insights/ImpressionsRate": { - "description": "TODO: Resource-level docs", - "get": { - "description": "Fetch a specific Impressions Rate.", - "parameters": [ - { - "description": "The unique SID identifier of the Business to filter by.", - "in": "path", - "name": "BusinessSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^BX[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The unique SID identifier of the Brand to filter by.", + "description": "The unique SID identifier of the Brand to filter by.", "in": "query", "name": "BrandSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -8792,7 +8559,6 @@ "description": "The unique SID identifier of the Branded Channel to filter by.", "in": "query", "name": "BrandedChannelSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -8804,7 +8570,6 @@ "description": "The unique SID identifier of the Phone Number to filter by.", "in": "query", "name": "PhoneNumberSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -8816,7 +8581,6 @@ "description": "The 2-letter ISO 3166 code of the Country to filter by.", "in": "query", "name": "Country", - "required": false, "schema": { "type": "string" } @@ -8825,7 +8589,6 @@ "description": "The start date that for this Impressions Rate, given in ISO 8601 format. Default value is 30 days ago.", "in": "query", "name": "Start", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -8835,7 +8598,6 @@ "description": "The end date that for this Impressions Rate, given in ISO 8601 format. Default value is current timestamp.", "in": "query", "name": "End", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -8845,7 +8607,6 @@ "description": "The Interval of this Impressions Rate. One of `minute`, `hour`, `day`, `week` or `month`.", "in": "query", "name": "Interval", - "required": false, "schema": { "enum": [ "minute", @@ -8866,7 +8627,8 @@ "$ref": "#/components/schemas/preview.trusted_comms.business.insights.insights_impressions_rate" } } - } + }, + "description": "OK" } }, "security": [ @@ -8920,7 +8682,8 @@ "$ref": "#/components/schemas/preview.trusted_comms.business" } } - } + }, + "description": "OK" } }, "security": [ @@ -8949,7 +8712,6 @@ "description": "TODO: Resource-level docs", "get": { "description": "Fetch a specific Call Placement Service (CPS) given a phone number via `X-XCNAM-Sensitive-Phone-Number` header.", - "parameters": [], "responses": { "200": { "content": { @@ -8958,7 +8720,8 @@ "$ref": "#/components/schemas/preview.trusted_comms.cps" } } - } + }, + "description": "OK" } }, "security": [ @@ -8986,7 +8749,6 @@ "description": "TODO: Resource-level docs", "get": { "description": "Retrieve a current call given the originating and terminating number via `X-XCNAM-Sensitive-Phone-Number-From` and `X-XCNAM-Sensitive-Phone-Number-To` headers.", - "parameters": [], "responses": { "200": { "content": { @@ -8995,7 +8757,8 @@ "$ref": "#/components/schemas/preview.trusted_comms.current_call" } } - } + }, + "description": "OK" } }, "security": [ @@ -9092,7 +8855,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9186,7 +8950,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9244,7 +9009,8 @@ "$ref": "#/components/schemas/preview.marketplace.available_add_on.available_add_on_extension" } } - } + }, + "description": "OK" } }, "security": [ @@ -9290,7 +9056,8 @@ "$ref": "#/components/schemas/preview.marketplace.available_add_on" } } - } + }, + "description": "OK" } }, "security": [ @@ -9372,7 +9139,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9386,47 +9154,40 @@ }, "post": { "description": "Install an Add-on for the Account specified.", - "parameters": [ - { - "description": "The SID of the AvaliableAddOn to install.", - "in": "query", - "name": "AvailableAddOnSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^XB[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether the Terms of Service were accepted.", - "in": "query", - "name": "AcceptTermsOfService", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "The JSON object that represents the configuration of the new Add-on being installed.", - "in": "query", - "name": "Configuration", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AcceptTermsOfService": { + "description": "Whether the Terms of Service were accepted.", + "type": "boolean" + }, + "AvailableAddOnSid": { + "description": "The SID of the AvaliableAddOn to install.", + "maxLength": 34, + "minLength": 34, + "pattern": "^XB[0-9a-fA-F]{32}$", + "type": "string" + }, + "Configuration": { + "description": "The JSON object that represents the configuration of the new Add-on being installed.", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", + "type": "string" + } + }, + "required": [ + "AvailableAddOnSid", + "AcceptTermsOfService" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -9435,7 +9196,8 @@ "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } } - } + }, + "description": "Created" } }, "security": [ @@ -9529,7 +9291,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9587,7 +9350,8 @@ "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } } - } + }, + "description": "OK" } }, "security": [ @@ -9625,17 +9389,26 @@ "pattern": "^XF[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Whether the Extension should be invoked.", - "in": "query", - "name": "Enabled", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "Whether the Extension should be invoked.", + "type": "boolean" + } + }, + "required": [ + "Enabled" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -9644,7 +9417,8 @@ "$ref": "#/components/schemas/preview.marketplace.installed_add_on.installed_add_on_extension" } } - } + }, + "description": "OK" } }, "security": [ @@ -9720,7 +9494,8 @@ "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } } - } + }, + "description": "OK" } }, "security": [ @@ -9746,26 +9521,27 @@ "pattern": "^XE[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured", - "in": "query", - "name": "Configuration", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Configuration": { + "description": "Valid JSON object that conform to the configuration schema exposed by the associated AvailableAddOn resource. This is only required by Add-ons that need to be configured", + "type": "object" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within the Account.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -9774,7 +9550,8 @@ "$ref": "#/components/schemas/preview.marketplace.installed_add_on" } } - } + }, + "description": "OK" } }, "security": [ @@ -9856,7 +9633,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -9870,81 +9648,50 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", - "in": "query", - "name": "LogQueries", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided URL to send event callbacks to.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Space-separated list of callback events that will trigger callbacks.", - "in": "query", - "name": "CallbackEvents", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", - "in": "query", - "name": "FallbackActions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", - "in": "query", - "name": "InitiationActions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The JSON object that holds the style sheet for the assistant", - "in": "query", - "name": "StyleSheet", - "required": false, - "schema": { - "type": "object" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Space-separated list of callback events that will trigger callbacks.", + "type": "string" + }, + "CallbackUrl": { + "description": "A user-provided URL to send event callbacks to.", + "format": "uri", + "type": "string" + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", + "type": "object" + }, + "FriendlyName": { + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", + "type": "object" + }, + "LogQueries": { + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant", + "type": "object" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -9953,7 +9700,8 @@ "$ref": "#/components/schemas/preview.understand.assistant" } } - } + }, + "description": "Created" } }, "security": [ @@ -10005,7 +9753,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.dialogue" } } - } + }, + "description": "OK" } }, "security": [ @@ -10048,7 +9797,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -10071,17 +9821,23 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "FallbackActions", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FallbackActions": { + "description": "", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -10090,7 +9846,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.assistant_fallback_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -10181,7 +9938,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10204,26 +9962,30 @@ "schema": { "type": "string" } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -10232,7 +9994,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.field_type" } } - } + }, + "description": "Created" } }, "security": [ @@ -10279,7 +10042,6 @@ "description": "An ISO language-country string of the value. For example: *en-US*", "in": "query", "name": "Language", - "required": false, "schema": { "type": "string" } @@ -10341,7 +10103,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10373,35 +10136,35 @@ "schema": { "type": "string" } - }, - { - "description": "An ISO language-country string of the value.", - "in": "query", - "name": "Language", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "Value", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.", - "in": "query", - "name": "SynonymOf", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the value.", + "type": "string" + }, + "SynonymOf": { + "description": "A value that indicates this field value is a synonym of. Empty if the value is not a synonym.", + "type": "string" + }, + "Value": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "Language", + "Value" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -10410,7 +10173,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" } } - } + }, + "description": "Created" } }, "security": [ @@ -10516,7 +10280,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.field_type.field_value" } } - } + }, + "description": "OK" } }, "security": [ @@ -10604,7 +10369,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.field_type" } } - } + }, + "description": "OK" } }, "security": [ @@ -10636,26 +10402,27 @@ "schema": { "type": "string" } - }, - { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -10664,7 +10431,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.field_type" } } - } + }, + "description": "OK" } }, "security": [ @@ -10707,7 +10475,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -10730,17 +10499,23 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "InitiationActions", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "InitiationActions": { + "description": "", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -10749,7 +10524,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.assistant_initiation_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -10840,7 +10616,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -10863,27 +10640,28 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StatusCallback": { + "description": "", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -10892,7 +10670,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.model_build" } } - } + }, + "description": "Created" } }, "security": [ @@ -10980,7 +10759,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.model_build" } } - } + }, + "description": "OK" } }, "security": [ @@ -11012,17 +10792,23 @@ "schema": { "type": "string" } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -11031,7 +10817,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.model_build" } } - } + }, + "description": "OK" } }, "security": [ @@ -11069,7 +10856,6 @@ "description": "An ISO language-country string of the sample.", "in": "query", "name": "Language", - "required": false, "schema": { "type": "string" } @@ -11078,7 +10864,6 @@ "description": "The Model Build Sid or unique name of the Model Build to be queried.", "in": "query", "name": "ModelBuild", - "required": false, "schema": { "type": "string" } @@ -11087,7 +10872,6 @@ "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", "in": "query", "name": "Status", - "required": false, "schema": { "type": "string" } @@ -11149,7 +10933,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -11172,53 +10957,43 @@ "schema": { "type": "string" } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.", - "in": "query", - "name": "Query", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*", - "in": "query", - "name": "Tasks", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The Model Build Sid or unique name of the Model Build to be queried.", - "in": "query", - "name": "ModelBuild", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*", - "in": "query", - "name": "Field", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Field": { + "description": "Constraints the query to a given Field with an task. Useful when you know the Field you are expecting. It accepts one field in the format *task-unique-name-1*:*field-unique-name*", + "type": "string" + }, + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "ModelBuild": { + "description": "The Model Build Sid or unique name of the Model Build to be queried.", + "type": "string" + }, + "Query": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. It can be up to 2048 characters long.", + "type": "string" + }, + "Tasks": { + "description": "Constraints the query to a set of tasks. Useful when you need to constrain the paths the user can take. Tasks should be comma separated *task-unique-name-1*, *task-unique-name-2*", + "type": "string" + } + }, + "required": [ + "Language", + "Query" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -11227,7 +11002,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.query" } } - } + }, + "description": "Created" } }, "security": [ @@ -11315,7 +11091,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.query" } } - } + }, + "description": "OK" } }, "security": [ @@ -11347,29 +11124,30 @@ "schema": { "type": "string" } - }, - { - "description": "An optional reference to the Sample created from this query.", - "in": "query", - "name": "SampleSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^UF[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "SampleSid": { + "description": "An optional reference to the Sample created from this query.", + "maxLength": 34, + "minLength": 34, + "pattern": "^UF[0-9a-fA-F]{32}$", + "type": "string" + }, + "Status": { + "description": "A string that described the query status. The values can be: pending_review, reviewed, discarded", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -11378,7 +11156,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.query" } } - } + }, + "description": "OK" } }, "security": [ @@ -11421,7 +11200,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" } } - } + }, + "description": "OK" } }, "security": [ @@ -11444,17 +11224,23 @@ "schema": { "type": "string" } - }, - { - "description": "The JSON Style sheet string", - "in": "query", - "name": "StyleSheet", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "StyleSheet": { + "description": "The JSON Style sheet string", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -11463,7 +11249,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.style_sheet" } } - } + }, + "description": "OK" } }, "security": [ @@ -11554,7 +11341,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -11577,45 +11365,39 @@ "schema": { "type": "string" } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", - "in": "query", - "name": "Actions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "User-provided HTTP endpoint where from the assistant fetches actions", - "in": "query", - "name": "ActionsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "User-provided HTTP endpoint where from the assistant fetches actions", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -11624,7 +11406,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task" } } - } + }, + "description": "Created" } }, "security": [ @@ -11712,7 +11495,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task" } } - } + }, + "description": "OK" } }, "security": [ @@ -11744,45 +11528,36 @@ "schema": { "type": "string" } - }, - { - "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", - "in": "query", - "name": "Actions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "User-provided HTTP endpoint where from the assistant fetches actions", - "in": "query", - "name": "ActionsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "A user-provided JSON object encoded as a string to specify the actions for this task. It is optional and non-unique.", + "type": "object" + }, + "ActionsUrl": { + "description": "User-provided HTTP endpoint where from the assistant fetches actions", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A user-provided string that identifies this resource. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -11791,7 +11566,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task" } } - } + }, + "description": "OK" } }, "security": [ @@ -11843,7 +11619,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -11875,17 +11652,23 @@ "schema": { "type": "string" } - }, - { - "description": "The JSON actions that instruct the Assistant how to perform this task.", - "in": "query", - "name": "Actions", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Actions": { + "description": "The JSON actions that instruct the Assistant how to perform this task.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -11894,7 +11677,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.task_actions" } } - } + }, + "description": "OK" } }, "security": [ @@ -11994,7 +11778,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -12026,26 +11811,31 @@ "schema": { "type": "string" } - }, - { - "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.", - "in": "query", - "name": "FieldType", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FieldType": { + "description": "The unique name or sid of the FieldType. It can be any [Built-in Field Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the unique_name or the Field Type sid of a custom Field Type.", + "type": "string" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FieldType", + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -12054,7 +11844,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.field" } } - } + }, + "description": "Created" } }, "security": [ @@ -12160,7 +11951,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.field" } } - } + }, + "description": "OK" } }, "security": [ @@ -12207,7 +11999,6 @@ "description": "An ISO language-country string of the sample.", "in": "query", "name": "Language", - "required": false, "schema": { "type": "string" } @@ -12269,7 +12060,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -12301,35 +12093,35 @@ "schema": { "type": "string" } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", - "in": "query", - "name": "TaggedText", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", - "in": "query", - "name": "SourceChannel", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", + "type": "string" + } + }, + "required": [ + "Language", + "TaggedText" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -12338,7 +12130,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } } - } + }, + "description": "Created" } }, "security": [ @@ -12450,7 +12243,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } } - } + }, + "description": "OK" } }, "security": [ @@ -12494,35 +12288,31 @@ "pattern": "^UF[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "An ISO language-country string of the sample.", - "in": "query", - "name": "Language", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", - "in": "query", - "name": "TaggedText", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", - "in": "query", - "name": "SourceChannel", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Language": { + "description": "An ISO language-country string of the sample.", + "type": "string" + }, + "SourceChannel": { + "description": "The communication channel the sample was captured. It can be: *voice*, *sms*, *chat*, *alexa*, *google-assistant*, or *slack*. If not included the value will be null", + "type": "string" + }, + "TaggedText": { + "description": "The text example of how end-users may express this task. The sample may contain Field tag blocks.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -12531,7 +12321,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.sample" } } - } + }, + "description": "OK" } }, "security": [ @@ -12583,7 +12374,8 @@ "$ref": "#/components/schemas/preview.understand.assistant.task.task_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -12653,7 +12445,8 @@ "$ref": "#/components/schemas/preview.understand.assistant" } } - } + }, + "description": "OK" } }, "security": [ @@ -12676,81 +12469,52 @@ "schema": { "type": "string" } - }, - { - "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", - "in": "query", - "name": "LogQueries", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A user-provided URL to send event callbacks to.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Space-separated list of callback events that will trigger callbacks.", - "in": "query", - "name": "CallbackEvents", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", - "in": "query", - "name": "FallbackActions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", - "in": "query", - "name": "InitiationActions", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "The JSON object that holds the style sheet for the assistant", - "in": "query", - "name": "StyleSheet", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackEvents": { + "description": "Space-separated list of callback events that will trigger callbacks.", + "type": "string" + }, + "CallbackUrl": { + "description": "A user-provided URL to send event callbacks to.", + "format": "uri", + "type": "string" + }, + "FallbackActions": { + "description": "The JSON actions to be executed when the user's input is not recognized as matching any Task.", + "type": "object" + }, + "FriendlyName": { + "description": "A text description for the Assistant. It is non-unique and can up to 255 characters long.", + "type": "string" + }, + "InitiationActions": { + "description": "The JSON actions to be executed on inbound phone calls when the Assistant has to say something first.", + "type": "object" + }, + "LogQueries": { + "description": "A boolean that specifies whether queries should be logged for 30 days further training. If false, no queries will be stored, if true, queries will be stored for 30 days and deleted thereafter. Defaults to true if no value is provided.", + "type": "boolean" + }, + "StyleSheet": { + "description": "The JSON object that holds the style sheet for the assistant", + "type": "object" + }, + "UniqueName": { + "description": "A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -12759,7 +12523,8 @@ "$ref": "#/components/schemas/preview.understand.assistant" } } - } + }, + "description": "OK" } }, "security": [ @@ -12788,7 +12553,6 @@ "description": "", "in": "query", "name": "Device", - "required": false, "schema": { "type": "string" } @@ -12797,7 +12561,6 @@ "description": "", "in": "query", "name": "Sim", - "required": false, "schema": { "type": "string" } @@ -12806,7 +12569,6 @@ "description": "", "in": "query", "name": "Status", - "required": false, "schema": { "type": "string" } @@ -12815,7 +12577,6 @@ "description": "", "in": "query", "name": "Direction", - "required": false, "schema": { "type": "string" } @@ -12877,7 +12638,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -12891,72 +12653,49 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "Command", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Device", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Sim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CommandMode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "IncludeSid", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "", + "type": "string" + }, + "CallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "Command": { + "description": "", + "type": "string" + }, + "CommandMode": { + "description": "", + "type": "string" + }, + "Device": { + "description": "", + "type": "string" + }, + "IncludeSid": { + "description": "", + "type": "string" + }, + "Sim": { + "description": "", + "type": "string" + } + }, + "required": [ + "Command" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -12965,7 +12704,8 @@ "$ref": "#/components/schemas/preview.wireless.command" } } - } + }, + "description": "Created" } }, "security": [ @@ -13011,7 +12751,8 @@ "$ref": "#/components/schemas/preview.wireless.command" } } - } + }, + "description": "OK" } }, "security": [ @@ -13043,165 +12784,125 @@ "schema": { "maximum": 1000, "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "rate_plans": { - "items": { - "$ref": "#/components/schemas/preview.wireless.rate_plan" - }, - "type": "array" - } - }, - "type": "object" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "DataEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "DataLimit", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "", - "in": "query", - "name": "DataMetering", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "MessagingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "VoiceEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "CommandsEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "NationalRoamingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "", - "in": "query", - "name": "InternationalRoaming", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" + "type": "integer" } } ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "rate_plans": { + "items": { + "$ref": "#/components/schemas/preview.wireless.rate_plan" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommandsEnabled": { + "description": "", + "type": "boolean" + }, + "DataEnabled": { + "description": "", + "type": "boolean" + }, + "DataLimit": { + "description": "", + "type": "integer" + }, + "DataMetering": { + "description": "", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "InternationalRoaming": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + }, + "MessagingEnabled": { + "description": "", + "type": "boolean" + }, + "NationalRoamingEnabled": { + "description": "", + "type": "boolean" + }, + "UniqueName": { + "description": "", + "type": "string" + }, + "VoiceEnabled": { + "description": "", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -13210,7 +12911,8 @@ "$ref": "#/components/schemas/preview.wireless.rate_plan" } } - } + }, + "description": "Created" } }, "security": [ @@ -13280,7 +12982,8 @@ "$ref": "#/components/schemas/preview.wireless.rate_plan" } } - } + }, + "description": "OK" } }, "security": [ @@ -13303,26 +13006,27 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -13331,7 +13035,8 @@ "$ref": "#/components/schemas/preview.wireless.rate_plan" } } - } + }, + "description": "OK" } }, "security": [ @@ -13360,7 +13065,6 @@ "description": "", "in": "query", "name": "Status", - "required": false, "schema": { "type": "string" } @@ -13369,7 +13073,6 @@ "description": "", "in": "query", "name": "Iccid", - "required": false, "schema": { "type": "string" } @@ -13378,7 +13081,6 @@ "description": "", "in": "query", "name": "RatePlan", - "required": false, "schema": { "type": "string" } @@ -13387,7 +13089,6 @@ "description": "", "in": "query", "name": "EId", - "required": false, "schema": { "type": "string" } @@ -13396,7 +13097,6 @@ "description": "", "in": "query", "name": "SimRegistrationCode", - "required": false, "schema": { "type": "string" } @@ -13458,7 +13158,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -13501,7 +13202,8 @@ "$ref": "#/components/schemas/preview.wireless.sim" } } - } + }, + "description": "OK" } }, "security": [ @@ -13524,228 +13226,159 @@ "schema": { "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "RatePlan", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CommandsCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "CommandsCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "", + "type": "string" + }, + "CallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "CommandsCallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CommandsCallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "RatePlan": { + "description": "", + "type": "string" + }, + "SmsFallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "Status": { + "description": "", + "type": "string" + }, + "UniqueName": { + "description": "", + "type": "string" + }, + "VoiceFallbackMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -13754,7 +13387,8 @@ "$ref": "#/components/schemas/preview.wireless.sim" } } - } + }, + "description": "OK" } }, "security": [ @@ -13792,7 +13426,6 @@ "description": "", "in": "query", "name": "End", - "required": false, "schema": { "type": "string" } @@ -13801,7 +13434,6 @@ "description": "", "in": "query", "name": "Start", - "required": false, "schema": { "type": "string" } @@ -13815,7 +13447,8 @@ "$ref": "#/components/schemas/preview.wireless.sim.usage" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_pricing.json b/src/services/twilio-api/twilio_pricing.json index 5b9c07d2..548eb355 100644 --- a/src/services/twilio-api/twilio_pricing.json +++ b/src/services/twilio-api/twilio_pricing.json @@ -538,7 +538,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -586,7 +587,8 @@ "$ref": "#/components/schemas/pricing.v1.messaging.messaging_country|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -673,7 +675,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -719,7 +722,8 @@ "$ref": "#/components/schemas/pricing.v1.phone_number.phone_number_country|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -804,7 +808,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -850,7 +855,8 @@ "$ref": "#/components/schemas/pricing.v1.voice.voice_country|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -896,7 +902,8 @@ "$ref": "#/components/schemas/pricing.v1.voice.voice_number" } } - } + }, + "description": "OK" } }, "security": [ @@ -983,7 +990,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1029,7 +1037,8 @@ "$ref": "#/components/schemas/pricing.v2.voice.voice_country|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -1070,7 +1079,6 @@ "description": "The origination phone number, in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, for which to fetch the origin-based voice pricing information. E.164 format consists of a + followed by the country code and subscriber number.", "in": "query", "name": "OriginationNumber", - "required": false, "schema": { "type": "string" } @@ -1084,7 +1092,8 @@ "$ref": "#/components/schemas/pricing.v2.voice.voice_number" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_proxy.json b/src/services/twilio-api/twilio_proxy.json index a52e22f7..17a36a46 100644 --- a/src/services/twilio-api/twilio_proxy.json +++ b/src/services/twilio-api/twilio_proxy.json @@ -694,7 +694,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -708,96 +709,68 @@ }, "post": { "description": "Create a new Service for Twilio Proxy", - "parameters": [ - { - "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value.", - "in": "query", - "name": "DefaultTtl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The URL we should call when the interaction status changes.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.", - "in": "query", - "name": "GeoMatchLevel", - "required": false, - "schema": { - "enum": [ - "area-code", - "overlay", - "radius", - "country" - ], - "type": "string" - } - }, - { - "description": "The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.", - "in": "query", - "name": "NumberSelectionBehavior", - "required": false, - "schema": { - "enum": [ - "avoid-sticky", - "prefer-sticky" - ], - "type": "string" - } - }, - { - "description": "The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.", - "in": "query", - "name": "InterceptCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information.", - "in": "query", - "name": "OutOfSessionCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.", - "in": "query", - "name": "ChatInstanceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackUrl": { + "description": "The URL we should call when the interaction status changes.", + "format": "uri", + "type": "string" + }, + "ChatInstanceSid": { + "description": "The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultTtl": { + "description": "The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value.", + "type": "integer" + }, + "GeoMatchLevel": { + "description": "Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.", + "enum": [ + "area-code", + "overlay", + "radius", + "country" + ], + "type": "string" + }, + "InterceptCallbackUrl": { + "description": "The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.", + "format": "uri", + "type": "string" + }, + "NumberSelectionBehavior": { + "description": "The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.", + "enum": [ + "avoid-sticky", + "prefer-sticky" + ], + "type": "string" + }, + "OutOfSessionCallbackUrl": { + "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information.", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -806,7 +779,8 @@ "$ref": "#/components/schemas/proxy.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -904,7 +878,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -930,38 +905,34 @@ "pattern": "^KS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of a Twilio [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service.", - "in": "query", - "name": "Sid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", - "in": "query", - "name": "PhoneNumber", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.", - "in": "query", - "name": "IsReserved", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "IsReserved": { + "description": "Whether the new phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.", + "type": "boolean" + }, + "PhoneNumber": { + "description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234.", + "type": "string" + }, + "Sid": { + "description": "The SID of a Twilio [IncomingPhoneNumber](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) resource that represents the Twilio Number you would like to assign to your Proxy Service.", + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -970,7 +941,8 @@ "$ref": "#/components/schemas/proxy.v1.service.phone_number" } } - } + }, + "description": "Created" } }, "security": [ @@ -1074,7 +1046,8 @@ "$ref": "#/components/schemas/proxy.v1.service.phone_number" } } - } + }, + "description": "OK" } }, "security": [ @@ -1112,17 +1085,23 @@ "pattern": "^PN[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.", - "in": "query", - "name": "IsReserved", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "IsReserved": { + "description": "Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1131,7 +1110,8 @@ "$ref": "#/components/schemas/proxy.v1.service.phone_number" } } - } + }, + "description": "OK" } }, "security": [ @@ -1229,7 +1209,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1255,78 +1236,59 @@ "pattern": "^KS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.", - "in": "query", - "name": "DateExpiry", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message` and the default value is `voice-and-message`.", - "in": "query", - "name": "Mode", - "required": false, - "schema": { - "enum": [ - "message-only", - "voice-only", - "voice-and-message" - ], - "type": "string" - } - }, - { - "description": "The initial status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`. The default is `open` on create.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "open", - "in-progress", - "closed", - "failed", - "unknown" - ], - "type": "string" - } - }, - { - "description": "The Participant objects to include in the new session.", - "in": "query", - "name": "Participants", - "required": false, - "schema": { - "items": { + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DateExpiry": { + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.", + "format": "date-time", + "type": "string" + }, + "Mode": { + "description": "The Mode of the Session. Can be: `message-only`, `voice-only`, or `voice-and-message` and the default value is `voice-and-message`.", + "enum": [ + "message-only", + "voice-only", + "voice-and-message" + ], + "type": "string" + }, + "Participants": { + "description": "The Participant objects to include in the new session.", + "items": { + "type": "object" + }, + "type": "array" + }, + "Status": { + "description": "The initial status of the Session. Can be: `open`, `in-progress`, `closed`, `failed`, or `unknown`. The default is `open` on create.", + "enum": [ + "open", + "in-progress", + "closed", + "failed", + "unknown" + ], + "type": "string" + }, + "Ttl": { + "description": "The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.", + "type": "integer" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**", + "type": "string" + } + }, "type": "object" - }, - "type": "array" + } } } - ], + }, "responses": { "201": { "content": { @@ -1335,7 +1297,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session" } } - } + }, + "description": "Created" } }, "security": [ @@ -1446,7 +1409,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1574,7 +1538,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session.interaction" } } - } + }, + "description": "OK" } }, "security": [ @@ -1684,7 +1649,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1722,47 +1688,41 @@ "pattern": "^KC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The phone number of the Participant.", - "in": "query", - "name": "Identifier", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.**", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.", - "in": "query", - "name": "ProxyIdentifier", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Proxy Identifier to assign to the Participant.", - "in": "query", - "name": "ProxyIdentifierSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "The string that you assigned to describe the participant. This value must be 255 characters or fewer. **This value should not have PII.**", + "type": "string" + }, + "Identifier": { + "description": "The phone number of the Participant.", + "type": "string" + }, + "ProxyIdentifier": { + "description": "The proxy phone number to use for the Participant. If not specified, Proxy will select a number from the pool.", + "type": "string" + }, + "ProxyIdentifierSid": { + "description": "The SID of the Proxy Identifier to assign to the Participant.", + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Identifier" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1771,7 +1731,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session.participant" } } - } + }, + "description": "Created" } }, "security": [ @@ -1894,7 +1855,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1944,30 +1906,31 @@ "pattern": "^KP[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The message to send to the participant", - "in": "query", - "name": "Body", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Reserved. Not currently supported.", - "in": "query", - "name": "MediaUrl", - "required": false, - "schema": { - "items": { - "format": "uri", - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Body": { + "description": "The message to send to the participant", + "type": "string" + }, + "MediaUrl": { + "description": "Reserved. Not currently supported.", + "items": { + "format": "uri", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1976,7 +1939,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session.participant.message_interaction" } } - } + }, + "description": "Created" } }, "security": [ @@ -2062,7 +2026,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session.participant.message_interaction" } } - } + }, + "description": "OK" } }, "security": [ @@ -2190,7 +2155,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session.participant" } } - } + }, + "description": "OK" } }, "security": [ @@ -2292,7 +2258,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session" } } - } + }, + "description": "OK" } }, "security": [ @@ -2330,43 +2297,39 @@ "pattern": "^KC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.", - "in": "query", - "name": "DateExpiry", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "open", - "in-progress", - "closed", - "failed", - "unknown" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DateExpiry": { + "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the Session should expire. If this is value is present, it overrides the `ttl` value.", + "format": "date-time", + "type": "string" + }, + "Status": { + "description": "The new status of the resource. Can be: `in-progress` to re-open a session or `closed` to close a session.", + "enum": [ + "open", + "in-progress", + "closed", + "failed", + "unknown" + ], + "type": "string" + }, + "Ttl": { + "description": "The time, in seconds, when the session will expire. The time is measured from the last Session create or the Session's last Interaction.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2375,7 +2338,8 @@ "$ref": "#/components/schemas/proxy.v1.service.session" } } - } + }, + "description": "OK" } }, "security": [ @@ -2474,7 +2438,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2500,20 +2465,29 @@ "pattern": "^KS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that represents the short code you would like to assign to your Proxy Service.", - "in": "query", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^SC[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Sid": { + "description": "The SID of a Twilio [ShortCode](https://www.twilio.com/docs/sms/api/short-code) resource that represents the short code you would like to assign to your Proxy Service.", + "maxLength": 34, + "minLength": 34, + "pattern": "^SC[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Sid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2522,7 +2496,8 @@ "$ref": "#/components/schemas/proxy.v1.service.short_code" } } - } + }, + "description": "Created" } }, "security": [ @@ -2626,7 +2601,8 @@ "$ref": "#/components/schemas/proxy.v1.service.short_code" } } - } + }, + "description": "OK" } }, "security": [ @@ -2664,17 +2640,23 @@ "pattern": "^SC[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.", - "in": "query", - "name": "IsReserved", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "IsReserved": { + "description": "Whether the short code should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](https://www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2683,7 +2665,8 @@ "$ref": "#/components/schemas/proxy.v1.service.short_code" } } - } + }, + "description": "OK" } }, "security": [ @@ -2760,7 +2743,8 @@ "$ref": "#/components/schemas/proxy.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -2786,96 +2770,67 @@ "pattern": "^KS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value.", - "in": "query", - "name": "DefaultTtl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The URL we should call when the interaction status changes.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.", - "in": "query", - "name": "GeoMatchLevel", - "required": false, - "schema": { - "enum": [ - "area-code", - "overlay", - "radius", - "country" - ], - "type": "string" - } - }, - { - "description": "The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.", - "in": "query", - "name": "NumberSelectionBehavior", - "required": false, - "schema": { - "enum": [ - "avoid-sticky", - "prefer-sticky" - ], - "type": "string" - } - }, - { - "description": "The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.", - "in": "query", - "name": "InterceptCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information.", - "in": "query", - "name": "OutOfSessionCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.", - "in": "query", - "name": "ChatInstanceSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackUrl": { + "description": "The URL we should call when the interaction status changes.", + "format": "uri", + "type": "string" + }, + "ChatInstanceSid": { + "description": "The SID of the Chat Service Instance managed by Proxy Service. The Chat Service enables Proxy to forward SMS and channel messages to this chat instance. This is a one-to-one relationship.", + "maxLength": 34, + "minLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "type": "string" + }, + "DefaultTtl": { + "description": "The default `ttl` value to set for Sessions created in the Service. The TTL (time to live) is measured in seconds after the Session's last create or last Interaction. The default value of `0` indicates an unlimited Session length. You can override a Session's default TTL value by setting its `ttl` value.", + "type": "integer" + }, + "GeoMatchLevel": { + "description": "Where a proxy number must be located relative to the participant identifier. Can be: `country`, `area-code`, or `extended-area-code`. The default value is `country` and more specific areas than `country` are only available in North America.", + "enum": [ + "area-code", + "overlay", + "radius", + "country" + ], + "type": "string" + }, + "InterceptCallbackUrl": { + "description": "The URL we call on each interaction. If we receive a 403 status, we block the interaction; otherwise the interaction continues.", + "format": "uri", + "type": "string" + }, + "NumberSelectionBehavior": { + "description": "The preference for Proxy Number selection in the Service instance. Can be: `prefer-sticky` or `avoid-sticky` and the default is `prefer-sticky`. `prefer-sticky` means that we will try and select the same Proxy Number for a given participant if they have previous [Sessions](https://www.twilio.com/docs/proxy/api/session), but we will not fail if that Proxy Number cannot be used. `avoid-sticky` means that we will try to use different Proxy Numbers as long as that is possible within a given pool rather than try and use a previously assigned number.", + "enum": [ + "avoid-sticky", + "prefer-sticky" + ], + "type": "string" + }, + "OutOfSessionCallbackUrl": { + "description": "The URL we should call when an inbound call or SMS action occurs on a closed or non-existent Session. If your server (or a Twilio [function](https://www.twilio.com/functions)) responds with valid [TwiML](https://www.twilio.com/docs/voice/twiml), we will process it. This means it is possible, for example, to play a message for a call, send an automated text message response, or redirect a call to another Phone Number. See [Out-of-Session Callback Response Guide](https://www.twilio.com/docs/proxy/out-session-callback-response-guide) for more information.", + "format": "uri", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be 191 characters or fewer in length and be unique. **This value should not have PII.**", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2884,7 +2839,8 @@ "$ref": "#/components/schemas/proxy.v1.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_serverless.json b/src/services/twilio-api/twilio_serverless.json index aed75a00..27c5d54c 100644 --- a/src/services/twilio-api/twilio_serverless.json +++ b/src/services/twilio-api/twilio_serverless.json @@ -623,7 +623,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -637,44 +638,37 @@ }, "post": { "description": "Create a new Service resource.", - "parameters": [ - { - "description": "An application-defined string that uniquely identifies the Service resource. It can be used as an alternative to the `sid` in the URL path to address the Service resource. This value must be 244 characters or less in length and be unique.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the Service resource. It can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to inject Account credentials into a function invocation context. The default value is `false`.", - "in": "query", - "name": "IncludeCredentials", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the Service's properties and subresources can be edited via the UI. The default value is `false`.", - "in": "query", - "name": "UiEditable", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Service resource. It can be up to 255 characters long.", + "type": "string" + }, + "IncludeCredentials": { + "description": "Whether to inject Account credentials into a function invocation context. The default value is `false`.", + "type": "boolean" + }, + "UiEditable": { + "description": "Whether the Service's properties and subresources can be edited via the UI. The default value is `false`.", + "type": "boolean" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the Service resource. It can be used as an alternative to the `sid` in the URL path to address the Service resource. This value must be 244 characters or less in length and be unique.", + "type": "string" + } + }, + "required": [ + "UniqueName", + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -683,7 +677,8 @@ "$ref": "#/components/schemas/serverless.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -778,7 +773,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -801,17 +797,26 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Asset resource. It can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Asset resource. It can be up to 255 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -820,7 +825,8 @@ "$ref": "#/components/schemas/serverless.v1.service.asset" } } - } + }, + "description": "Created" } }, "security": [ @@ -927,7 +933,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -999,7 +1006,8 @@ "$ref": "#/components/schemas/serverless.v1.service.asset.asset_version" } } - } + }, + "description": "OK" } }, "security": [ @@ -1098,7 +1106,8 @@ "$ref": "#/components/schemas/serverless.v1.service.asset" } } - } + }, + "description": "OK" } }, "security": [ @@ -1133,17 +1142,26 @@ "pattern": "^ZH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Asset resource. It can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Asset resource. It can be up to 255 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1152,7 +1170,8 @@ "$ref": "#/components/schemas/serverless.v1.service.asset" } } - } + }, + "description": "OK" } }, "security": [ @@ -1247,7 +1266,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1270,47 +1290,43 @@ "schema": { "type": "string" } - }, - { - "description": "The list of Asset Version resource SIDs to include in the build.", - "in": "query", - "name": "AssetVersions", - "required": false, - "schema": { - "items": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ZN[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The list of the Variable resource SIDs to include in the build.", - "in": "query", - "name": "FunctionVersions", - "required": false, - "schema": { - "items": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ZN[0-9a-fA-F]{32}$", - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A list of objects that describe the Dependencies included in the build. Each object contains the `name` and `version` of the dependency.", - "in": "query", - "name": "Dependencies", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AssetVersions": { + "description": "The list of Asset Version resource SIDs to include in the build.", + "items": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ZN[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": "array" + }, + "Dependencies": { + "description": "A list of objects that describe the Dependencies included in the build. Each object contains the `name` and `version` of the dependency.", + "type": "string" + }, + "FunctionVersions": { + "description": "The list of the Variable resource SIDs to include in the build.", + "items": { + "maxLength": 34, + "minLength": 34, + "pattern": "^ZN[0-9a-fA-F]{32}$", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1319,7 +1335,8 @@ "$ref": "#/components/schemas/serverless.v1.service.build" } } - } + }, + "description": "Created" } }, "security": [ @@ -1417,7 +1434,8 @@ "$ref": "#/components/schemas/serverless.v1.service.build" } } - } + }, + "description": "OK" } }, "security": [ @@ -1512,7 +1530,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1535,26 +1554,30 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the Environment resource. It can be used as an alternative to the `sid` in the URL path to address the Environment resource. This value must have fewer than 256 characters.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A URL-friendly name that represents the environment and forms part of the domain name. Must have fewer than 32 characters.", - "in": "query", - "name": "DomainSuffix", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DomainSuffix": { + "description": "A URL-friendly name that represents the environment and forms part of the domain name. Must have fewer than 32 characters.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the Environment resource. It can be used as an alternative to the `sid` in the URL path to address the Environment resource. This value must have fewer than 256 characters.", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1563,7 +1586,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment" } } - } + }, + "description": "Created" } }, "security": [ @@ -1671,7 +1695,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1706,20 +1731,26 @@ "pattern": "^ZE[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the build for the deployment.", - "in": "query", - "name": "BuildSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^ZB[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "BuildSid": { + "description": "The SID of the build for the deployment.", + "maxLength": 34, + "minLength": 34, + "pattern": "^ZB[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1728,7 +1759,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" } } - } + }, + "description": "Created" } }, "security": [ @@ -1799,7 +1831,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment.deployment" } } - } + }, + "description": "OK" } }, "security": [ @@ -1853,7 +1886,6 @@ "description": "The SID of the function whose invocation produced the Log resources to read.", "in": "query", "name": "FunctionSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -1865,7 +1897,6 @@ "description": "The date/time (in GMT, ISO 8601) after which the Log resources must have been created. Defaults to 1 day prior to current date/time.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1875,7 +1906,6 @@ "description": "The date/time (in GMT, ISO 8601) before which the Log resources must have been created. Defaults to current date/time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1938,7 +1968,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2005,7 +2036,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment.log" } } - } + }, + "description": "OK" } }, "security": [ @@ -2108,7 +2140,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2143,26 +2176,31 @@ "pattern": "^ZE[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A string by which the Variable resource can be referenced. Must be less than 128 characters long.", - "in": "query", - "name": "Key", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A string that contains the actual value of the variable. Must have less than 450 bytes.", - "in": "query", - "name": "Value", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Key": { + "description": "A string by which the Variable resource can be referenced. Must be less than 128 characters long.", + "type": "string" + }, + "Value": { + "description": "A string that contains the actual value of the variable. Must have less than 450 bytes.", + "type": "string" + } + }, + "required": [ + "Key", + "Value" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2171,7 +2209,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment.variable" } } - } + }, + "description": "Created" } }, "security": [ @@ -2293,7 +2332,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment.variable" } } - } + }, + "description": "OK" } }, "security": [ @@ -2340,26 +2380,27 @@ "pattern": "^ZV[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A string by which the Variable resource can be referenced. Must be less than 128 characters long.", - "in": "query", - "name": "Key", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A string that contains the actual value of the variable. Must have less than 450 bytes.", - "in": "query", - "name": "Value", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Key": { + "description": "A string by which the Variable resource can be referenced. Must be less than 128 characters long.", + "type": "string" + }, + "Value": { + "description": "A string that contains the actual value of the variable. Must have less than 450 bytes.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2368,7 +2409,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment.variable" } } - } + }, + "description": "OK" } }, "security": [ @@ -2466,7 +2508,8 @@ "$ref": "#/components/schemas/serverless.v1.service.environment" } } - } + }, + "description": "OK" } }, "security": [ @@ -2562,7 +2605,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2585,17 +2629,26 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Function resource. It can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Function resource. It can be up to 255 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2604,7 +2657,8 @@ "$ref": "#/components/schemas/serverless.v1.service.function" } } - } + }, + "description": "Created" } }, "security": [ @@ -2711,7 +2765,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2783,7 +2838,8 @@ "$ref": "#/components/schemas/serverless.v1.service.function.function_version" } } - } + }, + "description": "OK" } }, "security": [ @@ -2855,7 +2911,8 @@ "$ref": "#/components/schemas/serverless.v1.service.function.function_version.function_version_content" } } - } + }, + "description": "OK" } }, "security": [ @@ -2952,7 +3009,8 @@ "$ref": "#/components/schemas/serverless.v1.service.function" } } - } + }, + "description": "OK" } }, "security": [ @@ -2987,17 +3045,26 @@ "pattern": "^ZH[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Function resource. It can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Function resource. It can be up to 255 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3006,7 +3073,8 @@ "$ref": "#/components/schemas/serverless.v1.service.function" } } - } + }, + "description": "OK" } }, "security": [ @@ -3080,7 +3148,8 @@ "$ref": "#/components/schemas/serverless.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -3106,35 +3175,31 @@ "pattern": "^ZS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Whether to inject Account credentials into a function invocation context.", - "in": "query", - "name": "IncludeCredentials", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A descriptive string that you create to describe the Service resource. It can be up to 255 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the Service's properties and subresources can be edited via the UI. The default value is `false`.", - "in": "query", - "name": "UiEditable", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Service resource. It can be up to 255 characters long.", + "type": "string" + }, + "IncludeCredentials": { + "description": "Whether to inject Account credentials into a function invocation context.", + "type": "boolean" + }, + "UiEditable": { + "description": "Whether the Service's properties and subresources can be edited via the UI. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3143,7 +3208,8 @@ "$ref": "#/components/schemas/serverless.v1.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_studio.json b/src/services/twilio-api/twilio_studio.json index b0076000..040047e3 100644 --- a/src/services/twilio-api/twilio_studio.json +++ b/src/services/twilio-api/twilio_studio.json @@ -820,7 +820,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -919,7 +920,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -945,35 +947,35 @@ "pattern": "^FW[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`", - "in": "query", - "name": "From", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.", - "in": "query", - "name": "Parameters", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`", + "type": "string" + }, + "Parameters": { + "description": "A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.", + "type": "object" + }, + "To": { + "description": "The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -982,7 +984,8 @@ "$ref": "#/components/schemas/studio.v1.flow.engagement" } } - } + }, + "description": "Created" } }, "security": [ @@ -1045,7 +1048,8 @@ "$ref": "#/components/schemas/studio.v1.flow.engagement.engagement_context" } } - } + }, + "description": "OK" } }, "security": [ @@ -1153,7 +1157,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1228,7 +1233,8 @@ "$ref": "#/components/schemas/studio.v1.flow.engagement.step" } } - } + }, + "description": "OK" } }, "security": [ @@ -1303,7 +1309,8 @@ "$ref": "#/components/schemas/studio.v1.flow.engagement.step.step_context" } } - } + }, + "description": "OK" } }, "security": [ @@ -1405,7 +1412,8 @@ "$ref": "#/components/schemas/studio.v1.flow.engagement" } } - } + }, + "description": "OK" } }, "security": [ @@ -1451,7 +1459,6 @@ "description": "Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", "in": "query", "name": "DateCreatedFrom", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1461,7 +1468,6 @@ "description": "Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", "in": "query", "name": "DateCreatedTo", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1524,7 +1530,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1550,35 +1557,35 @@ "pattern": "^FW[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", - "in": "query", - "name": "From", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", - "in": "query", - "name": "Parameters", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", + "type": "string" + }, + "Parameters": { + "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", + "type": "object" + }, + "To": { + "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1587,7 +1594,8 @@ "$ref": "#/components/schemas/studio.v1.flow.execution" } } - } + }, + "description": "Created" } }, "security": [ @@ -1650,7 +1658,8 @@ "$ref": "#/components/schemas/studio.v1.flow.execution.execution_context" } } - } + }, + "description": "OK" } }, "security": [ @@ -1758,7 +1767,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1832,7 +1842,8 @@ "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step" } } - } + }, + "description": "OK" } }, "security": [ @@ -1906,7 +1917,8 @@ "$ref": "#/components/schemas/studio.v1.flow.execution.execution_step.execution_step_context" } } - } + }, + "description": "OK" } }, "security": [ @@ -2008,7 +2020,8 @@ "$ref": "#/components/schemas/studio.v1.flow.execution" } } - } + }, + "description": "OK" } }, "security": [ @@ -2046,21 +2059,30 @@ "pattern": "^FN[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The status of the Execution. Can only be `ended`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "active", - "ended" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The status of the Execution. Can only be `ended`.", + "enum": [ + "active", + "ended" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2069,7 +2091,8 @@ "$ref": "#/components/schemas/studio.v1.flow.execution" } } - } + }, + "description": "OK" } }, "security": [ @@ -2150,7 +2173,8 @@ "$ref": "#/components/schemas/studio.v1.flow" } } - } + }, + "description": "OK" } }, "security": [ @@ -2237,7 +2261,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2251,48 +2276,42 @@ }, "post": { "description": "Create a Flow.", - "parameters": [ - { - "description": "The string that you assigned to describe the Flow.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The status of the Flow. Can be: `draft` or `published`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "draft", - "published" - ], - "type": "string" - } - }, - { - "description": "JSON representation of flow definition.", - "in": "query", - "name": "Definition", - "required": true, - "schema": { - "type": "object" - } - }, - { - "description": "Description on change made in the revision.", - "in": "query", - "name": "CommitMessage", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommitMessage": { + "description": "Description on change made in the revision.", + "type": "string" + }, + "Definition": { + "description": "JSON representation of flow definition.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the Flow.", + "type": "string" + }, + "Status": { + "description": "The status of the Flow. Can be: `draft` or `published`.", + "enum": [ + "draft", + "published" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Status", + "Definition" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -2301,7 +2320,8 @@ "$ref": "#/components/schemas/studio.v2.flow" } } - } + }, + "description": "Created" } }, "security": [ @@ -2330,48 +2350,42 @@ "description": "TODO: Resource-level docs", "post": { "description": "", - "parameters": [ - { - "description": "", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "draft", - "published" - ], - "type": "string" - } - }, - { - "description": "", - "in": "query", - "name": "Definition", - "required": true, - "schema": { - "type": "object" - } - }, - { - "description": "", - "in": "query", - "name": "CommitMessage", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommitMessage": { + "description": "", + "type": "string" + }, + "Definition": { + "description": "", + "type": "object" + }, + "FriendlyName": { + "description": "", + "type": "string" + }, + "Status": { + "description": "", + "enum": [ + "draft", + "published" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName", + "Status", + "Definition" + ], + "type": "object" + } } } - ], + }, "responses": { "200": { "content": { @@ -2380,7 +2394,8 @@ "$ref": "#/components/schemas/studio.v2.flow_validate" } } - } + }, + "description": "OK" } }, "security": [ @@ -2423,7 +2438,6 @@ "description": "Only show Execution resources starting on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", "in": "query", "name": "DateCreatedFrom", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2433,7 +2447,6 @@ "description": "Only show Execution resources starting before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time, given as `YYYY-MM-DDThh:mm:ss-hh:mm`.", "in": "query", "name": "DateCreatedTo", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2496,7 +2509,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2522,35 +2536,35 @@ "pattern": "^FW[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", - "in": "query", - "name": "From", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", - "in": "query", - "name": "Parameters", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "From": { + "description": "The Twilio phone number to send messages or initiate calls from during the Flow's Execution. Available as variable `{{flow.channel.address}}`.", + "type": "string" + }, + "Parameters": { + "description": "JSON data that will be added to the Flow's context and that can be accessed as variables inside your Flow. For example, if you pass in `Parameters={\"name\":\"Zeke\"}`, a widget in your Flow can reference the variable `{{flow.data.name}}`, which returns \"Zeke\". Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode the JSON string.", + "type": "object" + }, + "To": { + "description": "The Contact phone number to start a Studio Flow Execution, available as variable `{{contact.channel.address}}`.", + "type": "string" + } + }, + "required": [ + "To", + "From" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2559,7 +2573,8 @@ "$ref": "#/components/schemas/studio.v2.flow.execution" } } - } + }, + "description": "Created" } }, "security": [ @@ -2621,7 +2636,8 @@ "$ref": "#/components/schemas/studio.v2.flow.execution.execution_context" } } - } + }, + "description": "OK" } }, "security": [ @@ -2729,7 +2745,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2803,7 +2820,8 @@ "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step" } } - } + }, + "description": "OK" } }, "security": [ @@ -2877,7 +2895,8 @@ "$ref": "#/components/schemas/studio.v2.flow.execution.execution_step.execution_step_context" } } - } + }, + "description": "OK" } }, "security": [ @@ -2979,7 +2998,8 @@ "$ref": "#/components/schemas/studio.v2.flow.execution" } } - } + }, + "description": "OK" } }, "security": [ @@ -3017,21 +3037,30 @@ "pattern": "^FN[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The status of the Execution. Can only be `ended`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "active", - "ended" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The status of the Execution. Can only be `ended`.", + "enum": [ + "active", + "ended" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3040,7 +3069,8 @@ "$ref": "#/components/schemas/studio.v2.flow.execution" } } - } + }, + "description": "OK" } }, "security": [ @@ -3120,7 +3150,8 @@ "$ref": "#/components/schemas/studio.v2.flow" } } - } + }, + "description": "OK" } }, "security": [ @@ -3146,48 +3177,42 @@ "pattern": "^FW[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The status of the Flow. Can be: `draft` or `published`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "draft", - "published" - ], - "type": "string" - } - }, - { - "description": "The string that you assigned to describe the Flow.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "JSON representation of flow definition.", - "in": "query", - "name": "Definition", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "Description on change made in the revision.", - "in": "query", - "name": "CommitMessage", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommitMessage": { + "description": "Description on change made in the revision.", + "type": "string" + }, + "Definition": { + "description": "JSON representation of flow definition.", + "type": "object" + }, + "FriendlyName": { + "description": "The string that you assigned to describe the Flow.", + "type": "string" + }, + "Status": { + "description": "The status of the Flow. Can be: `draft` or `published`.", + "enum": [ + "draft", + "published" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3196,7 +3221,8 @@ "$ref": "#/components/schemas/studio.v2.flow" } } - } + }, + "description": "OK" } }, "security": [ @@ -3295,7 +3321,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3355,7 +3382,8 @@ "$ref": "#/components/schemas/studio.v2.flow.flow_revision" } } - } + }, + "description": "OK" } }, "security": [ @@ -3406,7 +3434,8 @@ "$ref": "#/components/schemas/studio.v2.flow.test_user" } } - } + }, + "description": "OK" } }, "security": [ @@ -3432,20 +3461,29 @@ "pattern": "^FW[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "", - "in": "query", - "name": "TestUsers", - "required": true, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "TestUsers": { + "description": "", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "TestUsers" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3454,7 +3492,8 @@ "$ref": "#/components/schemas/studio.v2.flow.test_user" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_supersim.json b/src/services/twilio-api/twilio_supersim.json index 32b77b16..5a94ac7f 100644 --- a/src/services/twilio-api/twilio_supersim.json +++ b/src/services/twilio-api/twilio_supersim.json @@ -235,7 +235,6 @@ "description": "The SID or unique name of the Sim that Command was sent to or from.", "in": "query", "name": "Sim", - "required": false, "schema": { "type": "string" } @@ -244,7 +243,6 @@ "description": "The status of the Command. Can be: `queued`, `sent`, `delivered`, `received` or `failed`. See the [Command Status Values](https://www.twilio.com/docs/wireless/api/command-resource#status-values) for a description of each.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "queued", @@ -260,7 +258,6 @@ "description": "The direction of the Command. Can be `to_sim` or `from_sim`. The value of `to_sim` is synonymous with the term `mobile terminated`, and `from_sim` is synonymous with the term `mobile originated`.", "in": "query", "name": "Direction", - "required": false, "schema": { "enum": [ "to_sim", @@ -326,7 +323,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -340,62 +338,55 @@ }, "post": { "description": "Send a Command to a Sim.", - "parameters": [ - { - "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to.", - "in": "query", - "name": "Sim", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^HS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The message body of the command.", - "in": "query", - "name": "Command", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `callback_method` after we have sent the command.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is POST.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CallbackUrl": { + "description": "The URL we should call using the `callback_method` after we have sent the command.", + "format": "uri", + "type": "string" + }, + "Command": { + "description": "The message body of the command.", + "type": "string" + }, + "Sim": { + "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to.", + "maxLength": 34, + "minLength": 34, + "pattern": "^HS[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Sim", + "Command" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -404,7 +395,8 @@ "$ref": "#/components/schemas/supersim.v1.command" } } - } + }, + "description": "Created" } }, "security": [ @@ -454,7 +446,8 @@ "$ref": "#/components/schemas/supersim.v1.command" } } - } + }, + "description": "OK" } }, "security": [ @@ -540,7 +533,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -554,68 +548,52 @@ }, "post": { "description": "Create a Fleet", - "parameters": [ - { - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M/NB-IoT data connectivity", - "in": "query", - "name": "DataEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Defines whether SIMs in the Fleet are capable of sending and receiving Commands via SMS.", - "in": "query", - "name": "CommandsEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL that will receive a webhook when a SIM in the Fleet originates a machine-to-machine Command. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.", - "in": "query", - "name": "CommandsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "A string representing the HTTP method to use when making a request to `commands_url`. Can be one of POST or GET. Defaults to POST.", - "in": "query", - "name": "CommandsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CommandsEnabled": { + "description": "Defines whether SIMs in the Fleet are capable of sending and receiving Commands via SMS.", + "type": "boolean" + }, + "CommandsMethod": { + "description": "A string representing the HTTP method to use when making a request to `commands_url`. Can be one of POST or GET. Defaults to POST.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CommandsUrl": { + "description": "The URL that will receive a webhook when a SIM in the Fleet originates a machine-to-machine Command. Your server should respond with an HTTP status code in the 200 range; any response body will be ignored.", + "format": "uri", + "type": "string" + }, + "DataEnabled": { + "description": "Defines whether SIMs in the Fleet are capable of using 2G/3G/4G/LTE/CAT-M/NB-IoT data connectivity", + "type": "boolean" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -624,7 +602,8 @@ "$ref": "#/components/schemas/supersim.v1.fleet" } } - } + }, + "description": "Created" } }, "security": [ @@ -671,7 +650,8 @@ "$ref": "#/components/schemas/supersim.v1.fleet" } } - } + }, + "description": "OK" } }, "security": [ @@ -694,17 +674,23 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -713,7 +699,8 @@ "$ref": "#/components/schemas/supersim.v1.fleet" } } - } + }, + "description": "OK" } }, "security": [ @@ -746,7 +733,6 @@ "description": "The status of the Sim resources to read. Can be `new`, `active`, `inactive`, or `scheduled`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "new", @@ -762,7 +748,6 @@ "description": "The SID or unique name of the Fleet to which a list of Sims are assigned.", "in": "query", "name": "Fleet", - "required": false, "schema": { "type": "string" } @@ -771,7 +756,6 @@ "description": "The [ICCID](https://en.wikipedia.org/wiki/Subscriber_identity_module#ICCID) associated with a Super SIM to filter the list by. Passing this parameter will always return a list containing zero or one SIMs.", "in": "query", "name": "Iccid", - "required": false, "schema": { "type": "string" } @@ -833,7 +817,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -880,7 +865,8 @@ "$ref": "#/components/schemas/supersim.v1.sim" } } - } + }, + "description": "OK" } }, "security": [ @@ -903,39 +889,35 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The new status of the resource. Can be: `active` or `inactive`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for more info.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "active", - "inactive" - ], - "type": "string" - } - }, - { - "description": "The SID or unique name of the Fleet to which the SIM resource should be assigned.", - "in": "query", - "name": "Fleet", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Fleet": { + "description": "The SID or unique name of the Fleet to which the SIM resource should be assigned.", + "type": "string" + }, + "Status": { + "description": "The new status of the resource. Can be: `active` or `inactive`. See the [Super SIM Status Values](https://www.twilio.com/docs/iot/supersim/api/sim-resource#status-values) for more info.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -944,7 +926,8 @@ "$ref": "#/components/schemas/supersim.v1.sim" } } - } + }, + "description": "OK" }, "202": { "content": { @@ -953,7 +936,8 @@ "$ref": "#/components/schemas/supersim.v1.sim" } } - } + }, + "description": "Accepted" } }, "security": [ @@ -986,7 +970,6 @@ "description": "SID of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM.", "in": "query", "name": "Sim", - "required": false, "schema": { "type": "string" } @@ -995,7 +978,6 @@ "description": "Time-based grouping that UsageRecords should be aggregated by. Can be: `hour`, `day`, or `all`. Default is `all`. `all` returns one UsageRecord that describes the usage for the entire period.", "in": "query", "name": "Granularity", - "required": false, "schema": { "enum": [ "hour", @@ -1009,7 +991,6 @@ "description": "Only include usage that occurred at or after this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is one month before the `end_time`.", "in": "query", "name": "StartTime", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1019,7 +1000,6 @@ "description": "Only include usage that occurred before this time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Default is the current time.", "in": "query", "name": "EndTime", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1082,7 +1062,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_sync.json b/src/services/twilio-api/twilio_sync.json index 32bbb6b7..bc857f3d 100644 --- a/src/services/twilio-api/twilio_sync.json +++ b/src/services/twilio-api/twilio_sync.json @@ -582,7 +582,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -596,72 +597,46 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A string that you assign to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call when Sync objects are manipulated.", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.", - "in": "query", - "name": "ReachabilityWebhooksEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.", - "in": "query", - "name": "AclEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.", - "in": "query", - "name": "ReachabilityDebouncingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the `webhook_url` is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the call to `webhook_url`.", - "in": "query", - "name": "ReachabilityDebouncingWindow", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.", - "in": "query", - "name": "WebhooksFromRestEnabled", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A string that you assign to describe the resource.", + "type": "string" + }, + "ReachabilityDebouncingEnabled": { + "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.", + "type": "boolean" + }, + "ReachabilityDebouncingWindow": { + "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the `webhook_url` is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the call to `webhook_url`.", + "type": "integer" + }, + "ReachabilityWebhooksEnabled": { + "description": "Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.", + "type": "boolean" + }, + "WebhookUrl": { + "description": "The URL we should call when Sync objects are manipulated.", + "format": "uri", + "type": "string" + }, + "WebhooksFromRestEnabled": { + "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.", + "type": "boolean" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -670,7 +645,8 @@ "$ref": "#/components/schemas/sync.v1.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -765,7 +741,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -788,35 +765,31 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the Sync Document", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16KB in length.", - "in": "query", - "name": "Data", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "How long, in seconds, before the Sync Document expires and is deleted (the Sync Document's time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync Document does not expire. The Sync Document will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16KB in length.", + "type": "object" + }, + "Ttl": { + "description": "How long, in seconds, before the Sync Document expires and is deleted (the Sync Document's time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync Document does not expire. The Sync Document will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the Sync Document", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -825,7 +798,8 @@ "$ref": "#/components/schemas/sync.v1.service.document" } } - } + }, + "description": "Created" } }, "security": [ @@ -929,7 +903,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1040,7 +1015,8 @@ "$ref": "#/components/schemas/sync.v1.service.document.document_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -1081,35 +1057,36 @@ "schema": { "type": "string" } - }, - { - "description": "Whether the identity can read the Sync Document. Default value is `false`.", - "in": "query", - "name": "Read", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the identity can update the Sync Document. Default value is `false`.", - "in": "query", - "name": "Write", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the identity can delete the Sync Document. Default value is `false`.", - "in": "query", - "name": "Manage", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Whether the identity can delete the Sync Document. Default value is `false`.", + "type": "boolean" + }, + "Read": { + "description": "Whether the identity can read the Sync Document. Default value is `false`.", + "type": "boolean" + }, + "Write": { + "description": "Whether the identity can update the Sync Document. Default value is `false`.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1118,7 +1095,8 @@ "$ref": "#/components/schemas/sync.v1.service.document.document_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -1211,7 +1189,8 @@ "$ref": "#/components/schemas/sync.v1.service.document" } } - } + }, + "description": "OK" } }, "security": [ @@ -1243,26 +1222,27 @@ "schema": { "type": "string" } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16KB in length.", - "in": "query", - "name": "Data", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "How long, in seconds, before the Sync Document expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Document resource does not expire. The Document resource will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that the Sync Document stores. Can be up to 16KB in length.", + "type": "object" + }, + "Ttl": { + "description": "How long, in seconds, before the Sync Document expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Document resource does not expire. The Document resource will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1271,7 +1251,8 @@ "$ref": "#/components/schemas/sync.v1.service.document" } } - } + }, + "description": "OK" } }, "security": [ @@ -1366,7 +1347,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1389,35 +1371,31 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Alias for collection_ttl. If both are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "Alias for collection_ttl. If both are provided, this value is ignored.", + "type": "integer" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1426,7 +1404,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list" } } - } + }, + "description": "Created" } }, "security": [ @@ -1477,7 +1456,6 @@ "description": "How to order the List Items returned by their `index` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending.", "in": "query", "name": "Order", - "required": false, "schema": { "enum": [ "asc", @@ -1490,7 +1468,6 @@ "description": "The `index` of the first Sync List Item resource to read. See also `bounds`.", "in": "query", "name": "From", - "required": false, "schema": { "type": "string" } @@ -1499,7 +1476,6 @@ "description": "Whether to include the List Item referenced by the `from` parameter. Can be: `inclusive` to include the List Item referenced by the `from` parameter or `exclusive` to start with the next List Item. The default value is `inclusive`.", "in": "query", "name": "Bounds", - "required": false, "schema": { "enum": [ "inclusive", @@ -1565,7 +1541,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1597,44 +1574,38 @@ "schema": { "type": "string" } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16KB in length.", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } - }, - { - "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the List Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the List Item does not expire. The List Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "ItemTtl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16KB in length.", + "type": "object" + }, + "ItemTtl": { + "description": "How long, in seconds, before the List Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the List Item does not expire. The List Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", + "type": "integer" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1643,7 +1614,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" } } - } + }, + "description": "Created" } }, "security": [ @@ -1753,7 +1725,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -1794,44 +1767,35 @@ "schema": { "type": "integer" } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16KB in length.", - "in": "query", - "name": "Data", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the List Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the List Item does not expire. The List Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "ItemTtl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the List Item's parent Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that the List Item stores. Can be up to 16KB in length.", + "type": "object" + }, + "ItemTtl": { + "description": "How long, in seconds, before the List Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the List Item does not expire. The List Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1840,7 +1804,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -1944,7 +1909,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2055,7 +2021,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -2096,35 +2063,36 @@ "schema": { "type": "string" } - }, - { - "description": "Whether the identity can read the Sync List and its Items. Default value is `false`.", - "in": "query", - "name": "Read", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the identity can create, update, and delete Items in the Sync List. Default value is `false`.", - "in": "query", - "name": "Write", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the identity can delete the Sync List. Default value is `false`.", - "in": "query", - "name": "Manage", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Whether the identity can delete the Sync List. Default value is `false`.", + "type": "boolean" + }, + "Read": { + "description": "Whether the identity can read the Sync List and its Items. Default value is `false`.", + "type": "boolean" + }, + "Write": { + "description": "Whether the identity can create, update, and delete Items in the Sync List. Default value is `false`.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2133,7 +2101,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list.sync_list_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -2226,7 +2195,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -2258,26 +2228,27 @@ "schema": { "type": "string" } - }, - { - "description": "An alias for `collection_ttl`. If both are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the Sync List expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync List does not expire. The Sync List will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "An alias for `collection_ttl`. If both are provided, this value is ignored.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2286,7 +2257,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -2381,7 +2353,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2404,35 +2377,31 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "An alias for `collection_ttl`. If both parameters are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "An alias for `collection_ttl`. If both parameters are provided, this value is ignored.", + "type": "integer" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2441,7 +2410,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map" } } - } + }, + "description": "Created" } }, "security": [ @@ -2492,7 +2462,6 @@ "description": "How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](https://en.wikipedia.org/wiki/Lexicographical_order) by Item key.", "in": "query", "name": "Order", - "required": false, "schema": { "enum": [ "asc", @@ -2505,7 +2474,6 @@ "description": "The `key` of the first Sync Map Item resource to read. See also `bounds`.", "in": "query", "name": "From", - "required": false, "schema": { "type": "string" } @@ -2514,7 +2482,6 @@ "description": "Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.", "in": "query", "name": "Bounds", - "required": false, "schema": { "enum": [ "inclusive", @@ -2580,7 +2547,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2612,53 +2580,43 @@ "schema": { "type": "string" } - }, - { - "description": "The unique, user-defined key for the Map Item. Can be up to 320 characters long.", - "in": "query", - "name": "Key", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } - }, - { - "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Map Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Map Item does not expire. The Map Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "ItemTtl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Map Item's parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the Map Item's parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.", + "type": "object" + }, + "ItemTtl": { + "description": "How long, in seconds, before the Map Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Map Item does not expire. The Map Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Key": { + "description": "The unique, user-defined key for the Map Item. Can be up to 320 characters long.", + "type": "string" + }, + "Ttl": { + "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", + "type": "integer" + } + }, + "required": [ + "Key", + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2667,7 +2625,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" } } - } + }, + "description": "Created" } }, "security": [ @@ -2777,7 +2736,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -2818,44 +2778,35 @@ "schema": { "type": "string" } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.", - "in": "query", - "name": "Data", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Map Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Map Item does not expire. The Map Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "ItemTtl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Map Item's parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync Map does not expire. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the Map Item's parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync Map does not expire. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.", + "type": "object" + }, + "ItemTtl": { + "description": "How long, in seconds, before the Map Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Map Item does not expire. The Map Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "An alias for `item_ttl`. If both parameters are provided, this value is ignored.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2864,7 +2815,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_item" } } - } + }, + "description": "OK" } }, "security": [ @@ -2968,7 +2920,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3079,7 +3032,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -3120,35 +3074,36 @@ "schema": { "type": "string" } - }, - { - "description": "Whether the identity can read the Sync Map and its Items. Default value is `false`.", - "in": "query", - "name": "Read", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`.", - "in": "query", - "name": "Write", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the identity can delete the Sync Map. Default value is `false`.", - "in": "query", - "name": "Manage", - "required": true, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Manage": { + "description": "Whether the identity can delete the Sync Map. Default value is `false`.", + "type": "boolean" + }, + "Read": { + "description": "Whether the identity can read the Sync Map and its Items. Default value is `false`.", + "type": "boolean" + }, + "Write": { + "description": "Whether the identity can create, update, and delete Items in the Sync Map. Default value is `false`.", + "type": "boolean" + } + }, + "required": [ + "Read", + "Write", + "Manage" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3157,7 +3112,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map.sync_map_permission" } } - } + }, + "description": "OK" } }, "security": [ @@ -3250,7 +3206,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map" } } - } + }, + "description": "OK" } }, "security": [ @@ -3282,26 +3239,27 @@ "schema": { "type": "string" } - }, - { - "description": "An alias for `collection_ttl`. If both parameters are provided, this value is ignored.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How long, in seconds, before the Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "CollectionTtl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CollectionTtl": { + "description": "How long, in seconds, before the Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Sync Map does not expire. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "Ttl": { + "description": "An alias for `collection_ttl`. If both parameters are provided, this value is ignored.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3310,7 +3268,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_map" } } - } + }, + "description": "OK" } }, "security": [ @@ -3405,7 +3364,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3428,26 +3388,27 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "How long, in seconds, before the Stream expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Stream does not expire. The Stream will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Ttl": { + "description": "How long, in seconds, before the Stream expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Stream does not expire. The Stream will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. This value must be unique within its Service and it can be up to 320 characters long. The `unique_name` value can be used as an alternative to the `sid` in the URL path to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3456,7 +3417,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_stream" } } - } + }, + "description": "Created" } }, "security": [ @@ -3548,7 +3510,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_stream" } } - } + }, + "description": "OK" } }, "security": [ @@ -3580,17 +3543,23 @@ "schema": { "type": "string" } - }, - { - "description": "How long, in seconds, before the Stream expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Stream does not expire. The Stream will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", - "in": "query", - "name": "Ttl", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Ttl": { + "description": "How long, in seconds, before the Stream expires and is deleted (time-to-live). Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Stream does not expire. The Stream will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3599,7 +3568,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_stream" } } - } + }, + "description": "OK" } }, "security": [ @@ -3645,17 +3615,26 @@ "schema": { "type": "string" } - }, - { - "description": "A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4KB in length.", - "in": "query", - "name": "Data", - "required": true, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Data": { + "description": "A JSON string that represents an arbitrary, schema-less object that makes up the Stream Message body. Can be up to 4KB in length.", + "type": "object" + } + }, + "required": [ + "Data" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -3664,7 +3643,8 @@ "$ref": "#/components/schemas/sync.v1.service.sync_stream.stream_message" } } - } + }, + "description": "Created" } }, "security": [ @@ -3736,7 +3716,8 @@ "$ref": "#/components/schemas/sync.v1.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -3759,72 +3740,48 @@ "schema": { "type": "string" } - }, - { - "description": "The URL we should call when Sync objects are manipulated.", - "in": "query", - "name": "WebhookUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "A string that you assign to describe the resource.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.", - "in": "query", - "name": "ReachabilityWebhooksEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.", - "in": "query", - "name": "AclEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.", - "in": "query", - "name": "ReachabilityDebouncingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called.", - "in": "query", - "name": "ReachabilityDebouncingWindow", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.", - "in": "query", - "name": "WebhooksFromRestEnabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AclEnabled": { + "description": "Whether token identities in the Service must be granted access to Sync objects by using the [Permissions](https://www.twilio.com/docs/sync/api/sync-permissions) resource.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A string that you assign to describe the resource.", + "type": "string" + }, + "ReachabilityDebouncingEnabled": { + "description": "Whether every `endpoint_disconnected` event should occur after a configurable delay. The default is `false`, where the `endpoint_disconnected` event occurs immediately after disconnection. When `true`, intervening reconnections can prevent the `endpoint_disconnected` event.", + "type": "boolean" + }, + "ReachabilityDebouncingWindow": { + "description": "The reachability event delay in milliseconds if `reachability_debouncing_enabled` = `true`. Must be between 1,000 and 30,000 and defaults to 5,000. This is the number of milliseconds after the last running client disconnects, and a Sync identity is declared offline, before the webhook is called if all endpoints remain offline. A reconnection from the same identity by any endpoint during this interval prevents the webhook from being called.", + "type": "integer" + }, + "ReachabilityWebhooksEnabled": { + "description": "Whether the service instance should call `webhook_url` when client endpoints connect to Sync. The default is `false`.", + "type": "boolean" + }, + "WebhookUrl": { + "description": "The URL we should call when Sync objects are manipulated.", + "format": "uri", + "type": "string" + }, + "WebhooksFromRestEnabled": { + "description": "Whether the Service instance should call `webhook_url` when the REST API is used to update Sync objects. The default is `false`.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3833,7 +3790,8 @@ "$ref": "#/components/schemas/sync.v1.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_taskrouter.json b/src/services/twilio-api/twilio_taskrouter.json index accab7db..63fa277f 100644 --- a/src/services/twilio-api/twilio_taskrouter.json +++ b/src/services/twilio-api/twilio_taskrouter.json @@ -1414,7 +1414,6 @@ "description": "The `friendly_name` of the Workspace resources to read. For example `Customer Support` or `2014 Election Campaign`.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -1476,7 +1475,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1490,67 +1490,49 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the Workspace resource. It can be up to 64 characters long. For example: `Customer Support` or `2014 Election Campaign`.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.", - "in": "query", - "name": "EventCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The list of Workspace events for which to call event_callback_url. For example if `EventsFilter=task.created,task.canceled,worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.", - "in": "query", - "name": "EventsFilter", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to enable multi-tasking. Can be: `true` to enable multi-tasking, or `false` to disable it. The default is `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. Otherwise, each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].", - "in": "query", - "name": "MultiTaskEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "An available template name. Can be: `NONE` or `FIFO` and the default is `NONE`. Pre-configures the Workspace with the Workflow and Activities specified in the template. `NONE` will create a Workspace with only a set of default activities. `FIFO` will configure TaskRouter with a set of default activities and a single TaskQueue for first-in, first-out distribution, which can be useful when you are getting started with TaskRouter.", - "in": "query", - "name": "Template", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].", - "in": "query", - "name": "PrioritizeQueueOrder", - "required": false, - "schema": { - "enum": [ - "FIFO", - "LIFO" - ], - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "EventCallbackUrl": { + "description": "The URL we should call when an event occurs. If provided, the Workspace will publish events to this URL, for example, to collect data for reporting. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.", + "format": "uri", + "type": "string" + }, + "EventsFilter": { + "description": "The list of Workspace events for which to call event_callback_url. For example if `EventsFilter=task.created,task.canceled,worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Workspace resource. It can be up to 64 characters long. For example: `Customer Support` or `2014 Election Campaign`.", + "type": "string" + }, + "MultiTaskEnabled": { + "description": "Whether to enable multi-tasking. Can be: `true` to enable multi-tasking, or `false` to disable it. The default is `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. Otherwise, each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].", + "type": "boolean" + }, + "PrioritizeQueueOrder": { + "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].", + "enum": [ + "FIFO", + "LIFO" + ], + "type": "string" + }, + "Template": { + "description": "An available template name. Can be: `NONE` or `FIFO` and the default is `NONE`. Pre-configures the Workspace with the Workflow and Activities specified in the template. `NONE` will create a Workspace with only a set of default activities. `FIFO` will configure TaskRouter with a set of default activities and a single TaskQueue for first-in, first-out distribution, which can be useful when you are getting started with TaskRouter.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1559,7 +1541,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace" } } - } + }, + "description": "Created" } }, "security": [ @@ -1639,7 +1622,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace" } } - } + }, + "description": "OK" } }, "security": [ @@ -1665,82 +1649,58 @@ "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the Activity that will be used when new Workers are created in the Workspace.", - "in": "query", - "name": "DefaultActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The URL we should call when an event occurs. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.", - "in": "query", - "name": "EventCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The list of Workspace events for which to call event_callback_url. For example if `EventsFilter=task.created,task.canceled,worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.", - "in": "query", - "name": "EventsFilter", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the Workspace resource. For example: `Sales Call Center` or `Customer Support Team`.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to enable multi-tasking. Can be: `true` to enable multi-tasking, or `false` to disable it. The default is `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. Otherwise, each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].", - "in": "query", - "name": "MultiTaskEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.", - "in": "query", - "name": "TimeoutActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].", - "in": "query", - "name": "PrioritizeQueueOrder", - "required": false, - "schema": { - "enum": [ - "FIFO", - "LIFO" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DefaultActivitySid": { + "description": "The SID of the Activity that will be used when new Workers are created in the Workspace.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "EventCallbackUrl": { + "description": "The URL we should call when an event occurs. See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.", + "format": "uri", + "type": "string" + }, + "EventsFilter": { + "description": "The list of Workspace events for which to call event_callback_url. For example if `EventsFilter=task.created,task.canceled,worker.activity.update`, then TaskRouter will call event_callback_url only when a task is created, canceled, or a Worker activity is updated.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Workspace resource. For example: `Sales Call Center` or `Customer Support Team`.", + "type": "string" + }, + "MultiTaskEnabled": { + "description": "Whether to enable multi-tasking. Can be: `true` to enable multi-tasking, or `false` to disable it. The default is `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously. When enabled (`true`), each Worker can receive parallel reservations up to the per-channel maximums defined in the Workers section. Otherwise, each Worker will only receive a new reservation when the previous task is completed. Learn more at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].", + "type": "boolean" + }, + "PrioritizeQueueOrder": { + "description": "The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues. Can be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].", + "enum": [ + "FIFO", + "LIFO" + ], + "type": "string" + }, + "TimeoutActivitySid": { + "description": "The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1749,7 +1709,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace" } } - } + }, + "description": "OK" } }, "security": [ @@ -1794,7 +1755,6 @@ "description": "The `friendly_name` of the Activity resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -1803,7 +1763,6 @@ "description": "Whether return only Activity resources that are available or unavailable. A value of `true` returns only available activities. Values of '1' or `yes` also indicate `true`. All other values represent `false` and return activities that are unavailable.", "in": "query", "name": "Available", - "required": false, "schema": { "type": "string" } @@ -1865,7 +1824,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1891,26 +1851,30 @@ "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not.", - "in": "query", - "name": "Available", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Available": { + "description": "Whether the Worker should be eligible to receive a Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies the Activity is available. All other values specify that it is not.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1919,7 +1883,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" } } - } + }, + "description": "Created" } }, "security": [ @@ -2023,7 +1988,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" } } - } + }, + "description": "OK" } }, "security": [ @@ -2061,17 +2027,23 @@ "pattern": "^WA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the Activity resource. It can be up to 64 characters long. These names are used to calculate and expose statistics about Workers, and provide visibility into the state of each Worker. Examples of friendly names include: `on-call`, `break`, and `email`.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2080,7 +2052,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.activity" } } - } + }, + "description": "OK" } }, "security": [ @@ -2125,7 +2098,6 @@ "description": "Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2135,7 +2107,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -2144,7 +2115,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2154,7 +2124,6 @@ "description": "Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -2163,7 +2132,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -2177,7 +2145,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_cumulative_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -2223,7 +2192,6 @@ "description": "Only include Events that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2233,7 +2201,6 @@ "description": "The type of Events to read. Returns only Events of the type specified.", "in": "query", "name": "EventType", - "required": false, "schema": { "type": "string" } @@ -2242,7 +2209,6 @@ "description": "The period of events to read in minutes. Returns only Events that occurred since this many minutes in the past. The default is `15` minutes.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -2251,7 +2217,6 @@ "description": "The SID of the Reservation with the Events to read. Returns only Events that pertain to the specified Reservation.", "in": "query", "name": "ReservationSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -2263,7 +2228,6 @@ "description": "Only include Events from on or after this date and time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2273,7 +2237,6 @@ "description": "The SID of the TaskQueue with the Events to read. Returns only the Events that pertain to the specified TaskQueue.", "in": "query", "name": "TaskQueueSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -2285,7 +2248,6 @@ "description": "The SID of the Task with the Events to read. Returns only the Events that pertain to the specified Task.", "in": "query", "name": "TaskSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -2297,7 +2259,6 @@ "description": "The SID of the Worker with the Events to read. Returns only the Events that pertain to the specified Worker.", "in": "query", "name": "WorkerSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -2309,7 +2270,6 @@ "description": "The SID of the Workflow with the Events to read. Returns only the Events that pertain to the specified Workflow.", "in": "query", "name": "WorkflowSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -2321,7 +2281,6 @@ "description": "The TaskChannel with the Events to read. Returns only the Events that pertain to the specified TaskChannel.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -2330,7 +2289,6 @@ "description": "The SID of the Event resource to read.", "in": "query", "name": "Sid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -2395,7 +2353,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2457,7 +2416,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.event" } } - } + }, + "description": "OK" } }, "security": [ @@ -2502,7 +2462,6 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -2516,7 +2475,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_real_time_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -2561,7 +2521,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -2570,7 +2529,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2580,7 +2538,6 @@ "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2590,7 +2547,6 @@ "description": "Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -2599,7 +2555,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -2613,7 +2568,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workspace_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -2709,7 +2665,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2735,35 +2692,35 @@ "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the TaskChannel. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the TaskChannel, such as `voice` or `sms`.", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.", - "in": "query", - "name": "ChannelOptimizedRouting", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChannelOptimizedRouting": { + "description": "Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the TaskChannel. It can be up to 64 characters long.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the TaskChannel, such as `voice` or `sms`.", + "type": "string" + } + }, + "required": [ + "FriendlyName", + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -2772,7 +2729,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" } } - } + }, + "description": "Created" } }, "security": [ @@ -2870,7 +2828,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -2905,26 +2864,27 @@ "schema": { "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the TaskChannel. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.", - "in": "query", - "name": "ChannelOptimizedRouting", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ChannelOptimizedRouting": { + "description": "Whether the TaskChannel should prioritize Workers that have been idle. If `true`, Workers that have been idle the longest are prioritized.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the TaskChannel. It can be up to 64 characters long.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2933,7 +2893,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -2978,7 +2939,6 @@ "description": "The `friendly_name` of the TaskQueue resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -2987,7 +2947,6 @@ "description": "The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.", "in": "query", "name": "EvaluateWorkerAttributes", - "required": false, "schema": { "type": "string" } @@ -2996,7 +2955,6 @@ "description": "The SID of the Worker with the TaskQueue resources to read.", "in": "query", "name": "WorkerSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -3061,7 +3019,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3087,84 +3046,69 @@ "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AssignmentActivitySid": { + "description": "The SID of the Activity to assign Workers when a task is assigned to them.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.", + "type": "string" + }, + "MaxReservedWorkers": { + "description": "The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.", + "type": "integer" + }, + "ReservationActivitySid": { + "description": "The SID of the Activity to assign Workers when a task is reserved for them.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "TargetWorkers": { + "description": "A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, `'\"language\" == \"spanish\"'`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see [Describing Worker selection criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).", + "type": "string" + }, + "TaskOrder": { + "description": "How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or FIFO to assign the oldest Task first. Default is `FIFO`. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more.", + "enum": [ + "FIFO", + "LIFO" + ], + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } - }, - { - "description": "A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, `'\"language\" == \"spanish\"'`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see [Describing Worker selection criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).", - "in": "query", - "name": "TargetWorkers", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.", - "in": "query", - "name": "MaxReservedWorkers", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How Tasks will be assigned to Workers. Set this parameter to `LIFO` to assign most recently created Task first or FIFO to assign the oldest Task first. Default is `FIFO`. [Click here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more.", - "in": "query", - "name": "TaskOrder", - "required": false, - "schema": { - "enum": [ - "FIFO", - "LIFO" - ], - "type": "string" - } - }, - { - "description": "The SID of the Activity to assign Workers when a task is reserved for them.", - "in": "query", - "name": "ReservationActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Activity to assign Workers when a task is assigned to them.", - "in": "query", - "name": "AssignmentActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" - } - } - } - } - }, - "security": [ + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" + } + } + }, + "description": "Created" + } + }, + "security": [ { "accountSid_authToken": [] } @@ -3206,7 +3150,6 @@ "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3216,7 +3159,6 @@ "description": "The `friendly_name` of the TaskQueue statistics to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -3225,7 +3167,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -3234,7 +3175,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3244,7 +3184,6 @@ "description": "Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -3253,7 +3192,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -3315,7 +3253,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3417,7 +3356,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" } } - } + }, + "description": "OK" } }, "security": [ @@ -3455,72 +3395,53 @@ "pattern": "^WQ[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example '\"language\" == \"spanish\"' If no TargetWorkers parameter is provided, Tasks will wait in the queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below.", - "in": "query", - "name": "TargetWorkers", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Activity to assign Workers when a task is reserved for them.", - "in": "query", - "name": "ReservationActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Activity to assign Workers when a task is assigned for them.", - "in": "query", - "name": "AssignmentActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50.", - "in": "query", - "name": "MaxReservedWorkers", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "How Tasks will be assigned to Workers. Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).", - "in": "query", - "name": "TaskOrder", - "required": false, - "schema": { - "enum": [ - "FIFO", - "LIFO" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AssignmentActivitySid": { + "description": "The SID of the Activity to assign Workers when a task is assigned for them.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.", + "type": "string" + }, + "MaxReservedWorkers": { + "description": "The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50.", + "type": "integer" + }, + "ReservationActivitySid": { + "description": "The SID of the Activity to assign Workers when a task is reserved for them.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "TargetWorkers": { + "description": "A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example '\"language\" == \"spanish\"' If no TargetWorkers parameter is provided, Tasks will wait in the queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below.", + "type": "string" + }, + "TaskOrder": { + "description": "How Tasks will be assigned to Workers. Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).", + "enum": [ + "FIFO", + "LIFO" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3529,7 +3450,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue" } } - } + }, + "description": "OK" } }, "security": [ @@ -3586,7 +3508,6 @@ "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3596,7 +3517,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -3605,7 +3525,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3615,7 +3534,6 @@ "description": "Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -3624,7 +3542,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -3638,7 +3555,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_cumulative_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -3696,7 +3614,6 @@ "description": "The TaskChannel for which to fetch statistics. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -3710,7 +3627,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_real_time_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -3767,7 +3685,6 @@ "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3777,7 +3694,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default is 15 minutes.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -3786,7 +3702,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3796,7 +3711,6 @@ "description": "Only calculate real-time and cumulative statistics for the specified TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -3805,7 +3719,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -3819,7 +3732,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task_queue.task_queue_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -3862,7 +3776,6 @@ "description": "The priority value of the Tasks to read. Returns the list of all Tasks in the Workspace with the specified priority.", "in": "query", "name": "Priority", - "required": false, "schema": { "type": "integer" } @@ -3871,7 +3784,6 @@ "description": "The `assignment_status` of the Tasks to read. Can be: `pending`, `reserved`, `assigned`, `canceled`, and `completed`. Returns all Tasks in the Workspace with the specified `assignment_status`.", "in": "query", "name": "AssignmentStatus", - "required": false, "schema": { "items": { "type": "string" @@ -3883,7 +3795,6 @@ "description": "The SID of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this SID.", "in": "query", "name": "WorkflowSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -3895,7 +3806,6 @@ "description": "The friendly name of the Workflow with the Tasks to read. Returns the Tasks controlled by the Workflow identified by this friendly name.", "in": "query", "name": "WorkflowName", - "required": false, "schema": { "type": "string" } @@ -3904,7 +3814,6 @@ "description": "The SID of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this SID.", "in": "query", "name": "TaskQueueSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -3916,7 +3825,6 @@ "description": "The `friendly_name` of the TaskQueue with the Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this friendly name.", "in": "query", "name": "TaskQueueName", - "required": false, "schema": { "type": "string" } @@ -3925,7 +3833,6 @@ "description": "The attributes of the Tasks to read. Returns the Tasks that match the attributes specified in this parameter.", "in": "query", "name": "EvaluateTaskAttributes", - "required": false, "schema": { "type": "string" } @@ -3934,7 +3841,6 @@ "description": "How to order the returned Task resources. y default, Tasks are sorted by ascending DateCreated. This value is specified as: `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated` and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered in descending order of their Priority. Multiple sort orders can be specified in a comma-separated list such as `Priority:desc,DateCreated:asc`, which returns the Tasks in descending Priority order and ascending DateCreated Order.", "in": "query", "name": "Ordering", - "required": false, "schema": { "type": "string" } @@ -3943,7 +3849,6 @@ "description": "Whether to read Tasks with addons. If `true`, returns only Tasks with addons. If `false`, returns only Tasks without addons.", "in": "query", "name": "HasAddons", - "required": false, "schema": { "type": "boolean" } @@ -4005,7 +3910,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -4031,56 +3937,42 @@ "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The amount of time in seconds the new task is allowed to live. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire with description `Task TTL Exceeded`.", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^31^ (2,147,483,647).", - "in": "query", - "name": "Priority", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.", - "in": "query", - "name": "TaskChannel", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.", - "in": "query", - "name": "WorkflowSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \"task_type\": \"call\", \"twilio_call_sid\": \"CAxxx\", \"customer_ticket_number\": \"12345\" }`.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Attributes": { + "description": "A URL-encoded JSON string with the attributes of the new task. This value is passed to the Workflow's `assignment_callback_url` when the Task is assigned to a Worker. For example: `{ \"task_type\": \"call\", \"twilio_call_sid\": \"CAxxx\", \"customer_ticket_number\": \"12345\" }`.", + "type": "string" + }, + "Priority": { + "description": "The priority to assign the new task and override the default. When supplied, the new Task will have this priority unless it matches a Workflow Target with a Priority set. When not supplied, the new Task will have the priority of the matching Workflow Target. Value can be 0 to 2^31^ (2,147,483,647).", + "type": "integer" + }, + "TaskChannel": { + "description": "When MultiTasking is enabled, specify the TaskChannel by passing either its `unique_name` or `sid`. Default value is `default`.", + "type": "string" + }, + "Timeout": { + "description": "The amount of time in seconds the new task is allowed to live. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire with description `Task TTL Exceeded`.", + "type": "integer" + }, + "WorkflowSid": { + "description": "The SID of the Workflow that you would like to handle routing for the new Task. If there is only one Workflow defined for the Workspace that you are posting the new task to, this parameter is optional.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -4089,7 +3981,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task" } } - } + }, + "description": "Created" } }, "security": [ @@ -4195,7 +4088,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task" } } - } + }, + "description": "OK" } }, "security": [ @@ -4233,61 +4127,47 @@ "pattern": "^WT[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The JSON string that describes the custom attributes of the task.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The new status of the task. Can be: `canceled`, to cancel a Task that is currently `pending` or `reserved`; `wrapping`, to move the Task to wrapup state; or `completed`, to move a Task to the completed state.", - "in": "query", - "name": "AssignmentStatus", - "required": false, - "schema": { - "enum": [ - "pending", - "reserved", - "assigned", - "canceled", - "completed", - "wrapping" - ], - "type": "string" - } - }, - { - "description": "The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.", - "in": "query", - "name": "Reason", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).", - "in": "query", - "name": "Priority", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", - "in": "query", - "name": "TaskChannel", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AssignmentStatus": { + "description": "The new status of the task. Can be: `canceled`, to cancel a Task that is currently `pending` or `reserved`; `wrapping`, to move the Task to wrapup state; or `completed`, to move a Task to the completed state.", + "enum": [ + "pending", + "reserved", + "assigned", + "canceled", + "completed", + "wrapping" + ], + "type": "string" + }, + "Attributes": { + "description": "The JSON string that describes the custom attributes of the task.", + "type": "string" + }, + "Priority": { + "description": "The Task's new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).", + "type": "integer" + }, + "Reason": { + "description": "The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.", + "type": "string" + }, + "TaskChannel": { + "description": "When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -4296,7 +4176,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task" } } - } + }, + "description": "OK" } }, "security": [ @@ -4355,7 +4236,6 @@ "description": "Returns the list of reservations for a task with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, or `timeout`.", "in": "query", "name": "ReservationStatus", - "required": false, "schema": { "enum": [ "pending", @@ -4427,7 +4307,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -4502,7 +4383,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" } } - } + }, + "description": "OK" } }, "security": [ @@ -4552,613 +4434,844 @@ "pattern": "^WR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The new status of the reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`.", - "in": "query", - "name": "ReservationStatus", - "required": false, - "schema": { - "enum": [ - "pending", - "accepted", - "rejected", - "timeout", - "canceled", - "rescinded", - "wrapping", - "completed" - ], - "type": "string" - } - }, - { - "description": "The new worker activity SID if rejecting a reservation.", - "in": "query", - "name": "WorkerActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The assignment instruction for reservation.", - "in": "query", - "name": "Instruction", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Activity resource to start after executing a Dequeue instruction.", - "in": "query", - "name": "DequeuePostWorkActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Caller ID of the call to the worker when executing a Dequeue instruction.", - "in": "query", - "name": "DequeueFrom", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.", - "in": "query", - "name": "DequeueRecord", - "required": false, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Beep": { + "description": "Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", + "type": "string" + }, + "BeepOnCustomerEntrance": { + "description": "Whether to play a notification beep when the customer joins.", + "type": "boolean" + }, + "CallAccept": { + "description": "Whether to accept a reservation when executing a Call instruction.", + "type": "boolean" + }, + "CallFrom": { + "description": "The Caller ID of the outbound call when executing a Call instruction.", + "type": "string" + }, + "CallRecord": { + "description": "Whether to record both legs of a call when executing a Call instruction or which leg to record.", + "type": "string" + }, + "CallStatusCallbackUrl": { + "description": "The URL to call for the completed call event when executing a Call instruction.", + "format": "uri", + "type": "string" + }, + "CallTimeout": { + "description": "Timeout for call when executing a Call instruction.", + "type": "integer" + }, + "CallTo": { + "description": "The Contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "type": "string" + }, + "CallUrl": { + "description": "TwiML URI executed on answering the worker's leg as a result of the Call instruction.", + "format": "uri", + "type": "string" + }, + "ConferenceRecord": { + "description": "Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", + "type": "string" + }, + "ConferenceRecordingStatusCallback": { + "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", + "format": "uri", + "type": "string" + }, + "ConferenceRecordingStatusCallbackMethod": { + "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "ConferenceStatusCallback": { + "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", + "format": "uri", + "type": "string" + }, + "ConferenceStatusCallbackEvent": { + "description": "The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.", + "items": { + "enum": [ + "start", + "end", + "join", + "leave", + "mute", + "hold", + "speaker" + ], + "type": "string" + }, + "type": "array" + }, + "ConferenceStatusCallbackMethod": { + "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "ConferenceTrim": { + "description": "How to trim the leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", + "type": "string" + }, + "DequeueFrom": { + "description": "The Caller ID of the call to the worker when executing a Dequeue instruction.", + "type": "string" + }, + "DequeuePostWorkActivitySid": { + "description": "The SID of the Activity resource to start after executing a Dequeue instruction.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "DequeueRecord": { + "description": "Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.", + "type": "string" + }, + "DequeueStatusCallbackEvent": { + "description": "The Call progress events sent via webhooks as a result of a Dequeue instruction.", + "items": { + "type": "string" + }, + "type": "array" + }, + "DequeueStatusCallbackUrl": { + "description": "The Callback URL for completed call event when executing a Dequeue instruction.", + "format": "uri", + "type": "string" + }, + "DequeueTimeout": { + "description": "Timeout for call when executing a Dequeue instruction.", + "type": "integer" + }, + "DequeueTo": { + "description": "The Contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "type": "string" + }, + "EarlyMedia": { + "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.", + "type": "boolean" + }, + "EndConferenceOnCustomerExit": { + "description": "Whether to end the conference when the customer leaves.", + "type": "boolean" + }, + "EndConferenceOnExit": { + "description": "Whether to end the conference when the agent leaves.", + "type": "boolean" + }, + "From": { + "description": "The Caller ID of the call to the worker when executing a Conference instruction.", + "type": "string" + }, + "Instruction": { + "description": "The assignment instruction for reservation.", + "type": "string" + }, + "MaxParticipants": { + "description": "The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", + "type": "integer" + }, + "Muted": { + "description": "Whether the agent is muted in the conference. The default is `false`.", + "type": "boolean" + }, + "PostWorkActivitySid": { + "description": "The new worker activity SID after executing a Conference instruction.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "Record": { + "description": "Whether to record the participant and their conferences, including the time between conferences. The default is `false`.", + "type": "boolean" + }, + "RecordingChannels": { + "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", + "format": "uri", + "type": "string" + }, + "RecordingStatusCallbackMethod": { + "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "RedirectAccept": { + "description": "Whether the reservation should be accepted when executing a Redirect instruction.", + "type": "boolean" + }, + "RedirectCallSid": { + "description": "The Call SID of the call parked in the queue when executing a Redirect instruction.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "RedirectUrl": { + "description": "TwiML URI to redirect the call to when executing the Redirect instruction.", + "format": "uri", + "type": "string" + }, + "Region": { + "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", + "type": "string" + }, + "ReservationStatus": { + "description": "The new status of the reservation. Can be: `pending`, `accepted`, `rejected`, or `timeout`.", + "enum": [ + "pending", + "accepted", + "rejected", + "timeout", + "canceled", + "rescinded", + "wrapping", + "completed" + ], + "type": "string" + }, + "SipAuthPassword": { + "description": "The SIP password for authentication.", + "type": "string" + }, + "SipAuthUsername": { + "description": "The SIP username used for authentication.", + "type": "string" + }, + "StartConferenceOnEnter": { + "description": "Whether to start the conference when the participant joins, if it has not already started. The default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.", + "items": { + "enum": [ + "initiated", + "ringing", + "answered", + "completed" + ], + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Supervisor": { + "description": "The Supervisor SID/URI when executing the Supervise instruction.", + "type": "string" + }, + "SupervisorMode": { + "description": "The Supervisor mode when executing the Supervise instruction.", + "enum": [ + "monitor", + "whisper", + "barge" + ], + "type": "string" + }, + "Timeout": { + "description": "Timeout for call when executing a Conference instruction.", + "type": "integer" + }, + "To": { + "description": "The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "type": "string" + }, + "WaitMethod": { + "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "WaitUrl": { + "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", + "format": "uri", + "type": "string" + }, + "WorkerActivitySid": { + "description": "The new worker activity SID if rejecting a reservation.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } } - }, + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "Timeout for call when executing a Dequeue instruction.", - "in": "query", - "name": "DequeueTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://taskrouter.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "reservation_status", + "worker_name", + "worker_sid" + ], + "x-path-type": "instance" + }, + "/v1/Workspaces/{WorkspaceSid}/Workers": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ { - "description": "The Contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", - "in": "query", - "name": "DequeueTo", - "required": false, + "description": "The SID of the Workspace with the Workers to read.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The Callback URL for completed call event when executing a Dequeue instruction.", + "description": "The `activity_name` of the Worker resources to read.", "in": "query", - "name": "DequeueStatusCallbackUrl", - "required": false, + "name": "ActivityName", "schema": { - "format": "uri", "type": "string" } }, { - "description": "The Caller ID of the outbound call when executing a Call instruction.", + "description": "The `activity_sid` of the Worker resources to read.", "in": "query", - "name": "CallFrom", - "required": false, + "name": "ActivitySid", "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Whether to record both legs of a call when executing a Call instruction or which leg to record.", + "description": "Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.", "in": "query", - "name": "CallRecord", - "required": false, + "name": "Available", "schema": { "type": "string" } }, { - "description": "Timeout for call when executing a Call instruction.", - "in": "query", - "name": "CallTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The Contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "description": "The `friendly_name` of the Worker resources to read.", "in": "query", - "name": "CallTo", - "required": false, + "name": "FriendlyName", "schema": { "type": "string" } }, { - "description": "TwiML URI executed on answering the worker's leg as a result of the Call instruction.", + "description": "Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.", "in": "query", - "name": "CallUrl", - "required": false, + "name": "TargetWorkersExpression", "schema": { - "format": "uri", "type": "string" } }, { - "description": "The URL to call for the completed call event when executing a Call instruction.", + "description": "The `friendly_name` of the TaskQueue that the Workers to read are eligible for.", "in": "query", - "name": "CallStatusCallbackUrl", - "required": false, + "name": "TaskQueueName", "schema": { - "format": "uri", "type": "string" } }, { - "description": "Whether to accept a reservation when executing a Call instruction.", - "in": "query", - "name": "CallAccept", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The Call SID of the call parked in the queue when executing a Redirect instruction.", + "description": "The SID of the TaskQueue that the Workers to read are eligible for.", "in": "query", - "name": "RedirectCallSid", - "required": false, + "name": "TaskQueueSid", "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", + "pattern": "^WQ[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Whether the reservation should be accepted when executing a Redirect instruction.", - "in": "query", - "name": "RedirectAccept", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "TwiML URI to redirect the call to when executing the Redirect instruction.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "RedirectUrl", - "required": false, + "name": "PageSize", "schema": { - "format": "uri", - "type": "string" + "maximum": 1000, + "minimum": 1, + "type": "integer" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + }, + "workers": { + "items": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", - "in": "query", - "name": "To", - "required": false, - "schema": { - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ { - "description": "The Caller ID of the call to the worker when executing a Conference instruction.", - "in": "query", - "name": "From", - "required": false, + "description": "The SID of the Workspace that the new Worker belongs to.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ActivitySid": { + "description": "The SID of a valid Activity that will describe the new Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker's initial state is the `default_activity_sid` configured on the Workspace.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "Attributes": { + "description": "A valid JSON string that describes the new Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.", - "in": "query", - "name": "StatusCallbackEvent", - "required": false, - "schema": { - "items": { - "enum": [ - "initiated", - "ringing", - "answered", - "completed" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Timeout for call when executing a Conference instruction.", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to record the participant and their conferences, including the time between conferences. The default is `false`.", - "in": "query", - "name": "Record", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the agent is muted in the conference. The default is `false`.", - "in": "query", - "name": "Muted", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", - "in": "query", - "name": "Beep", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to start the conference when the participant joins, if it has not already started. The default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", - "in": "query", - "name": "StartConferenceOnEnter", - "required": false, - "schema": { - "type": "boolean" - } - }, + } + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" + } + } + }, + "description": "Created" + } + }, + "security": [ { - "description": "Whether to end the conference when the agent leaves.", - "in": "query", - "name": "EndConferenceOnExit", - "required": false, - "schema": { - "type": "boolean" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://taskrouter.twilio.com" + } + ], + "x-default-output-properties": [ + "sid", + "friendly_name", + "available" + ], + "x-path-type": "list" + }, + "/v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ { - "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", - "in": "query", - "name": "WaitUrl", - "required": false, + "description": "The SID of the Workspace with the resource to fetch.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { - "format": "uri", + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", + "description": "Only calculate statistics from this date and time and earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", - "name": "WaitMethod", - "required": false, + "name": "EndDate", "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "format": "date-time", "type": "string" } }, { - "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.", - "in": "query", - "name": "EarlyMedia", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", + "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", - "name": "MaxParticipants", - "required": false, + "name": "Minutes", "schema": { "type": "integer" } }, { - "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", + "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", - "name": "ConferenceStatusCallback", - "required": false, + "name": "StartDate", "schema": { - "format": "uri", + "format": "date-time", "type": "string" } }, { - "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "description": "Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", - "name": "ConferenceStatusCallbackMethod", - "required": false, + "name": "TaskChannel", "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_cumulative_statistics" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.", - "in": "query", - "name": "ConferenceStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "enum": [ - "start", - "end", - "join", - "leave", - "mute", - "hold", - "speaker" - ], - "type": "string" - }, - "type": "array" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://taskrouter.twilio.com" + } + ], + "x-default-output-properties": [ + "reservations_created", + "reservations_accepted", + "reservations_rejected", + "reservations_timed_out", + "reservations_canceled", + "reservations_rescinded" + ], + "x-path-type": "instance" + }, + "/v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ { - "description": "Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", - "in": "query", - "name": "ConferenceRecord", - "required": false, + "description": "The SID of the Workspace with the resource to fetch.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "How to trim the leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", + "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", - "name": "ConferenceTrim", - "required": false, + "name": "TaskChannel", "schema": { "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_real_time_statistics" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", - "in": "query", - "name": "RecordingChannels", - "required": false, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "servers": [ + { + "url": "https://taskrouter.twilio.com" + } + ], + "x-default-output-properties": [ + "total_workers" + ], + "x-path-type": "instance" + }, + "/v1/Workspaces/{WorkspaceSid}/Workers/Statistics": { + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ + { + "description": "The SID of the Workspace with the Worker to fetch.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", + "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", - "name": "RecordingStatusCallback", - "required": false, + "name": "Minutes", "schema": { - "format": "uri", - "type": "string" + "type": "integer" } }, { - "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", - "name": "RecordingStatusCallbackMethod", - "required": false, + "name": "StartDate", "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "format": "date-time", "type": "string" } }, { - "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", + "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", - "name": "ConferenceRecordingStatusCallback", - "required": false, + "name": "EndDate", "schema": { - "format": "uri", + "format": "date-time", "type": "string" } }, { - "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "description": "The SID of the TaskQueue for which to fetch Worker statistics.", "in": "query", - "name": "ConferenceRecordingStatusCallbackMethod", - "required": false, + "name": "TaskQueueSid", "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], + "maxLength": 34, + "minLength": 34, + "pattern": "^WQ[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", + "description": "The `friendly_name` of the TaskQueue for which to fetch Worker statistics.", "in": "query", - "name": "Region", - "required": false, + "name": "TaskQueueName", "schema": { "type": "string" } }, { - "description": "The SIP username used for authentication.", + "description": "Only include Workers with `friendly_name` values that match this parameter.", "in": "query", - "name": "SipAuthUsername", - "required": false, + "name": "FriendlyName", "schema": { "type": "string" } }, { - "description": "The SIP password for authentication.", + "description": "Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", - "name": "SipAuthPassword", - "required": false, + "name": "TaskChannel", "schema": { "type": "string" } - }, - { - "description": "The Call progress events sent via webhooks as a result of a Dequeue instruction.", - "in": "query", - "name": "DequeueStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The new worker activity SID after executing a Conference instruction.", - "in": "query", - "name": "PostWorkActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The Supervisor mode when executing the Supervise instruction.", - "in": "query", - "name": "SupervisorMode", - "required": false, - "schema": { - "enum": [ - "monitor", - "whisper", - "barge" - ], - "type": "string" - } - }, - { - "description": "The Supervisor SID/URI when executing the Supervise instruction.", - "in": "query", - "name": "Supervisor", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to end the conference when the customer leaves.", - "in": "query", - "name": "EndConferenceOnCustomerExit", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to play a notification beep when the customer joins.", - "in": "query", - "name": "BeepOnCustomerEntrance", - "required": false, - "schema": { - "type": "boolean" - } } ], "responses": { @@ -5166,10 +5279,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.task.task_reservation" + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -5187,20 +5301,16 @@ } ], "x-default-output-properties": [ - "sid", - "reservation_status", - "worker_name", - "worker_sid" + "cumulative" ], "x-path-type": "instance" }, - "/v1/Workspaces/{WorkspaceSid}/Workers": { - "description": "TODO: Resource-level docs", - "get": { + "/v1/Workspaces/{WorkspaceSid}/Workers/{Sid}": { + "delete": { "description": "", "parameters": [ { - "description": "The SID of the Workspace with the Workers to read.", + "description": "The SID of the Workspace with the Worker to delete.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -5212,83 +5322,59 @@ } }, { - "description": "The `activity_name` of the Worker resources to read.", - "in": "query", - "name": "ActivityName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The `activity_sid` of the Worker resources to read.", - "in": "query", - "name": "ActivitySid", - "required": false, + "description": "The SID of the Worker resource to delete.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether to return only Worker resources that are available or unavailable. Can be `true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.", - "in": "query", - "name": "Available", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The `friendly_name` of the Worker resources to read.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { + "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ { - "description": "Filter by Workers that would match an expression on a TaskQueue. This is helpful for debugging which Workers would match a potential queue.", - "in": "query", - "name": "TargetWorkersExpression", - "required": false, - "schema": { - "type": "string" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "description": "TODO: Resource-level docs", + "get": { + "description": "", + "parameters": [ { - "description": "The `friendly_name` of the TaskQueue that the Workers to read are eligible for.", - "in": "query", - "name": "TaskQueueName", - "required": false, + "description": "The SID of the Workspace with the Worker to fetch.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SID of the TaskQueue that the Workers to read are eligible for.", - "in": "query", - "name": "TaskQueueSid", - "required": false, + "description": "The SID of the Worker resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^WQ[0-9a-fA-F]{32}$", + "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } } ], "responses": { @@ -5296,48 +5382,11 @@ "content": { "application/json": { "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "workers": { - "items": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" - }, - "type": "array" - } - }, - "type": "object" + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" } } - } + }, + "description": "OK" } }, "security": [ @@ -5353,7 +5402,7 @@ "description": "", "parameters": [ { - "description": "The SID of the Workspace that the new Worker belongs to.", + "description": "The SID of the Workspace with the Worker to update.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -5365,45 +5414,58 @@ } }, { - "description": "A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", + "description": "The SID of the Worker resource to update.", + "in": "path", + "name": "Sid", "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of a valid Activity that will describe the new Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker's initial state is the `default_activity_sid` configured on the Workspace.", - "in": "query", - "name": "ActivitySid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "A valid JSON string that describes the new Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { + "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "ActivitySid": { + "description": "The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "Attributes": { + "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Worker. It can be up to 64 characters long.", + "type": "string" + }, + "RejectPendingReservations": { + "description": "Whether to reject pending reservations.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" } } - } + }, + "description": "OK" } }, "security": [ @@ -5425,15 +5487,15 @@ "friendly_name", "available" ], - "x-path-type": "list" + "x-path-type": "instance" }, - "/v1/Workspaces/{WorkspaceSid}/Workers/CumulativeStatistics": { + "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels": { "description": "TODO: Resource-level docs", "get": { "description": "", "parameters": [ { - "description": "The SID of the Workspace with the resource to fetch.", + "description": "The SID of the Workspace with the WorkerChannels to read.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -5445,42 +5507,26 @@ } }, { - "description": "Only calculate statistics from this date and time and earlier, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", - "in": "query", - "name": "EndDate", - "required": false, + "description": "The SID of the Worker with the WorkerChannels to read.", + "in": "path", + "name": "WorkerSid", + "required": true, "schema": { - "format": "date-time", + "maxLength": 34, + "minLength": 34, + "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", "in": "query", - "name": "Minutes", - "required": false, + "name": "PageSize", "schema": { + "maximum": 1000, + "minimum": 1, "type": "integer" } - }, - { - "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", - "in": "query", - "name": "StartDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", - "in": "query", - "name": "TaskChannel", - "required": false, - "schema": { - "type": "string" - } } ], "responses": { @@ -5488,10 +5534,49 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_cumulative_statistics" + "properties": { + "channels": { + "items": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" + }, + "type": "array" + }, + "meta": { + "properties": { + "first_page_url": { + "format": "uri", + "type": "string" + }, + "key": { + "type": "string" + }, + "next_page_url": { + "format": "uri", + "type": "string" + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -5509,22 +5594,19 @@ } ], "x-default-output-properties": [ - "reservations_created", - "reservations_accepted", - "reservations_rejected", - "reservations_timed_out", - "reservations_canceled", - "reservations_rescinded" + "sid", + "task_channel_sid", + "task_channel_unique_name" ], - "x-path-type": "instance" + "x-path-type": "list" }, - "/v1/Workspaces/{WorkspaceSid}/Workers/RealTimeStatistics": { + "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}": { "description": "TODO: Resource-level docs", "get": { "description": "", "parameters": [ { - "description": "The SID of the Workspace with the resource to fetch.", + "description": "The SID of the Workspace with the WorkerChannel to fetch.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -5536,10 +5618,22 @@ } }, { - "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", - "in": "query", - "name": "TaskChannel", - "required": false, + "description": "The SID of the Worker with the WorkerChannel to fetch.", + "in": "path", + "name": "WorkerSid", + "required": true, + "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WK[0-9a-fA-F]{32}$", + "type": "string" + } + }, + { + "description": "The SID of the WorkerChannel to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "type": "string" } @@ -5550,10 +5644,11 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.workers_real_time_statistics" + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -5565,23 +5660,11 @@ "GA" ] }, - "servers": [ - { - "url": "https://taskrouter.twilio.com" - } - ], - "x-default-output-properties": [ - "total_workers" - ], - "x-path-type": "instance" - }, - "/v1/Workspaces/{WorkspaceSid}/Workers/Statistics": { - "description": "TODO: Resource-level docs", - "get": { + "post": { "description": "", "parameters": [ { - "description": "The SID of the Workspace with the Worker to fetch.", + "description": "The SID of the Workspace with the WorkerChannel to update.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -5593,83 +5676,56 @@ } }, { - "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", - "in": "query", - "name": "Minutes", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", - "in": "query", - "name": "StartDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", - "in": "query", - "name": "EndDate", - "required": false, - "schema": { - "format": "date-time", - "type": "string" - } - }, - { - "description": "The SID of the TaskQueue for which to fetch Worker statistics.", - "in": "query", - "name": "TaskQueueSid", - "required": false, + "description": "The SID of the Worker with the WorkerChannel to update.", + "in": "path", + "name": "WorkerSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^WQ[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The `friendly_name` of the TaskQueue for which to fetch Worker statistics.", - "in": "query", - "name": "TaskQueueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Only include Workers with `friendly_name` values that match this parameter.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { + "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", - "in": "query", - "name": "TaskChannel", - "required": false, + "description": "The SID of the WorkerChannel to update.", + "in": "path", + "name": "Sid", + "required": true, "schema": { "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Available": { + "description": "Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.", + "type": "boolean" + }, + "Capacity": { + "description": "The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_statistics" + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" } } - } + }, + "description": "OK" } }, "security": [ @@ -5687,16 +5743,19 @@ } ], "x-default-output-properties": [ - "cumulative" + "sid", + "task_channel_sid", + "task_channel_unique_name" ], "x-path-type": "instance" }, - "/v1/Workspaces/{WorkspaceSid}/Workers/{Sid}": { - "delete": { + "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations": { + "description": "Current and past reservations for a worker", + "get": { "description": "", "parameters": [ { - "description": "The SID of the Workspace with the Worker to delete.", + "description": "The SID of the Workspace with the WorkerReservation resources to read.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -5708,9 +5767,9 @@ } }, { - "description": "The SID of the Worker resource to delete.", + "description": "The SID of the reserved Worker resource with the WorkerReservation resources to read.", "in": "path", - "name": "Sid", + "name": "WorkerSid", "required": true, "schema": { "maxLength": 34, @@ -5718,207 +5777,33 @@ "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ + }, { - "description": "The SID of the Workspace with the Worker to fetch.", - "in": "path", - "name": "WorkspaceSid", - "required": true, + "description": "Returns the list of reservations for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.", + "in": "query", + "name": "ReservationStatus", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", + "enum": [ + "pending", + "accepted", + "rejected", + "timeout", + "canceled", + "rescinded", + "wrapping", + "completed" + ], "type": "string" } }, { - "description": "The SID of the Worker resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "in": "query", + "name": "PageSize", "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the Worker to update.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Worker resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of a valid Activity that will describe the Worker's initial state. See [Activities](https://www.twilio.com/docs/taskrouter/api/activity) for more information.", - "in": "query", - "name": "ActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The JSON string that describes the Worker. For example: `{ \"email\": \"Bob@example.com\", \"phone\": \"+5095551234\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.", - "in": "query", - "name": "Attributes", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the Worker. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to reject pending reservations.", - "in": "query", - "name": "RejectPendingReservations", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://taskrouter.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "friendly_name", - "available" - ], - "x-path-type": "instance" - }, - "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the WorkerChannels to read.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Worker with the WorkerChannels to read.", - "in": "path", - "name": "WorkerSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" + "maximum": 1000, + "minimum": 1, + "type": "integer" } } ], @@ -5928,12 +5813,6 @@ "application/json": { "schema": { "properties": { - "channels": { - "items": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" - }, - "type": "array" - }, "meta": { "properties": { "first_page_url": { @@ -5963,287 +5842,19 @@ } }, "type": "object" + }, + "reservations": { + "items": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" + }, + "type": "array" } }, "type": "object" } } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://taskrouter.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "task_channel_sid", - "task_channel_unique_name" - ], - "x-path-type": "list" - }, - "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Channels/{Sid}": { - "description": "TODO: Resource-level docs", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the WorkerChannel to fetch.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Worker with the WorkerChannel to fetch.", - "in": "path", - "name": "WorkerSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the WorkerChannel to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the WorkerChannel to update.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Worker with the WorkerChannel to update.", - "in": "path", - "name": "WorkerSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the WorkerChannel to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The total number of Tasks that the Worker should handle for the TaskChannel type. TaskRouter creates reservations for Tasks of this TaskChannel type up to the specified capacity. If the capacity is 0, no new reservations will be created.", - "in": "query", - "name": "Capacity", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether the WorkerChannel is available. Set to `false` to prevent the Worker from receiving any new Tasks of this TaskChannel type.", - "in": "query", - "name": "Available", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_channel" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "servers": [ - { - "url": "https://taskrouter.twilio.com" - } - ], - "x-default-output-properties": [ - "sid", - "task_channel_sid", - "task_channel_unique_name" - ], - "x-path-type": "instance" - }, - "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations": { - "description": "Current and past reservations for a worker", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the WorkerReservation resources to read.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the reserved Worker resource with the WorkerReservation resources to read.", - "in": "path", - "name": "WorkerSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Returns the list of reservations for a worker with a specified ReservationStatus. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.", - "in": "query", - "name": "ReservationStatus", - "required": false, - "schema": { - "enum": [ - "pending", - "accepted", - "rejected", - "timeout", - "canceled", - "rescinded", - "wrapping", - "completed" - ], - "type": "string" - } - }, - { - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "in": "query", - "name": "PageSize", - "schema": { - "maximum": 1000, - "minimum": 1, - "type": "integer" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "properties": { - "meta": { - "properties": { - "first_page_url": { - "format": "uri", - "type": "string" - }, - "key": { - "type": "string" - }, - "next_page_url": { - "format": "uri", - "type": "string" - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - }, - "reservations": { - "items": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" - }, - "type": "array" - } - }, - "type": "object" - } - } - } + }, + "description": "OK" } }, "security": [ @@ -6263,696 +5874,453 @@ "x-default-output-properties": [ "sid", "reservation_status", - "date_created" - ], - "x-path-type": "list" - }, - "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}": { - "description": "Current and past reservations for a worker", - "get": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the WorkerReservation resource to fetch.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the reserved Worker resource with the WorkerReservation resource to fetch.", - "in": "path", - "name": "WorkerSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the WorkerReservation resource to fetch.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WR[0-9a-fA-F]{32}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "GA" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the Workspace with the WorkerReservation resources to update.", - "in": "path", - "name": "WorkspaceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the reserved Worker resource with the WorkerReservation resources to update.", - "in": "path", - "name": "WorkerSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WK[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the WorkerReservation resource to update.", - "in": "path", - "name": "Sid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The new status of the reservation. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.", - "in": "query", - "name": "ReservationStatus", - "required": false, - "schema": { - "enum": [ - "pending", - "accepted", - "rejected", - "timeout", - "canceled", - "rescinded", - "wrapping", - "completed" - ], - "type": "string" - } - }, - { - "description": "The new worker activity SID if rejecting a reservation.", - "in": "query", - "name": "WorkerActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The assignment instruction for the reservation.", - "in": "query", - "name": "Instruction", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the Activity resource to start after executing a Dequeue instruction.", - "in": "query", - "name": "DequeuePostWorkActivitySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The caller ID of the call to the worker when executing a Dequeue instruction.", - "in": "query", - "name": "DequeueFrom", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.", - "in": "query", - "name": "DequeueRecord", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The timeout for call when executing a Dequeue instruction.", - "in": "query", - "name": "DequeueTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", - "in": "query", - "name": "DequeueTo", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The callback URL for completed call event when executing a Dequeue instruction.", - "in": "query", - "name": "DequeueStatusCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The Caller ID of the outbound call when executing a Call instruction.", - "in": "query", - "name": "CallFrom", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to record both legs of a call when executing a Call instruction.", - "in": "query", - "name": "CallRecord", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The timeout for a call when executing a Call instruction.", - "in": "query", - "name": "CallTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", - "in": "query", - "name": "CallTo", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "TwiML URI executed on answering the worker's leg as a result of the Call instruction.", - "in": "query", - "name": "CallUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL to call for the completed call event when executing a Call instruction.", - "in": "query", - "name": "CallStatusCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether to accept a reservation when executing a Call instruction.", - "in": "query", - "name": "CallAccept", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The Call SID of the call parked in the queue when executing a Redirect instruction.", - "in": "query", - "name": "RedirectCallSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CA[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "Whether the reservation should be accepted when executing a Redirect instruction.", - "in": "query", - "name": "RedirectAccept", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "TwiML URI to redirect the call to when executing the Redirect instruction.", - "in": "query", - "name": "RedirectUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", - "in": "query", - "name": "To", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The caller ID of the call to the worker when executing a Conference instruction.", - "in": "query", - "name": "From", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.", - "in": "query", - "name": "StatusCallbackEvent", - "required": false, - "schema": { - "items": { - "enum": [ - "initiated", - "ringing", - "answered", - "completed" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The timeout for a call when executing a Conference instruction.", - "in": "query", - "name": "Timeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.", - "in": "query", - "name": "Record", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether the agent is muted in the conference. Defaults to `false`.", - "in": "query", - "name": "Muted", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", - "in": "query", - "name": "Beep", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", - "in": "query", - "name": "StartConferenceOnEnter", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to end the conference when the agent leaves.", - "in": "query", - "name": "EndConferenceOnExit", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", - "in": "query", - "name": "WaitUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", - "in": "query", - "name": "WaitMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.", - "in": "query", - "name": "EarlyMedia", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The maximum number of participants allowed in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", - "in": "query", - "name": "MaxParticipants", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", - "in": "query", - "name": "ConferenceStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "ConferenceStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.", - "in": "query", - "name": "ConferenceStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "enum": [ - "start", - "end", - "join", - "leave", - "mute", - "hold", - "speaker" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", - "in": "query", - "name": "ConferenceRecord", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", - "in": "query", - "name": "ConferenceTrim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", - "in": "query", - "name": "RecordingChannels", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", - "in": "query", - "name": "RecordingStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "RecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", - "in": "query", - "name": "ConferenceRecordingStatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", - "in": "query", - "name": "ConferenceRecordingStatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, + "date_created" + ], + "x-path-type": "list" + }, + "/v1/Workspaces/{WorkspaceSid}/Workers/{WorkerSid}/Reservations/{Sid}": { + "description": "Current and past reservations for a worker", + "get": { + "description": "", + "parameters": [ { - "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", - "in": "query", - "name": "Region", - "required": false, + "description": "The SID of the Workspace with the WorkerReservation resource to fetch.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SIP username used for authentication.", - "in": "query", - "name": "SipAuthUsername", - "required": false, + "description": "The SID of the reserved Worker resource with the WorkerReservation resource to fetch.", + "in": "path", + "name": "WorkerSid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WK[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "The SIP password for authentication.", - "in": "query", - "name": "SipAuthPassword", - "required": false, + "description": "The SID of the WorkerReservation resource to fetch.", + "in": "path", + "name": "Sid", + "required": true, "schema": { + "maxLength": 34, + "minLength": 34, + "pattern": "^WR[0-9a-fA-F]{32}$", "type": "string" } - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "The call progress events sent via webhooks as a result of a Dequeue instruction.", - "in": "query", - "name": "DequeueStatusCallbackEvent", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, + "accountSid_authToken": [] + } + ], + "tags": [ + "GA" + ] + }, + "post": { + "description": "", + "parameters": [ { - "description": "The new worker activity SID after executing a Conference instruction.", - "in": "query", - "name": "PostWorkActivitySid", - "required": false, + "description": "The SID of the Workspace with the WorkerReservation resources to update.", + "in": "path", + "name": "WorkspaceSid", + "required": true, "schema": { "maxLength": 34, "minLength": 34, - "pattern": "^WA[0-9a-fA-F]{32}$", + "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } }, { - "description": "Whether to end the conference when the customer leaves.", - "in": "query", - "name": "EndConferenceOnCustomerExit", - "required": false, + "description": "The SID of the reserved Worker resource with the WorkerReservation resources to update.", + "in": "path", + "name": "WorkerSid", + "required": true, "schema": { - "type": "boolean" + "maxLength": 34, + "minLength": 34, + "pattern": "^WK[0-9a-fA-F]{32}$", + "type": "string" } }, { - "description": "Whether to play a notification beep when the customer joins.", - "in": "query", - "name": "BeepOnCustomerEntrance", - "required": false, + "description": "The SID of the WorkerReservation resource to update.", + "in": "path", + "name": "Sid", + "required": true, "schema": { - "type": "boolean" + "maxLength": 34, + "minLength": 34, + "pattern": "^WR[0-9a-fA-F]{32}$", + "type": "string" } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Beep": { + "description": "Whether to play a notification beep when the participant joins or when to play a beep. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.", + "type": "string" + }, + "BeepOnCustomerEntrance": { + "description": "Whether to play a notification beep when the customer joins.", + "type": "boolean" + }, + "CallAccept": { + "description": "Whether to accept a reservation when executing a Call instruction.", + "type": "boolean" + }, + "CallFrom": { + "description": "The Caller ID of the outbound call when executing a Call instruction.", + "type": "string" + }, + "CallRecord": { + "description": "Whether to record both legs of a call when executing a Call instruction.", + "type": "string" + }, + "CallStatusCallbackUrl": { + "description": "The URL to call for the completed call event when executing a Call instruction.", + "format": "uri", + "type": "string" + }, + "CallTimeout": { + "description": "The timeout for a call when executing a Call instruction.", + "type": "integer" + }, + "CallTo": { + "description": "The contact URI of the worker when executing a Call instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "type": "string" + }, + "CallUrl": { + "description": "TwiML URI executed on answering the worker's leg as a result of the Call instruction.", + "format": "uri", + "type": "string" + }, + "ConferenceRecord": { + "description": "Whether to record the conference the participant is joining or when to record the conference. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.", + "type": "string" + }, + "ConferenceRecordingStatusCallback": { + "description": "The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available.", + "format": "uri", + "type": "string" + }, + "ConferenceRecordingStatusCallbackMethod": { + "description": "The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "ConferenceStatusCallback": { + "description": "The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored.", + "format": "uri", + "type": "string" + }, + "ConferenceStatusCallbackEvent": { + "description": "The conference status events that we will send to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `speaker`.", + "items": { + "enum": [ + "start", + "end", + "join", + "leave", + "mute", + "hold", + "speaker" + ], + "type": "string" + }, + "type": "array" + }, + "ConferenceStatusCallbackMethod": { + "description": "The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "ConferenceTrim": { + "description": "Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.", + "type": "string" + }, + "DequeueFrom": { + "description": "The caller ID of the call to the worker when executing a Dequeue instruction.", + "type": "string" + }, + "DequeuePostWorkActivitySid": { + "description": "The SID of the Activity resource to start after executing a Dequeue instruction.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "DequeueRecord": { + "description": "Whether to record both legs of a call when executing a Dequeue instruction or which leg to record.", + "type": "string" + }, + "DequeueStatusCallbackEvent": { + "description": "The call progress events sent via webhooks as a result of a Dequeue instruction.", + "items": { + "type": "string" + }, + "type": "array" + }, + "DequeueStatusCallbackUrl": { + "description": "The callback URL for completed call event when executing a Dequeue instruction.", + "format": "uri", + "type": "string" + }, + "DequeueTimeout": { + "description": "The timeout for call when executing a Dequeue instruction.", + "type": "integer" + }, + "DequeueTo": { + "description": "The contact URI of the worker when executing a Dequeue instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "type": "string" + }, + "EarlyMedia": { + "description": "Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. The default is `true`.", + "type": "boolean" + }, + "EndConferenceOnCustomerExit": { + "description": "Whether to end the conference when the customer leaves.", + "type": "boolean" + }, + "EndConferenceOnExit": { + "description": "Whether to end the conference when the agent leaves.", + "type": "boolean" + }, + "From": { + "description": "The caller ID of the call to the worker when executing a Conference instruction.", + "type": "string" + }, + "Instruction": { + "description": "The assignment instruction for the reservation.", + "type": "string" + }, + "MaxParticipants": { + "description": "The maximum number of participants allowed in the conference. Can be a positive integer from `2` to `250`. The default value is `250`.", + "type": "integer" + }, + "Muted": { + "description": "Whether the agent is muted in the conference. Defaults to `false`.", + "type": "boolean" + }, + "PostWorkActivitySid": { + "description": "The new worker activity SID after executing a Conference instruction.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + }, + "Record": { + "description": "Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`.", + "type": "boolean" + }, + "RecordingChannels": { + "description": "The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.", + "type": "string" + }, + "RecordingStatusCallback": { + "description": "The URL that we should call using the `recording_status_callback_method` when the recording status changes.", + "format": "uri", + "type": "string" + }, + "RecordingStatusCallbackMethod": { + "description": "The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "RedirectAccept": { + "description": "Whether the reservation should be accepted when executing a Redirect instruction.", + "type": "boolean" + }, + "RedirectCallSid": { + "description": "The Call SID of the call parked in the queue when executing a Redirect instruction.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CA[0-9a-fA-F]{32}$", + "type": "string" + }, + "RedirectUrl": { + "description": "TwiML URI to redirect the call to when executing the Redirect instruction.", + "format": "uri", + "type": "string" + }, + "Region": { + "description": "The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`.", + "type": "string" + }, + "ReservationStatus": { + "description": "The new status of the reservation. Can be: `pending`, `accepted`, `rejected`, `timeout`, `canceled`, or `rescinded`.", + "enum": [ + "pending", + "accepted", + "rejected", + "timeout", + "canceled", + "rescinded", + "wrapping", + "completed" + ], + "type": "string" + }, + "SipAuthPassword": { + "description": "The SIP password for authentication.", + "type": "string" + }, + "SipAuthUsername": { + "description": "The SIP username used for authentication.", + "type": "string" + }, + "StartConferenceOnEnter": { + "description": "Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application.", + "format": "uri", + "type": "string" + }, + "StatusCallbackEvent": { + "description": "The call progress events that we will send to `status_callback`. Can be: `initiated`, `ringing`, `answered`, or `completed`.", + "items": { + "enum": [ + "initiated", + "ringing", + "answered", + "completed" + ], + "type": "string" + }, + "type": "array" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Timeout": { + "description": "The timeout for a call when executing a Conference instruction.", + "type": "integer" + }, + "To": { + "description": "The Contact URI of the worker when executing a Conference instruction. Can be the URI of the Twilio Client, the SIP URI for Programmable SIP, or the [E.164](https://www.twilio.com/docs/glossary/what-e164) formatted phone number, depending on the destination.", + "type": "string" + }, + "WaitMethod": { + "description": "The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "WaitUrl": { + "description": "The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic).", + "format": "uri", + "type": "string" + }, + "WorkerActivitySid": { + "description": "The new worker activity SID if rejecting a reservation.", + "maxLength": 34, + "minLength": 34, + "pattern": "^WA[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -6961,7 +6329,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_reservation" } } - } + }, + "description": "OK" } }, "security": [ @@ -7018,7 +6387,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -7027,7 +6395,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -7037,7 +6404,6 @@ "description": "Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -7047,7 +6413,6 @@ "description": "Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -7061,7 +6426,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.worker.worker_instance_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -7104,7 +6470,6 @@ "description": "The `friendly_name` of the Workflow resources to read.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -7166,7 +6531,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -7192,55 +6558,45 @@ "pattern": "^WS[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.", - "in": "query", - "name": "Configuration", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.", - "in": "query", - "name": "AssignmentCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL that we should call when a call to the `assignment_callback_url` fails.", - "in": "query", - "name": "FallbackAssignmentCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.", - "in": "query", - "name": "TaskReservationTimeout", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AssignmentCallbackUrl": { + "description": "The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.", + "format": "uri", + "type": "string" + }, + "Configuration": { + "description": "A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.", + "type": "string" + }, + "FallbackAssignmentCallbackUrl": { + "description": "The URL that we should call when a call to the `assignment_callback_url` fails.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.", + "type": "string" + }, + "TaskReservationTimeout": { + "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.", + "type": "integer" + } + }, + "required": [ + "FriendlyName", + "Configuration" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -7249,7 +6605,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" } } - } + }, + "description": "Created" } }, "security": [ @@ -7353,7 +6710,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" } } - } + }, + "description": "OK" } }, "security": [ @@ -7391,64 +6749,45 @@ "pattern": "^WW[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.", - "in": "query", - "name": "AssignmentCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The URL that we should call when a call to the `assignment_callback_url` fails.", - "in": "query", - "name": "FallbackAssignmentCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.", - "in": "query", - "name": "Configuration", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.", - "in": "query", - "name": "TaskReservationTimeout", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again.", - "in": "query", - "name": "ReEvaluateTasks", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AssignmentCallbackUrl": { + "description": "The URL from your application that will process task assignment events. See [Handling Task Assignment Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks) for more details.", + "format": "uri", + "type": "string" + }, + "Configuration": { + "description": "A JSON string that contains the rules to apply to the Workflow. See [Configuring Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for more information.", + "type": "string" + }, + "FallbackAssignmentCallbackUrl": { + "description": "The URL that we should call when a call to the `assignment_callback_url` fails.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound Campaign`.", + "type": "string" + }, + "ReEvaluateTasks": { + "description": "Whether or not to re-evaluate Tasks. The default is `false`, which means Tasks in the Workflow will not be processed through the assignment loop again.", + "type": "string" + }, + "TaskReservationTimeout": { + "description": "How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker. Can be up to `86,400` (24 hours) and the default is `120`.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -7457,7 +6796,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow" } } - } + }, + "description": "OK" } }, "security": [ @@ -7514,7 +6854,6 @@ "description": "Only include usage that occurred on or before this date, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -7524,7 +6863,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -7533,7 +6871,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -7543,7 +6880,6 @@ "description": "Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -7552,7 +6888,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -7566,7 +6901,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_cumulative_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -7624,7 +6960,6 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -7638,7 +6973,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_real_time_statistics" } } - } + }, + "description": "OK" } }, "security": [ @@ -7695,7 +7031,6 @@ "description": "Only calculate statistics since this many minutes in the past. The default 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.", "in": "query", "name": "Minutes", - "required": false, "schema": { "type": "integer" } @@ -7704,7 +7039,6 @@ "description": "Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.", "in": "query", "name": "StartDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -7714,7 +7048,6 @@ "description": "Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.", "in": "query", "name": "EndDate", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -7724,7 +7057,6 @@ "description": "Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.", "in": "query", "name": "TaskChannel", - "required": false, "schema": { "type": "string" } @@ -7733,7 +7065,6 @@ "description": "A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.", "in": "query", "name": "SplitByWaitTime", - "required": false, "schema": { "type": "string" } @@ -7747,7 +7078,8 @@ "$ref": "#/components/schemas/taskrouter.v1.workspace.workflow.workflow_statistics" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_trunking.json b/src/services/twilio-api/twilio_trunking.json index 238a1410..1518094a 100644 --- a/src/services/twilio-api/twilio_trunking.json +++ b/src/services/twilio-api/twilio_trunking.json @@ -474,7 +474,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -488,91 +489,65 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.", - "in": "query", - "name": "DomainName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", - "in": "query", - "name": "DisasterRecoveryUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "DisasterRecoveryMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. The only way to change recording parameters is on a sub-resource of a Trunk after it has been created. e.g.`/Trunks/[Trunk_SID]/Recording -XPOST -d'Mode=record-from-answer'`. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information.", - "in": "query", - "name": "Recording", - "required": false, - "schema": { - "enum": [ - "do-not-record", - "record-from-ringing", - "record-from-answer" - ], - "type": "string" - } - }, - { - "description": "Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.", - "in": "query", - "name": "Secure", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.", - "in": "query", - "name": "CnamLookupEnabled", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CnamLookupEnabled": { + "description": "Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.", + "type": "boolean" + }, + "DisasterRecoveryMethod": { + "description": "The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "DisasterRecoveryUrl": { + "description": "The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", + "format": "uri", + "type": "string" + }, + "DomainName": { + "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Recording": { + "description": "The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. The only way to change recording parameters is on a sub-resource of a Trunk after it has been created. e.g.`/Trunks/[Trunk_SID]/Recording -XPOST -d'Mode=record-from-answer'`. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information.", + "enum": [ + "do-not-record", + "record-from-ringing", + "record-from-answer" + ], + "type": "string" + }, + "Secure": { + "description": "Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.", + "type": "boolean" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -581,7 +556,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk" } } - } + }, + "description": "Created" } }, "security": [ @@ -661,7 +637,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk" } } - } + }, + "description": "OK" } }, "security": [ @@ -687,91 +664,67 @@ "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.", - "in": "query", - "name": "DomainName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", - "in": "query", - "name": "DisasterRecoveryUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "DisasterRecoveryMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information.", - "in": "query", - "name": "Recording", - "required": false, - "schema": { - "enum": [ - "do-not-record", - "record-from-ringing", - "record-from-answer" - ], - "type": "string" - } - }, - { - "description": "Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.", - "in": "query", - "name": "Secure", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.", - "in": "query", - "name": "CnamLookupEnabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CnamLookupEnabled": { + "description": "Whether Caller ID Name (CNAM) lookup should be enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.", + "type": "boolean" + }, + "DisasterRecoveryMethod": { + "description": "The HTTP method we should use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "DisasterRecoveryUrl": { + "description": "The URL we should call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from the URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.", + "format": "uri", + "type": "string" + }, + "DomainName": { + "description": "The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Recording": { + "description": "The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information.", + "enum": [ + "do-not-record", + "record-from-ringing", + "record-from-answer" + ], + "type": "string" + }, + "Secure": { + "description": "Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -780,7 +733,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk" } } - } + }, + "description": "OK" } }, "security": [ @@ -878,7 +832,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -904,20 +859,29 @@ "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the [Credential List](https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource) that you want to associate with the trunk. Once associated, we will authenticate access to the trunk against this list.", - "in": "query", - "name": "CredentialListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CredentialListSid": { + "description": "The SID of the [Credential List](https://www.twilio.com/docs/voice/sip/api/sip-credentiallist-resource) that you want to associate with the trunk. Once associated, we will authenticate access to the trunk against this list.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "CredentialListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -926,7 +890,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.credential_list" } } - } + }, + "description": "Created" } }, "security": [ @@ -1030,7 +995,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.credential_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -1128,7 +1094,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1154,20 +1121,29 @@ "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the [IP Access Control List](https://www.twilio.com/docs/voice/sip/api/sip-ipaccesscontrollist-resource) that you want to associate with the trunk.", - "in": "query", - "name": "IpAccessControlListSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^AL[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "IpAccessControlListSid": { + "description": "The SID of the [IP Access Control List](https://www.twilio.com/docs/voice/sip/api/sip-ipaccesscontrollist-resource) that you want to associate with the trunk.", + "maxLength": 34, + "minLength": 34, + "pattern": "^AL[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "IpAccessControlListSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1176,7 +1152,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.ip_access_control_list" } } - } + }, + "description": "Created" } }, "security": [ @@ -1280,7 +1257,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.ip_access_control_list" } } - } + }, + "description": "OK" } }, "security": [ @@ -1378,7 +1356,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1404,54 +1383,47 @@ "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.", - "in": "query", - "name": "Weight", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.", - "in": "query", - "name": "Priority", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether the URL is enabled. The default is `true`.", - "in": "query", - "name": "Enabled", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.", - "in": "query", - "name": "SipUrl", - "required": true, - "schema": { - "format": "uri", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "Whether the URL is enabled. The default is `true`.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Priority": { + "description": "The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.", + "type": "integer" + }, + "SipUrl": { + "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema.", + "format": "uri", + "type": "string" + }, + "Weight": { + "description": "The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.", + "type": "integer" + } + }, + "required": [ + "Weight", + "Priority", + "Enabled", + "FriendlyName", + "SipUrl" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1460,7 +1432,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" } } - } + }, + "description": "Created" } }, "security": [ @@ -1566,7 +1539,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" } } - } + }, + "description": "OK" } }, "security": [ @@ -1604,54 +1578,40 @@ "pattern": "^OU[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.", - "in": "query", - "name": "Weight", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.", - "in": "query", - "name": "Priority", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether the URL is enabled. The default is `true`.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.", - "in": "query", - "name": "SipUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Enabled": { + "description": "Whether the URL is enabled. The default is `true`.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 64 characters long.", + "type": "string" + }, + "Priority": { + "description": "The relative importance of the URI. Can be an integer from 0 to 65535, inclusive, and the default is 10. The lowest number represents the most important URI.", + "type": "integer" + }, + "SipUrl": { + "description": "The SIP address you want Twilio to route your Origination calls to. This must be a `sip:` schema. `sips` is NOT supported.", + "format": "uri", + "type": "string" + }, + "Weight": { + "description": "The value that determines the relative share of the load the URI should receive compared to other URIs with the same priority. Can be an integer from 1 to 65535, inclusive, and the default is 10. URLs with higher values receive more load than those with lower ones with the same priority.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1660,7 +1620,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.origination_url" } } - } + }, + "description": "OK" } }, "security": [ @@ -1760,7 +1721,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1786,20 +1748,29 @@ "pattern": "^TR[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The SID of the [Incoming Phone Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) that you want to associate with the trunk.", - "in": "query", - "name": "PhoneNumberSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^PN[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "PhoneNumberSid": { + "description": "The SID of the [Incoming Phone Number](https://www.twilio.com/docs/phone-numbers/api/incomingphonenumber-resource) that you want to associate with the trunk.", + "maxLength": 34, + "minLength": 34, + "pattern": "^PN[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "PhoneNumberSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1808,7 +1779,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.phone_number" } } - } + }, + "description": "Created" } }, "security": [ @@ -1912,7 +1884,8 @@ "$ref": "#/components/schemas/trunking.v1.trunk.phone_number" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_verify.json b/src/services/twilio-api/twilio_verify.json index 4b2d0f8e..c1170117 100644 --- a/src/services/twilio-api/twilio_verify.json +++ b/src/services/twilio-api/twilio_verify.json @@ -394,7 +394,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -408,80 +409,52 @@ }, "post": { "description": "Create a new Verification Service.", - "parameters": [ - { - "description": "A descriptive string that you create to describe the verification service. It can be up to 64 characters long. **This value should not contain PII.**", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.", - "in": "query", - "name": "CodeLength", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to perform a lookup with each verification started and return info about the phone number.", - "in": "query", - "name": "LookupEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.", - "in": "query", - "name": "SkipSmsToLandlines", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to ask the user to press a number before delivering the verify code in a phone call.", - "in": "query", - "name": "DtmfInputRequired", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.", - "in": "query", - "name": "TtsName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to pass PSD2 transaction parameters when starting a verification.", - "in": "query", - "name": "Psd2Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don\u2019t share this code with anyone; our employees will never ask for the code`", - "in": "query", - "name": "DoNotShareWarningEnabled", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CodeLength": { + "description": "The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.", + "type": "integer" + }, + "DoNotShareWarningEnabled": { + "description": "Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don\u2019t share this code with anyone; our employees will never ask for the code`", + "type": "boolean" + }, + "DtmfInputRequired": { + "description": "Whether to ask the user to press a number before delivering the verify code in a phone call.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the verification service. It can be up to 64 characters long. **This value should not contain PII.**", + "type": "string" + }, + "LookupEnabled": { + "description": "Whether to perform a lookup with each verification started and return info about the phone number.", + "type": "boolean" + }, + "Psd2Enabled": { + "description": "Whether to pass PSD2 transaction parameters when starting a verification.", + "type": "boolean" + }, + "SkipSmsToLandlines": { + "description": "Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.", + "type": "boolean" + }, + "TtsName": { + "description": "The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -490,7 +463,8 @@ "$ref": "#/components/schemas/verify.v2.service" } } - } + }, + "description": "Created" } }, "security": [ @@ -588,7 +562,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -614,29 +589,34 @@ "pattern": "^VA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.", - "in": "query", - "name": "Country", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration.", - "in": "query", - "name": "MessagingServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Country": { + "description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.", + "type": "string" + }, + "MessagingServiceSid": { + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Country", + "MessagingServiceSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -645,7 +625,8 @@ "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" } } - } + }, + "description": "Created" } }, "security": [ @@ -746,7 +727,8 @@ "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -781,20 +763,29 @@ "schema": { "type": "string" } - }, - { - "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration.", - "in": "query", - "name": "MessagingServiceSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^MG[0-9a-fA-F]{32}$", - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "MessagingServiceSid": { + "description": "The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services/api) to be used to send SMS to the country of this configuration.", + "maxLength": 34, + "minLength": 34, + "pattern": "^MG[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "MessagingServiceSid" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -803,7 +794,8 @@ "$ref": "#/components/schemas/verify.v2.service.messaging_configuration" } } - } + }, + "description": "OK" } }, "security": [ @@ -904,7 +896,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -930,26 +923,30 @@ "pattern": "^VA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.**", - "in": "query", - "name": "UniqueName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Description of this Rate Limit", - "in": "query", - "name": "Description", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Description": { + "description": "Description of this Rate Limit", + "type": "string" + }, + "UniqueName": { + "description": "Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.**", + "type": "string" + } + }, + "required": [ + "UniqueName" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -958,7 +955,8 @@ "$ref": "#/components/schemas/verify.v2.service.rate_limit" } } - } + }, + "description": "Created" } }, "security": [ @@ -1072,7 +1070,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1110,26 +1109,31 @@ "pattern": "^RK[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Maximum number of requests permitted in during the interval.", - "in": "query", - "name": "Max", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "description": "Number of seconds that the rate limit will be enforced over.", - "in": "query", - "name": "Interval", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Interval": { + "description": "Number of seconds that the rate limit will be enforced over.", + "type": "integer" + }, + "Max": { + "description": "Maximum number of requests permitted in during the interval.", + "type": "integer" + } + }, + "required": [ + "Max", + "Interval" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1138,7 +1142,8 @@ "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" } } - } + }, + "description": "Created" } }, "security": [ @@ -1271,7 +1276,8 @@ "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" } } - } + }, + "description": "OK" } }, "security": [ @@ -1321,26 +1327,27 @@ "pattern": "^BL[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Maximum number of requests permitted in during the interval.", - "in": "query", - "name": "Max", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Number of seconds that the rate limit will be enforced over.", - "in": "query", - "name": "Interval", - "required": false, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Interval": { + "description": "Number of seconds that the rate limit will be enforced over.", + "type": "integer" + }, + "Max": { + "description": "Maximum number of requests permitted in during the interval.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1349,7 +1356,8 @@ "$ref": "#/components/schemas/verify.v2.service.rate_limit.bucket" } } - } + }, + "description": "OK" } }, "security": [ @@ -1458,7 +1466,8 @@ "$ref": "#/components/schemas/verify.v2.service.rate_limit" } } - } + }, + "description": "OK" } }, "security": [ @@ -1496,17 +1505,23 @@ "pattern": "^RK[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "Description of this Rate Limit", - "in": "query", - "name": "Description", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Description": { + "description": "Description of this Rate Limit", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1515,7 +1530,8 @@ "$ref": "#/components/schemas/verify.v2.service.rate_limit" } } - } + }, + "description": "OK" } }, "security": [ @@ -1559,56 +1575,45 @@ "pattern": "^VA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The 4-10 character string being verified.", - "in": "query", - "name": "Code", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "in": "query", - "name": "To", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified.", - "in": "query", - "name": "VerificationSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^VE[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", - "in": "query", - "name": "Amount", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", - "in": "query", - "name": "Payee", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Amount": { + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "type": "string" + }, + "Code": { + "description": "The 4-10 character string being verified.", + "type": "string" + }, + "Payee": { + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "type": "string" + }, + "To": { + "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + }, + "VerificationSid": { + "description": "A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified.", + "maxLength": 34, + "minLength": 34, + "pattern": "^VE[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "required": [ + "Code" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1617,7 +1622,8 @@ "$ref": "#/components/schemas/verify.v2.service.verification_check" } } - } + }, + "description": "Created" } }, "security": [ @@ -1660,107 +1666,67 @@ "pattern": "^VA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", - "in": "query", - "name": "To", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The verification method to use. Can be: [`email`](https://www.twilio.com/docs/verify/email), `sms` or `call`.", - "in": "query", - "name": "Channel", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The text of a custom message to use for the verification.", - "in": "query", - "name": "CustomMessage", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).", - "in": "query", - "name": "SendDigits", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The locale to use for the verification SMS or call. Can be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`", - "in": "query", - "name": "Locale", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.", - "in": "query", - "name": "CustomCode", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", - "in": "query", - "name": "Amount", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", - "in": "query", - "name": "Payee", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.", - "in": "query", - "name": "RateLimits", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "[`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. Must include 'from' and 'from_name'.", - "in": "query", - "name": "ChannelConfiguration", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.", - "in": "query", - "name": "AppHash", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Amount": { + "description": "The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "type": "string" + }, + "AppHash": { + "description": "Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.", + "type": "string" + }, + "Channel": { + "description": "The verification method to use. Can be: [`email`](https://www.twilio.com/docs/verify/email), `sms` or `call`.", + "type": "string" + }, + "ChannelConfiguration": { + "description": "[`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. Must include 'from' and 'from_name'.", + "type": "object" + }, + "CustomCode": { + "description": "A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.", + "type": "string" + }, + "CustomMessage": { + "description": "The text of a custom message to use for the verification.", + "type": "string" + }, + "Locale": { + "description": "The locale to use for the verification SMS or call. Can be: `af`, `ar`, `ca`, `cs`, `da`, `de`, `el`, `en`, `es`, `fi`, `fr`, `he`, `hi`, `hr`, `hu`, `id`, `it`, `ja`, `ko`, `ms`, `nb`, `nl`, `pl`, `pt`, `pr-BR`, `ro`, `ru`, `sv`, `th`, `tl`, `tr`, `vi`, `zh`, `zh-CN`, or `zh-HK.`", + "type": "string" + }, + "Payee": { + "description": "The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.", + "type": "string" + }, + "RateLimits": { + "description": "The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.", + "type": "object" + }, + "SendDigits": { + "description": "The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).", + "type": "string" + }, + "To": { + "description": "The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).", + "type": "string" + } + }, + "required": [ + "To", + "Channel" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1769,7 +1735,8 @@ "$ref": "#/components/schemas/verify.v2.service.verification" } } - } + }, + "description": "Created" } }, "security": [ @@ -1831,7 +1798,8 @@ "$ref": "#/components/schemas/verify.v2.service.verification" } } - } + }, + "description": "OK" } }, "security": [ @@ -1866,21 +1834,30 @@ "schema": { "type": "string" } - }, - { - "description": "The new status of the resource. Can be: `canceled` or `approved`.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "canceled", - "approved" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The new status of the resource. Can be: `canceled` or `approved`.", + "enum": [ + "canceled", + "approved" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1889,7 +1866,8 @@ "$ref": "#/components/schemas/verify.v2.service.verification" } } - } + }, + "description": "OK" } }, "security": [ @@ -1972,7 +1950,8 @@ "$ref": "#/components/schemas/verify.v2.service" } } - } + }, + "description": "OK" } }, "security": [ @@ -1998,80 +1977,51 @@ "pattern": "^VA[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the verification service. It can be up to 64 characters long. **This value should not contain PII.**", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.", - "in": "query", - "name": "CodeLength", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to perform a lookup with each verification started and return info about the phone number.", - "in": "query", - "name": "LookupEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.", - "in": "query", - "name": "SkipSmsToLandlines", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to ask the user to press a number before delivering the verify code in a phone call.", - "in": "query", - "name": "DtmfInputRequired", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.", - "in": "query", - "name": "TtsName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to pass PSD2 transaction parameters when starting a verification.", - "in": "query", - "name": "Psd2Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.**", - "in": "query", - "name": "DoNotShareWarningEnabled", - "required": false, - "schema": { - "type": "boolean" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CodeLength": { + "description": "The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.", + "type": "integer" + }, + "DoNotShareWarningEnabled": { + "description": "Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.**", + "type": "boolean" + }, + "DtmfInputRequired": { + "description": "Whether to ask the user to press a number before delivering the verify code in a phone call.", + "type": "boolean" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the verification service. It can be up to 64 characters long. **This value should not contain PII.**", + "type": "string" + }, + "LookupEnabled": { + "description": "Whether to perform a lookup with each verification started and return info about the phone number.", + "type": "boolean" + }, + "Psd2Enabled": { + "description": "Whether to pass PSD2 transaction parameters when starting a verification.", + "type": "boolean" + }, + "SkipSmsToLandlines": { + "description": "Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.", + "type": "boolean" + }, + "TtsName": { + "description": "The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -2080,7 +2030,8 @@ "$ref": "#/components/schemas/verify.v2.service" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_video.json b/src/services/twilio-api/twilio_video.json index 21465044..882440a9 100644 --- a/src/services/twilio-api/twilio_video.json +++ b/src/services/twilio-api/twilio_video.json @@ -761,7 +761,6 @@ "description": "Read only CompositionHook resources with an `enabled` value that matches this parameter.", "in": "query", "name": "Enabled", - "required": false, "schema": { "type": "boolean" } @@ -770,7 +769,6 @@ "description": "Read only CompositionHook resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -780,7 +778,6 @@ "description": "Read only CompositionHook resources created before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "in": "query", "name": "DateCreatedBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -790,7 +787,6 @@ "description": "Read only CompositionHook resources with friendly names that match this string. The match is not case sensitive and can include asterisk `*` characters as wildcard match.", "in": "query", "name": "FriendlyName", - "required": false, "schema": { "type": "string" } @@ -852,7 +848,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -866,123 +863,85 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook will never be triggered.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "An object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "VideoLayout", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", - "in": "query", - "name": "AudioSources", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", - "in": "query", - "name": "AudioSourcesExcluded", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "Resolution", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The container format of the media files used by the compositions created by the composition hook. Can be: `mp4` or `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.", - "in": "query", - "name": "Format", - "required": false, - "schema": { - "enum": [ - "mp4", - "webm" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "Trim", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AudioSources": { + "description": "An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "AudioSourcesExcluded": { + "description": "An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Enabled": { + "description": "Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook will never be triggered.", + "type": "boolean" + }, + "Format": { + "description": "The container format of the media files used by the compositions created by the composition hook. Can be: `mp4` or `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.", + "enum": [ + "mp4", + "webm" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.", + "type": "string" + }, + "Resolution": { + "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Trim": { + "description": "Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "boolean" + }, + "VideoLayout": { + "description": "An object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "object" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -991,7 +950,8 @@ "$ref": "#/components/schemas/video.v1.composition_hook" } } - } + }, + "description": "Created" } }, "security": [ @@ -1071,7 +1031,8 @@ "$ref": "#/components/schemas/video.v1.composition_hook" } } - } + }, + "description": "OK" } }, "security": [ @@ -1097,123 +1058,87 @@ "pattern": "^HK[0-9a-fA-F]{32}$", "type": "string" } - }, - { - "description": "A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook never triggers.", - "in": "query", - "name": "Enabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "A JSON object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "VideoLayout", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", - "in": "query", - "name": "AudioSources", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", - "in": "query", - "name": "AudioSourcesExcluded", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "Whether to clip the intervals where there is no active media in the compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "Trim", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The container format of the media files used by the compositions created by the composition hook. Can be: `mp4` or `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.", - "in": "query", - "name": "Format", - "required": false, - "schema": { - "enum": [ - "mp4", - "webm" - ], - "type": "string" - } - }, - { - "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "Resolution", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AudioSources": { + "description": "An array of track names from the same group room to merge into the compositions created by the composition hook. Can include zero or more track names. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` includes tracks named `student` as well as `studentTeam`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "AudioSourcesExcluded": { + "description": "An array of track names to exclude. A composition triggered by the composition hook includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which matches zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Enabled": { + "description": "Whether the composition hook is active. When `true`, the composition hook will be triggered for every completed Group Room in the account. When `false`, the composition hook never triggers.", + "type": "boolean" + }, + "Format": { + "description": "The container format of the media files used by the compositions created by the composition hook. Can be: `mp4` or `webm` and the default is `webm`. If `mp4` or `webm`, `audio_sources` must have one or more tracks and/or a `video_layout` element must contain a valid `video_sources` list, otherwise an error occurs.", + "enum": [ + "mp4", + "webm" + ], + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It can be up to 100 characters long and it must be unique within the account.", + "type": "string" + }, + "Resolution": { + "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Trim": { + "description": "Whether to clip the intervals where there is no active media in the compositions triggered by the composition hook. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "boolean" + }, + "VideoLayout": { + "description": "A JSON object that describes the video layout of the composition hook in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "object" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1222,7 +1147,8 @@ "$ref": "#/components/schemas/video.v1.composition_hook" } } - } + }, + "description": "OK" } }, "security": [ @@ -1250,7 +1176,6 @@ "description": "TODO: Resource-level docs", "get": { "description": "", - "parameters": [], "responses": { "200": { "content": { @@ -1259,7 +1184,8 @@ "$ref": "#/components/schemas/video.v1.composition_settings" } } - } + }, + "description": "OK" } }, "security": [ @@ -1273,69 +1199,51 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource and show to the user in the console", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the stored Credential resource.", - "in": "query", - "name": "AwsCredentialsSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Public Key resource to use for encryption.", - "in": "query", - "name": "EncryptionKeySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `http://.s3-.amazonaws.com/compositions`, where `compositions` is the path in which you want the compositions to be stored.", - "in": "query", - "name": "AwsS3Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.", - "in": "query", - "name": "AwsStorageEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether all compositions should be stored in an encrypted form. The default is `false`.", - "in": "query", - "name": "EncryptionEnabled", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AwsCredentialsSid": { + "description": "The SID of the stored Credential resource.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "AwsS3Url": { + "description": "The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `http://.s3-.amazonaws.com/compositions`, where `compositions` is the path in which you want the compositions to be stored.", + "format": "uri", + "type": "string" + }, + "AwsStorageEnabled": { + "description": "Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.", + "type": "boolean" + }, + "EncryptionEnabled": { + "description": "Whether all compositions should be stored in an encrypted form. The default is `false`.", + "type": "boolean" + }, + "EncryptionKeySid": { + "description": "The SID of the Public Key resource to use for encryption.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource and show to the user in the console", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1344,7 +1252,8 @@ "$ref": "#/components/schemas/video.v1.composition_settings" } } - } + }, + "description": "Created" } }, "security": [ @@ -1377,7 +1286,6 @@ "description": "Read only Composition resources with this status. Can be: `enqueued`, `processing`, `completed`, `deleted`, or `failed`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "enqueued", @@ -1393,7 +1301,6 @@ "description": "Read only Composition resources created on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1403,7 +1310,6 @@ "description": "Read only Composition resources created before this ISO 8601 date-time with time zone.", "in": "query", "name": "DateCreatedBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1413,7 +1319,6 @@ "description": "Read only Composition resources with this Room SID.", "in": "query", "name": "RoomSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -1461,148 +1366,116 @@ "type": "integer" }, "page_size": { - "type": "integer" - }, - "previous_page_url": { - "format": "uri", - "type": "string" - }, - "url": { - "format": "uri", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - } - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "tags": [ - "Preview" - ] - }, - "post": { - "description": "", - "parameters": [ - { - "description": "The SID of the Group Room with the media tracks to be used as composition sources.", - "in": "query", - "name": "RoomSid", - "required": true, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^RM[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", - "in": "query", - "name": "VideoLayout", - "required": false, - "schema": { - "type": "object" - } - }, - { - "description": "An array of track names from the same group room to merge into the new composition. Can include zero or more track names. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a track name. For example, `student*` includes `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", - "in": "query", - "name": "AudioSources", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "An array of track names to exclude. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", - "in": "query", - "name": "AudioSourcesExcluded", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "Resolution", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The container format of the composition's media files. Can be: `mp4` or `webm` and the default is `webm`. If you specify `mp4` or `webm`, you must also specify one or more `audio_sources` and/or a `video_layout` element that contains a valid `video_sources` list, otherwise an error occurs.", - "in": "query", - "name": "Format", - "required": false, - "schema": { - "enum": [ - "mp4", - "webm" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, + "type": "integer" + }, + "previous_page_url": { + "format": "uri", + "type": "string" + }, + "url": { + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "description": "Whether to clip the intervals where there is no active media in the composition. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", - "in": "query", - "name": "Trim", - "required": false, - "schema": { - "type": "boolean" - } + "accountSid_authToken": [] } ], + "tags": [ + "Preview" + ] + }, + "post": { + "description": "", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AudioSources": { + "description": "An array of track names from the same group room to merge into the new composition. Can include zero or more track names. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a track name. For example, `student*` includes `student` as well as `studentTeam`. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", + "items": { + "type": "string" + }, + "type": "array" + }, + "AudioSourcesExcluded": { + "description": "An array of track names to exclude. The new composition includes all audio sources specified in `audio_sources` except for those specified in `audio_sources_excluded`. The track names in this parameter can include an asterisk as a wild card character, which will match zero or more characters in a track name. For example, `student*` excludes `student` as well as `studentTeam`. This parameter can also be empty.", + "items": { + "type": "string" + }, + "type": "array" + }, + "Format": { + "description": "The container format of the composition's media files. Can be: `mp4` or `webm` and the default is `webm`. If you specify `mp4` or `webm`, you must also specify one or more `audio_sources` and/or a `video_layout` element that contains a valid `video_sources` list, otherwise an error occurs.", + "enum": [ + "mp4", + "webm" + ], + "type": "string" + }, + "Resolution": { + "description": "A string that describes the columns (width) and rows (height) of the generated composed video in pixels. Defaults to `640x480`. \nThe string's format is `{width}x{height}` where: \n\n* 16 <= `{width}` <= 1280\n* 16 <= `{height}` <= 1280\n* `{width}` * `{height}` <= 921,600\n\nTypical values are: \n\n* HD = `1280x720`\n* PAL = `1024x576`\n* VGA = `640x480`\n* CIF = `320x240`\n\nNote that the `resolution` imposes an aspect ratio to the resulting composition. When the original video tracks are constrained by the aspect ratio, they are scaled to fit. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "string" + }, + "RoomSid": { + "description": "The SID of the Group Room with the media tracks to be used as composition sources.", + "maxLength": 34, + "minLength": 34, + "pattern": "^RM[0-9a-fA-F]{32}$", + "type": "string" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application on every composition event. If not provided, status callback events will not be dispatched.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be: `POST` or `GET` and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Trim": { + "description": "Whether to clip the intervals where there is no active media in the composition. The default is `true`. Compositions with `trim` enabled are shorter when the Room is created and no Participant joins for a while as well as if all the Participants leave the room and join later, because those gaps will be removed. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info.", + "type": "boolean" + }, + "VideoLayout": { + "description": "An object that describes the video layout of the composition in terms of regions. See [Specifying Video Layouts](https://www.twilio.com/docs/video/api/compositions-resource#specifying-video-layouts) for more info. Please, be aware that either video_layout or audio_sources have to be provided to get a valid creation request", + "type": "object" + } + }, + "required": [ + "RoomSid" + ], + "type": "object" + } + } + } + }, "responses": { "201": { "content": { @@ -1611,7 +1484,8 @@ "$ref": "#/components/schemas/video.v1.composition" } } - } + }, + "description": "Created" } }, "security": [ @@ -1692,7 +1566,8 @@ "$ref": "#/components/schemas/video.v1.composition" } } - } + }, + "description": "OK" } }, "security": [ @@ -1721,7 +1596,6 @@ "description": "TODO: Resource-level docs", "get": { "description": "", - "parameters": [], "responses": { "200": { "content": { @@ -1730,7 +1604,8 @@ "$ref": "#/components/schemas/video.v1.recording_settings" } } - } + }, + "description": "OK" } }, "security": [ @@ -1744,69 +1619,51 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "A descriptive string that you create to describe the resource and be shown to users in the console", - "in": "query", - "name": "FriendlyName", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The SID of the stored Credential resource.", - "in": "query", - "name": "AwsCredentialsSid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The SID of the Public Key resource to use for encryption.", - "in": "query", - "name": "EncryptionKeySid", - "required": false, - "schema": { - "maxLength": 34, - "minLength": 34, - "pattern": "^CR[0-9a-fA-F]{32}$", - "type": "string" - } - }, - { - "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `http://.s3-.amazonaws.com/recordings`, where `recordings` is the path in which you want the recordings to be stored.", - "in": "query", - "name": "AwsS3Url", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Whether all recordings should be written to the `aws_s3_url`. When `false`, all recordings are stored in our cloud.", - "in": "query", - "name": "AwsStorageEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether all recordings should be stored in an encrypted form. The default is `false`.", - "in": "query", - "name": "EncryptionEnabled", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AwsCredentialsSid": { + "description": "The SID of the stored Credential resource.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "AwsS3Url": { + "description": "The URL of the AWS S3 bucket where the recordings should be stored. We only support DNS-compliant URLs like `http://.s3-.amazonaws.com/recordings`, where `recordings` is the path in which you want the recordings to be stored.", + "format": "uri", + "type": "string" + }, + "AwsStorageEnabled": { + "description": "Whether all recordings should be written to the `aws_s3_url`. When `false`, all recordings are stored in our cloud.", + "type": "boolean" + }, + "EncryptionEnabled": { + "description": "Whether all recordings should be stored in an encrypted form. The default is `false`.", + "type": "boolean" + }, + "EncryptionKeySid": { + "description": "The SID of the Public Key resource to use for encryption.", + "maxLength": 34, + "minLength": 34, + "pattern": "^CR[0-9a-fA-F]{32}$", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource and be shown to users in the console", + "type": "string" + } + }, + "required": [ + "FriendlyName" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -1815,7 +1672,8 @@ "$ref": "#/components/schemas/video.v1.recording_settings" } } - } + }, + "description": "Created" } }, "security": [ @@ -1848,7 +1706,6 @@ "description": "Read only the recordings that have this status. Can be: `processing`, `completed`, or `deleted`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "processing", @@ -1863,7 +1720,6 @@ "description": "Read only the recordings that have this `source_sid`.", "in": "query", "name": "SourceSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -1875,7 +1731,6 @@ "description": "Read only recordings with this `grouping_sid`, which may include a `participant_sid` and/or a `room_sid`.", "in": "query", "name": "GroupingSid", - "required": false, "schema": { "items": { "maxLength": 34, @@ -1890,7 +1745,6 @@ "description": "Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1900,7 +1754,6 @@ "description": "Read only recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time with time zone, given as `YYYY-MM-DDThh:mm:ss+|-hh:mm` or `YYYY-MM-DDThh:mm:ssZ`.", "in": "query", "name": "DateCreatedBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1910,7 +1763,6 @@ "description": "Read only recordings that have this media type. Can be either `audio` or `video`.", "in": "query", "name": "MediaType", - "required": false, "schema": { "enum": [ "audio", @@ -1977,7 +1829,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2060,7 +1913,8 @@ "$ref": "#/components/schemas/video.v1.recording" } } - } + }, + "description": "OK" } }, "security": [ @@ -2096,7 +1950,6 @@ "description": "Read only the rooms with this status. Can be: `in-progress` (default) or `completed`", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "in-progress", @@ -2110,7 +1963,6 @@ "description": "Read only rooms with the this `unique_name`.", "in": "query", "name": "UniqueName", - "required": false, "schema": { "type": "string" } @@ -2119,7 +1971,6 @@ "description": "Read only rooms that started on or after this date, given as `YYYY-MM-DD`.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2129,7 +1980,6 @@ "description": "Read only rooms that started before this date, given as `YYYY-MM-DD`.", "in": "query", "name": "DateCreatedBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2192,7 +2042,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2206,116 +2057,80 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "Deprecated. Whether to enable [Twilio's Network Traversal TURN service](https://www.twilio.com/stun-turn). TURN service is used when direct peer-to-peer media connections cannot be established due to firewall restrictions. This setting only applies to rooms with type `peer-to-peer`.", - "in": "query", - "name": "EnableTurn", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The type of room. Can be: `peer-to-peer`, `group-small`, or `group`. The default value is `group`.", - "in": "query", - "name": "Type", - "required": false, - "schema": { - "enum": [ - "peer-to-peer", - "group", - "group-small" - ], - "type": "string" - } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The URL we should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.", - "in": "query", - "name": "StatusCallback", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`.", - "in": "query", - "name": "StatusCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants.", - "in": "query", - "name": "MaxParticipants", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***", - "in": "query", - "name": "RecordParticipantsOnConnect", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms***", - "in": "query", - "name": "VideoCodecs", - "required": false, - "schema": { - "items": { - "enum": [ - "VP8", - "H264" - ], - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***", - "in": "query", - "name": "MediaRegion", - "required": false, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "EnableTurn": { + "description": "Deprecated. Whether to enable [Twilio's Network Traversal TURN service](https://www.twilio.com/stun-turn). TURN service is used when direct peer-to-peer media connections cannot be established due to firewall restrictions. This setting only applies to rooms with type `peer-to-peer`.", + "type": "boolean" + }, + "MaxParticipants": { + "description": "The maximum number of concurrent Participants allowed in the room. Peer-to-peer rooms can have up to 10 Participants. Small Group rooms can have up to 4 Participants. Group rooms can have up to 50 Participants.", + "type": "integer" + }, + "MediaRegion": { + "description": "The region for the media server in Group Rooms. Can be: one of the [available Media Regions](https://www.twilio.com/docs/video/ip-address-whitelisting#group-rooms-media-servers). ***This feature is not available in `peer-to-peer` rooms.***", + "type": "string" + }, + "RecordParticipantsOnConnect": { + "description": "Whether to start recording when Participants connect. ***This feature is not available in `peer-to-peer` rooms.***", + "type": "boolean" + }, + "StatusCallback": { + "description": "The URL we should call using the `status_callback_method` to send status information to your application on every room event. See [Status Callbacks](https://www.twilio.com/docs/video/api/status-callbacks) for more info.", + "format": "uri", + "type": "string" + }, + "StatusCallbackMethod": { + "description": "The HTTP method we should use to call `status_callback`. Can be `POST` or `GET`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "Type": { + "description": "The type of room. Can be: `peer-to-peer`, `group-small`, or `group`. The default value is `group`.", + "enum": [ + "peer-to-peer", + "group", + "group-small" + ], + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used as a `room_sid` in place of the resource's `sid` in the URL to address the resource. This value is unique for `in-progress` rooms. SDK clients can use this name to connect to the room. REST API clients can use this name in place of the Room SID to interact with the room as long as the room is `in-progress`.", + "type": "string" + }, + "VideoCodecs": { + "description": "An array of the video codecs that are supported when publishing a track in the room. Can be: `VP8` and `H264`. ***This feature is not available in `peer-to-peer` rooms***", + "items": { + "enum": [ + "VP8", + "H264" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -2324,7 +2139,8 @@ "$ref": "#/components/schemas/video.v1.room" } } - } + }, + "description": "Created" } }, "security": [ @@ -2366,7 +2182,6 @@ "description": "Read only the participants with this status. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "connected", @@ -2379,7 +2194,6 @@ "description": "Read only the Participants with this [User](https://www.twilio.com/docs/chat/rest/user-resource) `identity` value.", "in": "query", "name": "Identity", - "required": false, "schema": { "type": "string" } @@ -2388,7 +2202,6 @@ "description": "Read only Participants that started after this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2398,7 +2211,6 @@ "description": "Read only Participants that started before this date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#UTC) format.", "in": "query", "name": "DateCreatedBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -2461,7 +2273,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2565,7 +2378,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2631,7 +2445,8 @@ "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_published_track" } } - } + }, + "description": "OK" } }, "security": [ @@ -2688,7 +2503,8 @@ "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" } } - } + }, + "description": "OK" } }, "security": [ @@ -2720,17 +2536,23 @@ "schema": { "type": "string" } - }, - { - "description": "A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information.", - "in": "query", - "name": "Rules", - "required": false, - "schema": { - "type": "object" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Rules": { + "description": "A JSON-encoded array of subscribe rules. See the [Specifying Subscribe Rules](https://www.twilio.com/docs/video/api/track-subscriptions#specifying-sr) section for further information.", + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "202": { "content": { @@ -2739,7 +2561,8 @@ "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribe_rule" } } - } + }, + "description": "Accepted" } }, "security": [ @@ -2843,7 +2666,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -2912,7 +2736,8 @@ "$ref": "#/components/schemas/video.v1.room.room_participant.room_participant_subscribed_track" } } - } + }, + "description": "OK" } }, "security": [ @@ -2969,7 +2794,8 @@ "$ref": "#/components/schemas/video.v1.room.room_participant" } } - } + }, + "description": "OK" } }, "security": [ @@ -3001,21 +2827,27 @@ "schema": { "type": "string" } - }, - { - "description": "The new status of the resource. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "connected", - "disconnected" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The new status of the resource. Can be: `connected` or `disconnected`. For `in-progress` Rooms the default Status is `connected`, for `completed` Rooms only `disconnected` Participants are returned.", + "enum": [ + "connected", + "disconnected" + ], + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3024,7 +2856,8 @@ "$ref": "#/components/schemas/video.v1.room.room_participant" } } - } + }, + "description": "OK" } }, "security": [ @@ -3069,7 +2902,6 @@ "description": "Read only the recordings with this status. Can be: `processing`, `completed`, or `deleted`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "processing", @@ -3084,7 +2916,6 @@ "description": "Read only the recordings that have this `source_sid`.", "in": "query", "name": "SourceSid", - "required": false, "schema": { "maxLength": 34, "minLength": 34, @@ -3096,7 +2927,6 @@ "description": "Read only recordings that started on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "in": "query", "name": "DateCreatedAfter", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3106,7 +2936,6 @@ "description": "Read only Recordings that started before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) datetime with time zone.", "in": "query", "name": "DateCreatedBefore", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -3169,7 +2998,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -3276,7 +3106,8 @@ "$ref": "#/components/schemas/video.v1.room.room_recording" } } - } + }, + "description": "OK" } }, "security": [ @@ -3326,7 +3157,8 @@ "$ref": "#/components/schemas/video.v1.room" } } - } + }, + "description": "OK" } }, "security": [ @@ -3349,22 +3181,31 @@ "schema": { "type": "string" } - }, - { - "description": "The new status of the resource. Set to `completed` to end the room.", - "in": "query", - "name": "Status", - "required": true, - "schema": { - "enum": [ - "in-progress", - "completed", - "failed" - ], - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "Status": { + "description": "The new status of the resource. Set to `completed` to end the room.", + "enum": [ + "in-progress", + "completed", + "failed" + ], + "type": "string" + } + }, + "required": [ + "Status" + ], + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -3373,7 +3214,8 @@ "$ref": "#/components/schemas/video.v1.room" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/src/services/twilio-api/twilio_voice.json b/src/services/twilio-api/twilio_voice.json index c91005d5..8059b8ab 100644 --- a/src/services/twilio-api/twilio_voice.json +++ b/src/services/twilio-api/twilio_voice.json @@ -137,17 +137,24 @@ "description": "TODO: Resource-level docs", "post": { "description": "Create a bulk update request to change voice dialing country permissions of one or more countries identified by the corresponding [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", - "parameters": [ - { - "description": "URL encoded JSON array of update objects. example : `[ { \"iso_code\": \"GB\", \"low_risk_numbers_enabled\": \"true\", \"high_risk_special_numbers_enabled\":\"true\", \"high_risk_tollfraud_numbers_enabled\": \"false\" } ]`", - "in": "query", - "name": "UpdateRequest", - "required": true, - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "UpdateRequest": { + "description": "URL encoded JSON array of update objects. example : `[ { \"iso_code\": \"GB\", \"low_risk_numbers_enabled\": \"true\", \"high_risk_special_numbers_enabled\":\"true\", \"high_risk_tollfraud_numbers_enabled\": \"false\" } ]`", + "type": "string" + } + }, + "required": [ + "UpdateRequest" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -156,7 +163,8 @@ "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country_bulk_update" } } - } + }, + "description": "Created" } }, "security": [ @@ -188,7 +196,6 @@ "description": "Filter to retrieve the country permissions by specifying the [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)", "in": "query", "name": "IsoCode", - "required": false, "schema": { "type": "string" } @@ -197,7 +204,6 @@ "description": "Filter to retrieve the country permissions by specifying the continent", "in": "query", "name": "Continent", - "required": false, "schema": { "type": "string" } @@ -206,7 +212,6 @@ "description": "Filter the results by specified [country codes](https://www.itu.int/itudoc/itu-t/ob-lists/icc/e164_763.html)", "in": "query", "name": "CountryCode", - "required": false, "schema": { "type": "string" } @@ -215,7 +220,6 @@ "description": "Filter to retrieve the country permissions with dialing to low-risk numbers enabled. Can be: `true` or `false`.", "in": "query", "name": "LowRiskNumbersEnabled", - "required": false, "schema": { "type": "boolean" } @@ -224,7 +228,6 @@ "description": "Filter to retrieve the country permissions with dialing to high-risk special service numbers enabled. Can be: `true` or `false`", "in": "query", "name": "HighRiskSpecialNumbersEnabled", - "required": false, "schema": { "type": "boolean" } @@ -233,7 +236,6 @@ "description": "Filter to retrieve the country permissions with dialing to high-risk [toll fraud](https://www.twilio.com/learn/voice-and-video/toll-fraud) numbers enabled. Can be: `true` or `false`.", "in": "query", "name": "HighRiskTollfraudNumbersEnabled", - "required": false, "schema": { "type": "boolean" } @@ -295,7 +297,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -342,7 +345,8 @@ "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_country|instance" } } - } + }, + "description": "OK" } }, "security": [ @@ -437,7 +441,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -463,7 +468,6 @@ "description": "TODO: Resource-level docs", "get": { "description": "Retrieve voice dialing permissions inheritance for the sub-account", - "parameters": [], "responses": { "200": { "content": { @@ -472,7 +476,8 @@ "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings" } } - } + }, + "description": "OK" } }, "security": [ @@ -486,17 +491,21 @@ }, "post": { "description": "Update voice dialing permissions inheritance for the sub-account", - "parameters": [ - { - "description": "`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`.", - "in": "query", - "name": "DialingPermissionsInheritance", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DialingPermissionsInheritance": { + "description": "`true` for the sub-account to inherit voice dialing permissions from the Master Project; otherwise `false`.", + "type": "boolean" + } + }, + "type": "object" + } } } - ], + }, "responses": { "202": { "content": { @@ -505,7 +514,8 @@ "$ref": "#/components/schemas/voice.v1.dialing_permissions.dialing_permissions_settings" } } - } + }, + "description": "Accepted" } }, "security": [ diff --git a/src/services/twilio-api/twilio_wireless.json b/src/services/twilio-api/twilio_wireless.json index cefa5763..0cdcabc3 100644 --- a/src/services/twilio-api/twilio_wireless.json +++ b/src/services/twilio-api/twilio_wireless.json @@ -451,7 +451,6 @@ "description": "The `sid` or `unique_name` of the [Sim resources](https://www.twilio.com/docs/wireless/api/sim-resource) to read.", "in": "query", "name": "Sim", - "required": false, "schema": { "type": "string" } @@ -460,7 +459,6 @@ "description": "The status of the resources to read. Can be: `queued`, `sent`, `delivered`, `received`, or `failed`.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "queued", @@ -476,7 +474,6 @@ "description": "Only return Commands with this direction value.", "in": "query", "name": "Direction", - "required": false, "schema": { "enum": [ "from_sim", @@ -489,7 +486,6 @@ "description": "Only return Commands with this transport value. Can be: `sms` or `ip`.", "in": "query", "name": "Transport", - "required": false, "schema": { "enum": [ "sms", @@ -555,7 +551,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -569,90 +566,67 @@ }, "post": { "description": "Send a Command to a Sim.", - "parameters": [ - { - "description": "The message body of the Command. Can be plain text in text mode or a Base64 encoded byte string in binary mode.", - "in": "query", - "name": "Command", - "required": true, - "schema": { - "type": "string" - } - }, - { - "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to.", - "in": "query", - "name": "Sim", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method we use to call `callback_url`. Can be: `POST` or `GET`, and the default is `POST`.", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed.", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The mode to use when sending the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`.", - "in": "query", - "name": "CommandMode", - "required": false, - "schema": { - "enum": [ - "text", - "binary" - ], - "type": "string" - } - }, - { - "description": "Whether to include the SID of the command in the message body. Can be: `none`, `start`, or `end`, and the default behavior is `none`. When sending a Command to a SIM in text mode, we can automatically include the SID of the Command in the message body, which could be used to ensure that the device does not process the same Command more than once. A value of `start` will prepend the message with the Command SID, and `end` will append it to the end, separating the Command SID from the message body with a space. The length of the Command SID is included in the 160 character limit so the SMS body must be 128 characters or less before the Command SID is included.", - "in": "query", - "name": "IncludeSid", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. The default value is `true`.", - "in": "query", - "name": "DeliveryReceiptRequested", - "required": false, - "schema": { - "type": "boolean" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "CallbackMethod": { + "description": "The HTTP method we use to call `callback_url`. Can be: `POST` or `GET`, and the default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CallbackUrl": { + "description": "The URL we call using the `callback_url` when the Command has finished sending, whether the command was delivered or it failed.", + "format": "uri", + "type": "string" + }, + "Command": { + "description": "The message body of the Command. Can be plain text in text mode or a Base64 encoded byte string in binary mode.", + "type": "string" + }, + "CommandMode": { + "description": "The mode to use when sending the SMS message. Can be: `text` or `binary`. The default SMS mode is `text`.", + "enum": [ + "text", + "binary" + ], + "type": "string" + }, + "DeliveryReceiptRequested": { + "description": "Whether to request delivery receipt from the recipient. For Commands that request delivery receipt, the Command state transitions to 'delivered' once the server has received a delivery receipt from the device. The default value is `true`.", + "type": "boolean" + }, + "IncludeSid": { + "description": "Whether to include the SID of the command in the message body. Can be: `none`, `start`, or `end`, and the default behavior is `none`. When sending a Command to a SIM in text mode, we can automatically include the SID of the Command in the message body, which could be used to ensure that the device does not process the same Command more than once. A value of `start` will prepend the message with the Command SID, and `end` will append it to the end, separating the Command SID from the message body with a space. The length of the Command SID is included in the 160 character limit so the SMS body must be 128 characters or less before the Command SID is included.", + "type": "string" + }, + "Sim": { + "description": "The `sid` or `unique_name` of the [SIM](https://www.twilio.com/docs/wireless/api/sim-resource) to send the Command to.", + "type": "string" + } + }, + "required": [ + "Command" + ], + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -661,7 +635,8 @@ "$ref": "#/components/schemas/wireless.v1.command" } } - } + }, + "description": "Created" } }, "security": [ @@ -744,7 +719,8 @@ "$ref": "#/components/schemas/wireless.v1.command" } } - } + }, + "description": "OK" } }, "security": [ @@ -833,7 +809,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -847,110 +824,64 @@ }, "post": { "description": "", - "parameters": [ - { - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It does not have to be unique.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether SIMs can use GPRS/3G/4G/LTE data connectivity.", - "in": "query", - "name": "DataEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB and the default value is `1000`.", - "in": "query", - "name": "DataLimit", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).", - "in": "query", - "name": "DataMetering", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource).", - "in": "query", - "name": "MessagingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether SIMs can make and receive voice calls.", - "in": "query", - "name": "VoiceEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming).", - "in": "query", - "name": "NationalRoamingEnabled", - "required": false, - "schema": { - "type": "boolean" - } - }, - { - "description": "The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can be: `data`, `voice`, and `messaging`.", - "in": "query", - "name": "InternationalRoaming", - "required": false, - "schema": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - { - "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) for more info.", - "in": "query", - "name": "NationalRoamingDataLimit", - "required": false, - "schema": { - "type": "integer" - } - }, - { - "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.", - "in": "query", - "name": "InternationalRoamingDataLimit", - "required": false, - "schema": { - "type": "integer" + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "DataEnabled": { + "description": "Whether SIMs can use GPRS/3G/4G/LTE data connectivity.", + "type": "boolean" + }, + "DataLimit": { + "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on the home network (T-Mobile USA). The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB and the default value is `1000`.", + "type": "integer" + }, + "DataMetering": { + "description": "The model used to meter data usage. Can be: `payg` and `quota-1`, `quota-10`, and `quota-50`. Learn more about the available [data metering models](https://www.twilio.com/docs/wireless/api/rateplan-resource#payg-vs-quota-data-plans).", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It does not have to be unique.", + "type": "string" + }, + "InternationalRoaming": { + "description": "The list of services that SIMs capable of using GPRS/3G/4G/LTE data connectivity can use outside of the United States. Can be: `data`, `voice`, and `messaging`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "InternationalRoamingDataLimit": { + "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month when roaming outside the United States. Can be up to 2TB.", + "type": "integer" + }, + "MessagingEnabled": { + "description": "Whether SIMs can make, send, and receive SMS using [Commands](https://www.twilio.com/docs/wireless/api/command-resource).", + "type": "boolean" + }, + "NationalRoamingDataLimit": { + "description": "The total data usage (download and upload combined) in Megabytes that the Network allows during one month on non-home networks in the United States. The metering period begins the day of activation and ends on the same day in the following month. Can be up to 2TB. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming) for more info.", + "type": "integer" + }, + "NationalRoamingEnabled": { + "description": "Whether SIMs can roam on networks other than the home network (T-Mobile USA) in the United States. See [national roaming](https://www.twilio.com/docs/wireless/api/rateplan-resource#national-roaming).", + "type": "boolean" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "type": "string" + }, + "VoiceEnabled": { + "description": "Whether SIMs can make and receive voice calls.", + "type": "boolean" + } + }, + "type": "object" + } } } - ], + }, "responses": { "201": { "content": { @@ -959,7 +890,8 @@ "$ref": "#/components/schemas/wireless.v1.rate_plan" } } - } + }, + "description": "Created" } }, "security": [ @@ -1034,7 +966,8 @@ "$ref": "#/components/schemas/wireless.v1.rate_plan" } } - } + }, + "description": "OK" } }, "security": [ @@ -1057,26 +990,27 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the resource. It does not have to be unique.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "FriendlyName": { + "description": "A descriptive string that you create to describe the resource. It does not have to be unique.", + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the resource's `sid` in the URL to address the resource.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1085,7 +1019,8 @@ "$ref": "#/components/schemas/wireless.v1.rate_plan" } } - } + }, + "description": "OK" } }, "security": [ @@ -1119,7 +1054,6 @@ "description": "Only return Sim resources with this status.", "in": "query", "name": "Status", - "required": false, "schema": { "enum": [ "new", @@ -1138,7 +1072,6 @@ "description": "Only return Sim resources with this ICCID. This will return a list with a maximum size of 1.", "in": "query", "name": "Iccid", - "required": false, "schema": { "type": "string" } @@ -1147,7 +1080,6 @@ "description": "The SID or unique name of a [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource). Only return Sim resources assigned to this RatePlan resource.", "in": "query", "name": "RatePlan", - "required": false, "schema": { "type": "string" } @@ -1156,7 +1088,6 @@ "description": "Deprecated.", "in": "query", "name": "EId", - "required": false, "schema": { "type": "string" } @@ -1165,7 +1096,6 @@ "description": "Only return Sim resources with this registration code. This will return a list with a maximum size of 1.", "in": "query", "name": "SimRegistrationCode", - "required": false, "schema": { "type": "string" } @@ -1227,7 +1157,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1302,7 +1233,8 @@ "$ref": "#/components/schemas/wireless.v1.sim" } } - } + }, + "description": "OK" } }, "security": [ @@ -1325,273 +1257,194 @@ "schema": { "type": "string" } - }, - { - "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the `sid` in the URL path to address the resource.", - "in": "query", - "name": "UniqueName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.", - "in": "query", - "name": "CallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`).", - "in": "query", - "name": "CallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "A descriptive string that you create to describe the Sim resource. It does not need to be unique.", - "in": "query", - "name": "FriendlyName", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource should be assigned.", - "in": "query", - "name": "RatePlan", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": "The new status of the Sim resource. Can be: `ready`, `active`, `suspended`, or `deactivated`.", - "in": "query", - "name": "Status", - "required": false, - "schema": { - "enum": [ - "new", - "ready", - "active", - "suspended", - "deactivated", - "canceled", - "scheduled", - "updating" - ], - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.", - "in": "query", - "name": "CommandsCallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.", - "in": "query", - "name": "CommandsCallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.", - "in": "query", - "name": "SmsFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`.", - "in": "query", - "name": "SmsFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.", - "in": "query", - "name": "SmsMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/wireless/api/command-resource).", - "in": "query", - "name": "SmsUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceFallbackMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `voice_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", - "in": "query", - "name": "VoiceFallbackUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "The HTTP method we should use when we call `voice_url`. Can be: `GET` or `POST`.", - "in": "query", - "name": "VoiceMethod", - "required": false, - "schema": { - "enum": [ - "head", - "get", - "post", - "patch", - "put", - "delete", - "HEAD", - "GET", - "POST", - "PATCH", - "PUT", - "DELETE" - ], - "type": "string" - } - }, - { - "description": "The URL we should call using the `voice_method` when the SIM-connected device makes a voice call.", - "in": "query", - "name": "VoiceUrl", - "required": false, - "schema": { - "format": "uri", - "type": "string" - } - }, - { - "description": "Initiate a connectivity reset on the SIM. Set to `resetting` to initiate a connectivity reset on the SIM. No other value is valid.", - "in": "query", - "name": "ResetStatus", - "required": false, - "schema": { - "enum": [ - "resetting" - ], - "type": "string" - } - }, - { - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts).", - "in": "query", - "name": "AccountSid", - "required": false, - "schema": { - "type": "string" - } } ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "properties": { + "AccountSid": { + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) to which the Sim resource should belong. The Account SID can only be that of the requesting Account or that of a [Subaccount](https://www.twilio.com/docs/iam/api/subaccounts) of the requesting Account. Only valid when the Sim resource's status is `new`. For more information, see the [Move SIMs between Subaccounts documentation](https://www.twilio.com/docs/wireless/api/sim-resource#move-sims-between-subaccounts).", + "type": "string" + }, + "CallbackMethod": { + "description": "The HTTP method we should use to call `callback_url`. Can be: `POST` or `GET`. The default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CallbackUrl": { + "description": "The URL we should call using the `callback_url` when the SIM has finished updating. When the SIM transitions from `new` to `ready` or from any status to `deactivated`, we call this URL when the status changes to an intermediate status (`ready` or `deactivated`) and again when the status changes to its final status (`active` or `canceled`).", + "format": "uri", + "type": "string" + }, + "CommandsCallbackMethod": { + "description": "The HTTP method we should use to call `commands_callback_url`. Can be: `POST` or `GET`. The default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "CommandsCallbackUrl": { + "description": "The URL we should call using the `commands_callback_method` when the SIM sends a [Command](https://www.twilio.com/docs/wireless/api/command-resource). Your server should respond with an HTTP status code in the 200 range; any response body is ignored.", + "format": "uri", + "type": "string" + }, + "FriendlyName": { + "description": "A descriptive string that you create to describe the Sim resource. It does not need to be unique.", + "type": "string" + }, + "RatePlan": { + "description": "The SID or unique name of the [RatePlan resource](https://www.twilio.com/docs/wireless/api/rateplan-resource) to which the Sim resource should be assigned.", + "type": "string" + }, + "ResetStatus": { + "description": "Initiate a connectivity reset on the SIM. Set to `resetting` to initiate a connectivity reset on the SIM. No other value is valid.", + "enum": [ + "resetting" + ], + "type": "string" + }, + "SmsFallbackMethod": { + "description": "The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. Default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsFallbackUrl": { + "description": "The URL we should call using the `sms_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `sms_url`.", + "format": "uri", + "type": "string" + }, + "SmsMethod": { + "description": "The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. Default is `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "SmsUrl": { + "description": "The URL we should call using the `sms_method` when the SIM-connected device sends an SMS message that is not a [Command](https://www.twilio.com/docs/wireless/api/command-resource).", + "format": "uri", + "type": "string" + }, + "Status": { + "description": "The new status of the Sim resource. Can be: `ready`, `active`, `suspended`, or `deactivated`.", + "enum": [ + "new", + "ready", + "active", + "suspended", + "deactivated", + "canceled", + "scheduled", + "updating" + ], + "type": "string" + }, + "UniqueName": { + "description": "An application-defined string that uniquely identifies the resource. It can be used in place of the `sid` in the URL path to address the resource.", + "type": "string" + }, + "VoiceFallbackMethod": { + "description": "The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceFallbackUrl": { + "description": "The URL we should call using the `voice_fallback_method` when an error occurs while retrieving or executing the TwiML requested from `voice_url`.", + "format": "uri", + "type": "string" + }, + "VoiceMethod": { + "description": "The HTTP method we should use when we call `voice_url`. Can be: `GET` or `POST`.", + "enum": [ + "head", + "get", + "post", + "patch", + "put", + "delete", + "HEAD", + "GET", + "POST", + "PATCH", + "PUT", + "DELETE" + ], + "type": "string" + }, + "VoiceUrl": { + "description": "The URL we should call using the `voice_method` when the SIM-connected device makes a voice call.", + "format": "uri", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { "content": { @@ -1600,7 +1453,8 @@ "$ref": "#/components/schemas/wireless.v1.sim" } } - } + }, + "description": "OK" } }, "security": [ @@ -1643,7 +1497,6 @@ "description": "The date that the record ended, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "in": "query", "name": "End", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1653,7 +1506,6 @@ "description": "The date that the Data Session started, given as GMT in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.", "in": "query", "name": "Start", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1716,7 +1568,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1760,7 +1613,6 @@ "description": "Only include usage that occurred on or before this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is the current time.", "in": "query", "name": "End", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1770,7 +1622,6 @@ "description": "Only include usage that has occurred on or after this date, specified in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html). The default is one month before the `end` parameter value.", "in": "query", "name": "Start", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1780,7 +1631,6 @@ "description": "How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. The default is `all`. A value of `all` returns one Usage Record that describes the usage for the entire period.", "in": "query", "name": "Granularity", - "required": false, "schema": { "enum": [ "hourly", @@ -1847,7 +1697,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ @@ -1878,7 +1729,6 @@ "description": "Only include usage that has occurred on or before this date. Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "in": "query", "name": "End", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1888,7 +1738,6 @@ "description": "Only include usage that has occurred on or after this date. Format is [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html).", "in": "query", "name": "Start", - "required": false, "schema": { "format": "date-time", "type": "string" @@ -1898,7 +1747,6 @@ "description": "How to summarize the usage by time. Can be: `daily`, `hourly`, or `all`. A value of `all` returns one Usage Record that describes the usage for the entire period.", "in": "query", "name": "Granularity", - "required": false, "schema": { "enum": [ "hourly", @@ -1965,7 +1813,8 @@ "type": "object" } } - } + }, + "description": "OK" } }, "security": [ diff --git a/test/services/twilio-api/twilio-client.test.js b/test/services/twilio-api/twilio-client.test.js index e4de7351..c1363531 100644 --- a/test/services/twilio-api/twilio-client.test.js +++ b/test/services/twilio-api/twilio-client.test.js @@ -115,7 +115,7 @@ describe('services', () => { }); expect(response).to.eql({ status: 'ringing' }); - expect(httpClient.lastRequest.data).to.eql(qs.stringify({ To: '123', From: '456' })); + expect(httpClient.lastRequest.data).to.eql(qs.stringify({ From: '456', To: '123' })); }); test