From 5219104c01d842de2feafec09b98353d689c16cf Mon Sep 17 00:00:00 2001 From: Twilio Date: Tue, 7 May 2019 10:39:54 -0500 Subject: [PATCH] [Librarian] Regenerated @ 129589bdc2f0cc40d1fa63d0cdfc2fc539a703c1 --- CHANGES.md | 33 ++ src/services/twilio-api/twilio_api.json | 86 +++- src/services/twilio-api/twilio_chat.json | 486 ++++++------------ src/services/twilio-api/twilio_insights.json | 18 + src/services/twilio-api/twilio_numbers.json | 140 +++++ .../twilio-api/twilio_serverless.json | 250 ++++----- .../twilio-api/twilio_taskrouter.json | 39 +- src/services/twilio-api/twilio_wireless.json | 5 - 8 files changed, 603 insertions(+), 454 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 06264bcf1..e5565b8dc 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,39 @@ twilio-cli changelog ===================== +[2019-05-07] Version 1.1.0 +--------------------------- +**Library** +- [PR #18](https://github.com/twilio/twilio-cli/pull/18): Move plugin docs in README. Thanks to [@aroach](https://github.com/aroach)! +- [PR #17](https://github.com/twilio/twilio-cli/pull/17): Support enum flags of varying case. Thanks to [@childish-sambino](https://github.com/childish-sambino)! +- [PR #16](https://github.com/twilio/twilio-cli/pull/16): Add setup troubleshooting. Thanks to [@dprothero](https://github.com/dprothero)! +- [PR #15](https://github.com/twilio/twilio-cli/pull/15): Badge link to npm package. Thanks to [@alexdlaird](https://github.com/alexdlaird)! +- [PR #14](https://github.com/twilio/twilio-cli/pull/14): Add project region support. Thanks to [@childish-sambino](https://github.com/childish-sambino)! + +**Api** +- Make `method` optional for queue members update + +**Chat** +- Removed `webhook.*.format` update parameters in Service resource from public library visibility in v1 **(breaking change)** + +**Insights** +- Added client metrics as sdk_edge to summary. +- Added optional query param processing_state. + +**Numbers** +- Add addtional metadata fields on a Document +- Add status callback fields and parameters + +**Serverless** +- Documentation + +**Taskrouter** +- Added `channel_optimized_routing` attribute to task-channel endpoint + +**Wireless** +- Remove `imeisv` from Data Session resource. **(breaking change)** + + [2019-04-29] Version 1.0.0 ---------------------------- diff --git a/src/services/twilio-api/twilio_api.json b/src/services/twilio-api/twilio_api.json index c2c33aa51..8c13794d9 100644 --- a/src/services/twilio-api/twilio_api.json +++ b/src/services/twilio-api/twilio_api.json @@ -5837,6 +5837,9 @@ "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", @@ -5868,6 +5871,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -6165,6 +6169,9 @@ "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", @@ -6196,6 +6203,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -6493,6 +6501,9 @@ "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", @@ -6524,6 +6535,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -6821,6 +6833,9 @@ "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", @@ -6852,6 +6867,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -7149,6 +7165,9 @@ "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", @@ -7180,6 +7199,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -7477,6 +7497,9 @@ "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", @@ -7508,6 +7531,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -7805,6 +7829,9 @@ "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", @@ -7836,6 +7863,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -8133,6 +8161,9 @@ "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", @@ -8164,6 +8195,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -8461,6 +8493,9 @@ "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", @@ -8492,6 +8527,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -8879,6 +8915,9 @@ "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", @@ -8910,6 +8949,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -20822,7 +20862,7 @@ "description": "How to pass the update request data", "in": "query", "name": "Method", - "required": true, + "required": false, "schema": { "enum": [ "head", @@ -27191,6 +27231,9 @@ "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", @@ -27222,6 +27265,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -27557,6 +27601,9 @@ "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", @@ -27588,6 +27635,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -27923,6 +27971,9 @@ "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", @@ -27954,6 +28005,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -28289,6 +28341,9 @@ "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", @@ -28320,6 +28375,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -28655,6 +28711,9 @@ "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", @@ -28686,6 +28745,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -29021,6 +29081,9 @@ "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", @@ -29052,6 +29115,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -29387,6 +29451,9 @@ "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", @@ -29418,6 +29485,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -29753,6 +29821,9 @@ "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", @@ -29784,6 +29855,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -30119,6 +30191,9 @@ "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", @@ -30150,6 +30225,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -30514,6 +30590,9 @@ "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", @@ -30545,6 +30624,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", @@ -30855,6 +30935,9 @@ "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", @@ -30886,6 +30969,7 @@ "turnmegabytes", "turnmegabytes-australia", "turnmegabytes-brasil", + "turnmegabytes-germany", "turnmegabytes-india", "turnmegabytes-ireland", "turnmegabytes-japan", diff --git a/src/services/twilio-api/twilio_chat.json b/src/services/twilio-api/twilio_chat.json index 1586a8bf8..f6beb3c34 100644 --- a/src/services/twilio-api/twilio_chat.json +++ b/src/services/twilio-api/twilio_chat.json @@ -1970,7 +1970,7 @@ "description": null, "parameters": [ { - "description": "Credential type, one of \"gcm\" or \"apn\"", + "description": "The type of push-notification service the credential is for", "in": "query", "name": "Type", "required": true, @@ -1984,7 +1984,7 @@ } }, { - "description": "Friendly name for stored credential", + "description": "A string to describe the resource", "in": "query", "name": "FriendlyName", "required": false, @@ -1993,7 +1993,7 @@ } }, { - "description": "[APN only] URL encoded representation of the certificate, e.", + "description": "[APN only] The URL encoded representation of the certificate", "in": "query", "name": "Certificate", "required": false, @@ -2002,7 +2002,7 @@ } }, { - "description": "[APN only] URL encoded representation of the private key, e.", + "description": "[APN only] The URL encoded representation of the private key", "in": "query", "name": "PrivateKey", "required": false, @@ -2011,7 +2011,7 @@ } }, { - "description": "[APN only] use this credential for sending to production or sandbox APNs", + "description": "[APN only] Whether to send the credential to sandbox APNs", "in": "query", "name": "Sandbox", "required": false, @@ -2020,7 +2020,7 @@ } }, { - "description": "[GCM only] This is the \"API key\" for project from Google Developer console for your GCM Service application credential", + "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, @@ -2029,7 +2029,7 @@ } }, { - "description": null, + "description": "[FCM only] The Server key of your project from Firebase console", "in": "query", "name": "Secret", "required": false, @@ -2074,7 +2074,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -2111,7 +2111,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -2147,7 +2147,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -2159,7 +2159,7 @@ } }, { - "description": "Friendly name for stored credential", + "description": "A string to describe the resource", "in": "query", "name": "FriendlyName", "required": false, @@ -2168,7 +2168,7 @@ } }, { - "description": "[APN only] URL encoded representation of the certificate, e.", + "description": "[APN only] The URL encoded representation of the certificate", "in": "query", "name": "Certificate", "required": false, @@ -2177,7 +2177,7 @@ } }, { - "description": "[APN only] URL encoded representation of the private key, e.", + "description": "[APN only] The URL encoded representation of the private key", "in": "query", "name": "PrivateKey", "required": false, @@ -2186,7 +2186,7 @@ } }, { - "description": "[APN only] use this credential for sending to production or sandbox APNs", + "description": "[APN only] Whether to send the credential to sandbox APNs", "in": "query", "name": "Sandbox", "required": false, @@ -2195,7 +2195,7 @@ } }, { - "description": "[GCM only] This is the \"API key\" for project from Google Developer console for your GCM Service application credential", + "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, @@ -2204,7 +2204,7 @@ } }, { - "description": null, + "description": "[FCM only] The Server key of your project from Firebase console", "in": "query", "name": "Secret", "required": false, @@ -2311,7 +2311,7 @@ "description": null, "parameters": [ { - "description": "Human-readable name for this service instance", + "description": "A string to describe the resource", "in": "query", "name": "FriendlyName", "required": true, @@ -2357,7 +2357,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -2369,7 +2369,7 @@ } }, { - "description": null, + "description": "The visibility of the channel to read", "in": "query", "name": "Type", "required": false, @@ -2447,7 +2447,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -2459,7 +2459,7 @@ } }, { - "description": "A human-readable name for the Channel.", + "description": "A string to describe the new resource", "in": "query", "name": "FriendlyName", "required": false, @@ -2468,7 +2468,7 @@ } }, { - "description": "A unique, addressable name for the Channel.", + "description": "An application-defined string that uniquely identifies the resource", "in": "query", "name": "UniqueName", "required": false, @@ -2477,7 +2477,7 @@ } }, { - "description": "An optional metadata field you can use to store any data you wish.", + "description": "A valid JSON string that contains application-specific data", "in": "query", "name": "Attributes", "required": false, @@ -2486,7 +2486,7 @@ } }, { - "description": "The visibility of the channel - public or private.", + "description": "The visibility of the channel", "in": "query", "name": "Type", "required": false, @@ -2536,7 +2536,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -2548,7 +2548,7 @@ } }, { - "description": null, + "description": "The SID of the Channel the resources to read belong to", "in": "path", "name": "ChannelSid", "required": true, @@ -2560,7 +2560,7 @@ } }, { - "description": "A unique string identifier for this User in this Service.", + "description": "The `identity` value of the resources to read", "in": "query", "name": "Identity", "required": false, @@ -2634,7 +2634,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -2646,7 +2646,7 @@ } }, { - "description": null, + "description": "The SID of the Channel the new resource belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -2658,7 +2658,7 @@ } }, { - "description": "A unique string identifier for this User in this Service.", + "description": "The `identity` value that identifies the new resource's User", "in": "query", "name": "Identity", "required": true, @@ -2667,7 +2667,7 @@ } }, { - "description": "The Role assigned to this member.", + "description": "The Role assigned to the new member", "in": "query", "name": "RoleSid", "required": false, @@ -2715,7 +2715,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to delete the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -2727,7 +2727,7 @@ } }, { - "description": null, + "description": "The SID of the Channel the resource to delete belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -2739,7 +2739,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -2776,7 +2776,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to fetch the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -2788,7 +2788,7 @@ } }, { - "description": null, + "description": "The SID of the Channel the resource to fetch belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -2800,7 +2800,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -2849,7 +2849,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -2861,7 +2861,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the member belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -2873,7 +2873,7 @@ } }, { - "description": "A unique string identifier for this User in this Service.", + "description": "The `identity` value of the resources to read", "in": "query", "name": "Identity", "required": false, @@ -2947,7 +2947,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -2959,7 +2959,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the new member belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -2971,7 +2971,7 @@ } }, { - "description": "A unique string identifier for this User in this Service.", + "description": "The `identity` value that identifies the new resource's User", "in": "query", "name": "Identity", "required": true, @@ -2980,7 +2980,7 @@ } }, { - "description": "The Role assigned to this member.", + "description": "The SID of the Role to assign to the member", "in": "query", "name": "RoleSid", "required": false, @@ -3028,7 +3028,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to delete the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3040,7 +3040,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the message to delete belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3052,7 +3052,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3089,7 +3089,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to fetch the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3101,7 +3101,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the member belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3113,7 +3113,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3149,7 +3149,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -3161,7 +3161,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the member to update belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3173,7 +3173,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3185,7 +3185,7 @@ } }, { - "description": "The Role assigned to this member.", + "description": "The SID of the Role to assign to the member", "in": "query", "name": "RoleSid", "required": false, @@ -3197,7 +3197,7 @@ } }, { - "description": "An Integer representing index of the last Message this Member has read within this Channel", + "description": "The index of the last consumed Message for the Channel for the Member", "in": "query", "name": "LastConsumedMessageIndex", "required": false, @@ -3250,7 +3250,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -3262,7 +3262,7 @@ } }, { - "description": null, + "description": "The unique ID of the Channel the message to read belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3274,7 +3274,7 @@ } }, { - "description": null, + "description": "The sort order of the returned messages", "in": "query", "name": "Order", "required": false, @@ -3349,7 +3349,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -3361,7 +3361,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the new resource belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3373,7 +3373,7 @@ } }, { - "description": null, + "description": "The message to send to the channel", "in": "query", "name": "Body", "required": true, @@ -3382,7 +3382,7 @@ } }, { - "description": null, + "description": "The identity of the new message's author", "in": "query", "name": "From", "required": false, @@ -3391,7 +3391,7 @@ } }, { - "description": null, + "description": "A valid JSON string that contains application-specific data", "in": "query", "name": "Attributes", "required": false, @@ -3437,7 +3437,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to delete the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3449,7 +3449,7 @@ } }, { - "description": null, + "description": "The unique ID of the channel the message to delete belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3461,7 +3461,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3498,7 +3498,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to fetch the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3510,7 +3510,7 @@ } }, { - "description": null, + "description": "The unique ID of the Channel the message to fetch belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3522,7 +3522,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3558,7 +3558,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to update the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3570,7 +3570,7 @@ } }, { - "description": null, + "description": "he unique ID of the Channel the message belongs to", "in": "path", "name": "ChannelSid", "required": true, @@ -3582,7 +3582,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3594,7 +3594,7 @@ } }, { - "description": "The new message body string.", + "description": "The message to send to the channel", "in": "query", "name": "Body", "required": false, @@ -3603,7 +3603,7 @@ } }, { - "description": "The new attributes metadata field you can use to store any data you wish.", + "description": "A valid JSON string that contains application-specific data", "in": "query", "name": "Attributes", "required": false, @@ -3649,7 +3649,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to delete the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3661,7 +3661,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3698,7 +3698,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to fetch the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3710,7 +3710,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3746,7 +3746,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to update the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -3758,7 +3758,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -3770,7 +3770,7 @@ } }, { - "description": "A human-readable name for the Channel.", + "description": "A string to describe the resource", "in": "query", "name": "FriendlyName", "required": false, @@ -3779,7 +3779,7 @@ } }, { - "description": "A unique, addressable name for the Channel.", + "description": "An application-defined string that uniquely identifies the resource", "in": "query", "name": "UniqueName", "required": false, @@ -3788,7 +3788,7 @@ } }, { - "description": "An optional metadata field you can use to store any data you wish.", + "description": "A valid JSON string that contains application-specific data", "in": "query", "name": "Attributes", "required": false, @@ -3834,7 +3834,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -3908,7 +3908,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -3920,7 +3920,7 @@ } }, { - "description": "The human-readable name of this role.", + "description": "A string to describe the new resource", "in": "query", "name": "FriendlyName", "required": true, @@ -3929,7 +3929,7 @@ } }, { - "description": "What kind of role this is.", + "description": "The type of role", "in": "query", "name": "Type", "required": true, @@ -3942,7 +3942,7 @@ } }, { - "description": "A permission this role should have.", + "description": "A permission the role should have", "in": "query", "name": "Permission", "required": true, @@ -3990,7 +3990,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to delete the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -4002,7 +4002,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4039,7 +4039,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to fetch the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -4051,7 +4051,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4087,7 +4087,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to update the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -4099,7 +4099,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4111,7 +4111,7 @@ } }, { - "description": "A permission this role should have.", + "description": "A permission the role should have", "in": "query", "name": "Permission", "required": true, @@ -4160,7 +4160,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -4234,7 +4234,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to create the new resource under", "in": "path", "name": "ServiceSid", "required": true, @@ -4246,7 +4246,7 @@ } }, { - "description": "A unique string that identifies the user within this service - often a username or email address.", + "description": "The `identity` value that identifies the new resource's User", "in": "query", "name": "Identity", "required": true, @@ -4255,7 +4255,7 @@ } }, { - "description": "The unique id of the Role assigned to this user.", + "description": "The SID of the Role assigned to this user", "in": "query", "name": "RoleSid", "required": false, @@ -4267,7 +4267,7 @@ } }, { - "description": "An optional string used to contain any metadata or other information for the User.", + "description": "A valid JSON string that contains application-specific data", "in": "query", "name": "Attributes", "required": false, @@ -4276,7 +4276,7 @@ } }, { - "description": "An optional human readable string representing the user.", + "description": "A string to describe the new resource", "in": "query", "name": "FriendlyName", "required": false, @@ -4321,7 +4321,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to delete the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -4333,7 +4333,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4370,7 +4370,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to fetch the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -4382,7 +4382,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4418,7 +4418,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The SID of the Service to update the resource from", "in": "path", "name": "ServiceSid", "required": true, @@ -4430,7 +4430,7 @@ } }, { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4442,7 +4442,7 @@ } }, { - "description": "The unique id of the [Role][role] assigned to this user.", + "description": "The SID id of the Role assigned to this user", "in": "query", "name": "RoleSid", "required": false, @@ -4454,7 +4454,7 @@ } }, { - "description": "An optional string used to contain any metadata or other information for the User.", + "description": "A valid JSON string that contains application-specific data", "in": "query", "name": "Attributes", "required": false, @@ -4463,7 +4463,7 @@ } }, { - "description": "An optional human readable string representing the user.", + "description": "A string to describe the resource", "in": "query", "name": "FriendlyName", "required": false, @@ -4504,12 +4504,12 @@ ] }, "/v1/Services/{ServiceSid}/Users/{UserSid}/Channels": { - "description": "List of channels for a given user", + "description": "TODO: Resource-level docs", "get": { - "description": null, + "description": "List all Channels for a given User.", "parameters": [ { - "description": null, + "description": "The SID of the Service to read the resources from", "in": "path", "name": "ServiceSid", "required": true, @@ -4521,7 +4521,7 @@ } }, { - "description": null, + "description": "The SID of the User to fetch the User Channel resources from", "in": "path", "name": "UserSid", "required": true, @@ -4606,7 +4606,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4643,7 +4643,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4679,7 +4679,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique string that identifies the resource", "in": "path", "name": "Sid", "required": true, @@ -4691,7 +4691,7 @@ } }, { - "description": "Human-readable name for this service instance", + "description": "A string to describe the resource", "in": "query", "name": "FriendlyName", "required": false, @@ -4700,7 +4700,7 @@ } }, { - "description": null, + "description": "The service role assigned to users when they are added to the service", "in": "query", "name": "DefaultServiceRoleSid", "required": false, @@ -4712,7 +4712,7 @@ } }, { - "description": "Channel role assigned on channel join", + "description": "The channel role assigned to users when they are added to a channel", "in": "query", "name": "DefaultChannelRoleSid", "required": false, @@ -4724,7 +4724,7 @@ } }, { - "description": "Channel role assigned to creator of channel when joining for first time", + "description": "The channel role assigned to a channel creator when they join a new channel", "in": "query", "name": "DefaultChannelCreatorRoleSid", "required": false, @@ -4736,7 +4736,7 @@ } }, { - "description": "true if the member read status feature is enabled, false if not.", + "description": "Whether to enable the Message Consumption Horizon feature", "in": "query", "name": "ReadStatusEnabled", "required": false, @@ -4745,7 +4745,7 @@ } }, { - "description": "true if the reachability feature should be enabled.", + "description": "Whether to enable the Reachability Indicator feature for this Service instance", "in": "query", "name": "ReachabilityEnabled", "required": false, @@ -4754,7 +4754,7 @@ } }, { - "description": "ISO 8601 duration indicating the timeout after \"started typing\" event when client should assume that user is not typing anymore even if no \"ended typing\" message received", + "description": "How long in seconds to wait before assuming the user is no longer typing", "in": "query", "name": "TypingIndicatorTimeout", "required": false, @@ -4763,7 +4763,7 @@ } }, { - "description": "ISO 8601 duration indicating the interval between consumption reports sent from client endpoints.", + "description": "DEPRECATED", "in": "query", "name": "ConsumptionReportInterval", "required": false, @@ -4772,7 +4772,7 @@ } }, { - "description": null, + "description": "Whether to send a notification when a new message is added to a channel", "in": "query", "name": "Notifications.newMessage.enabled", "required": false, @@ -4781,7 +4781,7 @@ } }, { - "description": null, + "description": "The template to use to create the notification text displayed when a new message is added to a channel", "in": "query", "name": "Notifications.newMessage.template", "required": false, @@ -4790,7 +4790,7 @@ } }, { - "description": null, + "description": "Whether to send a notification when a member is added to a channel", "in": "query", "name": "Notifications.addedToChannel.enabled", "required": false, @@ -4799,7 +4799,7 @@ } }, { - "description": null, + "description": "The template to use to create the notification text displayed when a member is added to a channel", "in": "query", "name": "Notifications.addedToChannel.template", "required": false, @@ -4808,7 +4808,7 @@ } }, { - "description": null, + "description": "Whether to send a notification to a user when they are removed from a channel", "in": "query", "name": "Notifications.removedFromChannel.enabled", "required": false, @@ -4817,7 +4817,7 @@ } }, { - "description": null, + "description": "The template to use to create the notification text displayed to a user when they are removed", "in": "query", "name": "Notifications.removedFromChannel.template", "required": false, @@ -4826,7 +4826,7 @@ } }, { - "description": null, + "description": "Whether to send a notification when a user is invited to a channel", "in": "query", "name": "Notifications.invitedToChannel.enabled", "required": false, @@ -4835,7 +4835,7 @@ } }, { - "description": null, + "description": "The template to use to create the notification text displayed when a user is invited to a channel", "in": "query", "name": "Notifications.invitedToChannel.template", "required": false, @@ -4844,7 +4844,7 @@ } }, { - "description": "The webhook URL for PRE-Event webhooks.", + "description": "The webhook URL for pre-event webhooks", "in": "query", "name": "PreWebhookUrl", "required": false, @@ -4854,7 +4854,7 @@ } }, { - "description": "The webhook URL for POST-Event webhooks.", + "description": "The URL for post-event webhooks", "in": "query", "name": "PostWebhookUrl", "required": false, @@ -4864,7 +4864,7 @@ } }, { - "description": "The webhook request format to use.", + "description": "The HTTP method to use for both PRE and POST webhooks", "in": "query", "name": "WebhookMethod", "required": false, @@ -4887,7 +4887,7 @@ } }, { - "description": "The list of WebHook events that are enabled for this Service instance.", + "description": "The list of WebHook events that are enabled for this Service instance", "in": "query", "name": "WebhookFilters", "required": false, @@ -4899,7 +4899,7 @@ } }, { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_send event", "in": "query", "name": "Webhooks.onMessageSend.url", "required": false, @@ -4909,7 +4909,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_message_send.url", "in": "query", "name": "Webhooks.onMessageSend.method", "required": false, @@ -4932,16 +4932,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMessageSend.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_update event", "in": "query", "name": "Webhooks.onMessageUpdate.url", "required": false, @@ -4951,7 +4942,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_message_update.url", "in": "query", "name": "Webhooks.onMessageUpdate.method", "required": false, @@ -4974,16 +4965,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMessageUpdate.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_remove event", "in": "query", "name": "Webhooks.onMessageRemove.url", "required": false, @@ -4993,7 +4975,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_message_remove.url", "in": "query", "name": "Webhooks.onMessageRemove.method", "required": false, @@ -5016,16 +4998,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMessageRemove.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_add event", "in": "query", "name": "Webhooks.onChannelAdd.url", "required": false, @@ -5035,7 +5008,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_channel_add.url", "in": "query", "name": "Webhooks.onChannelAdd.method", "required": false, @@ -5058,16 +5031,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onChannelAdd.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_destroy event", "in": "query", "name": "Webhooks.onChannelDestroy.url", "required": false, @@ -5077,7 +5041,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_channel_destroy.url", "in": "query", "name": "Webhooks.onChannelDestroy.method", "required": false, @@ -5100,16 +5064,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onChannelDestroy.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_update event", "in": "query", "name": "Webhooks.onChannelUpdate.url", "required": false, @@ -5119,7 +5074,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_channel_update.url", "in": "query", "name": "Webhooks.onChannelUpdate.method", "required": false, @@ -5142,16 +5097,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onChannelUpdate.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_member_add event", "in": "query", "name": "Webhooks.onMemberAdd.url", "required": false, @@ -5161,7 +5107,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_member_add.url", "in": "query", "name": "Webhooks.onMemberAdd.method", "required": false, @@ -5184,16 +5130,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMemberAdd.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_member_remove event", "in": "query", "name": "Webhooks.onMemberRemove.url", "required": false, @@ -5203,7 +5140,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_member_remove.url", "in": "query", "name": "Webhooks.onMemberRemove.method", "required": false, @@ -5226,16 +5163,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMemberRemove.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_sent event", "in": "query", "name": "Webhooks.onMessageSent.url", "required": false, @@ -5245,7 +5173,7 @@ } }, { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_sent event", "in": "query", "name": "Webhooks.onMessageSent.method", "required": false, @@ -5268,16 +5196,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMessageSent.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_updated event", "in": "query", "name": "Webhooks.onMessageUpdated.url", "required": false, @@ -5287,7 +5206,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_message_updated.url", "in": "query", "name": "Webhooks.onMessageUpdated.method", "required": false, @@ -5310,16 +5229,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMessageUpdated.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_message_removed event", "in": "query", "name": "Webhooks.onMessageRemoved.url", "required": false, @@ -5329,7 +5239,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_message_removed.url", "in": "query", "name": "Webhooks.onMessageRemoved.method", "required": false, @@ -5352,16 +5262,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMessageRemoved.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_added event", "in": "query", "name": "Webhooks.onChannelAdded.url", "required": false, @@ -5371,7 +5272,7 @@ } }, { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_added event", "in": "query", "name": "Webhooks.onChannelAdded.method", "required": false, @@ -5394,16 +5295,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onChannelAdded.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_added event", "in": "query", "name": "Webhooks.onChannelDestroyed.url", "required": false, @@ -5413,7 +5305,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_channel_destroyed.url", "in": "query", "name": "Webhooks.onChannelDestroyed.method", "required": false, @@ -5436,16 +5328,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onChannelDestroyed.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "he URL of the webhook to call in response to the on_channel_updated event", "in": "query", "name": "Webhooks.onChannelUpdated.url", "required": false, @@ -5455,7 +5338,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_channel_updated.url", "in": "query", "name": "Webhooks.onChannelUpdated.method", "required": false, @@ -5478,16 +5361,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onChannelUpdated.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_channel_updated event", "in": "query", "name": "Webhooks.onMemberAdded.url", "required": false, @@ -5497,7 +5371,7 @@ } }, { - "description": null, + "description": "he HTTP method to use when calling the webhooks.on_channel_updated.url", "in": "query", "name": "Webhooks.onMemberAdded.method", "required": false, @@ -5520,16 +5394,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMemberAdded.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The URL of the webhook to call in response to the on_member_removed event", "in": "query", "name": "Webhooks.onMemberRemoved.url", "required": false, @@ -5539,7 +5404,7 @@ } }, { - "description": null, + "description": "The HTTP method to use when calling the webhooks.on_member_removed.url", "in": "query", "name": "Webhooks.onMemberRemoved.method", "required": false, @@ -5562,16 +5427,7 @@ } }, { - "description": null, - "in": "query", - "name": "Webhooks.onMemberRemoved.format", - "required": false, - "schema": { - "type": "string" - } - }, - { - "description": null, + "description": "The maximum number of Members that can be added to Channels within this Service", "in": "query", "name": "Limits.channelMembers", "required": false, @@ -5580,7 +5436,7 @@ } }, { - "description": null, + "description": "The maximum number of Channels Users can be a Member of within this Service", "in": "query", "name": "Limits.userChannels", "required": false, diff --git a/src/services/twilio-api/twilio_insights.json b/src/services/twilio-api/twilio_insights.json index ed9963240..78e8ccbce 100644 --- a/src/services/twilio-api/twilio_insights.json +++ b/src/services/twilio-api/twilio_insights.json @@ -121,6 +121,11 @@ "type": "string" } }, + "sdk_edge": { + "type": { + "type": "object" + } + }, "sip_edge": { "type": { "type": "object" @@ -195,6 +200,19 @@ "pattern": "^CA[0-9a-fA-F]{32}$", "type": "string" } + }, + { + "description": null, + "in": "query", + "name": "ProcessingState", + "required": false, + "schema": { + "enum": [ + "complete", + "partial" + ], + "type": "string" + } } ], "responses": { diff --git a/src/services/twilio-api/twilio_numbers.json b/src/services/twilio-api/twilio_numbers.json index 9ef873b72..6f907e3b3 100644 --- a/src/services/twilio-api/twilio_numbers.json +++ b/src/services/twilio-api/twilio_numbers.json @@ -432,6 +432,16 @@ "type": "string" } }, + "status_callback_method": { + "type": { + "type": "string" + } + }, + "status_callback_url": { + "type": { + "type": "string" + } + }, "type": { "type": { "type": "string" @@ -448,11 +458,102 @@ }, "numbers.v1.identity.document": { "properties": { + "academic_degree": { + "type": { + "type": "string" + } + }, + "account_sid": { + "type": { + "maxLength": 34, + "minLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "address_proof": { + "type": { + "type": "boolean" + } + }, + "birth_date": { + "type": { + "format": "date-time", + "type": "string" + } + }, + "birth_place": { + "type": { + "type": "string" + } + }, + "company_name": { + "type": { + "type": "string" + } + }, + "date_created": { + "type": { + "format": "date-time", + "type": "string" + } + }, + "date_updated": { + "type": { + "format": "date-time", + "type": "string" + } + }, + "expiration_date": { + "type": { + "format": "date-time", + "type": "string" + } + }, + "first_name": { + "type": { + "type": "string" + } + }, "friendly_name": { "type": { "type": "string" } }, + "identity_sid": { + "type": { + "maxLength": 34, + "minLength": 34, + "pattern": "^RI[0-9a-fA-F]{32}$", + "type": "string" + } + }, + "issue_date": { + "type": { + "format": "date-time", + "type": "string" + } + }, + "last_name": { + "type": { + "type": "string" + } + }, + "nationality": { + "type": { + "type": "string" + } + }, + "number": { + "type": { + "type": "string" + } + }, + "profession": { + "type": { + "type": "string" + } + }, "sid": { "type": { "maxLength": 34, @@ -460,6 +561,27 @@ "pattern": "^RI[0-9a-fA-F]{32}$", "type": "string" } + }, + "title": { + "type": { + "type": "string" + } + }, + "type": { + "type": { + "type": "string" + } + }, + "url": { + "type": { + "format": "uri", + "type": "string" + } + }, + "vat": { + "type": { + "type": "string" + } } }, "type": "object" @@ -1741,6 +1863,24 @@ "schema": { "type": "string" } + }, + { + "description": null, + "in": "query", + "name": "StatusCallbackUrl", + "required": false, + "schema": { + "type": "string" + } + }, + { + "description": null, + "in": "query", + "name": "StatusCallbackMethod", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { diff --git a/src/services/twilio-api/twilio_serverless.json b/src/services/twilio-api/twilio_serverless.json index 3c9d2b990..5b52e8f77 100644 --- a/src/services/twilio-api/twilio_serverless.json +++ b/src/services/twilio-api/twilio_serverless.json @@ -646,9 +646,9 @@ "openapi": "3.0.1", "paths": { "/v1/Services": { - "description": "Containers for serverless apps", + "description": "Container for Serverless application Environments.", "get": { - "description": null, + "description": "Retrieve a list of all Services.", "parameters": [], "responses": { "200": { @@ -709,10 +709,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Service.", "parameters": [ { - "description": null, + "description": "A unique, addressable name of this Service.", "in": "query", "name": "UniqueName", "required": true, @@ -721,7 +721,7 @@ } }, { - "description": null, + "description": "A human-readable description of this Service.", "in": "query", "name": "FriendlyName", "required": true, @@ -730,7 +730,7 @@ } }, { - "description": null, + "description": "Whether to inject Account credentials into a Function invocation context.", "in": "query", "name": "IncludeCredentials", "required": false, @@ -771,12 +771,12 @@ ] }, "/v1/Services/{ServiceSid}/Assets": { - "description": "Static assets", + "description": "A wrapper that represents a static file.", "get": { - "description": null, + "description": "Retrieve a list of all Assets.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -847,10 +847,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Asset.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -862,7 +862,7 @@ } }, { - "description": null, + "description": "A human-readable description of this Asset.", "in": "query", "name": "FriendlyName", "required": true, @@ -903,12 +903,12 @@ ] }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions": { - "description": "Static asset versions", + "description": "The content of an Asset.", "get": { - "description": null, + "description": "Retrieve a list of all Asset Versions.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -920,7 +920,7 @@ } }, { - "description": null, + "description": "Asset Sid.", "in": "path", "name": "AssetSid", "required": true, @@ -991,10 +991,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Asset Version.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1006,7 +1006,7 @@ } }, { - "description": null, + "description": "Asset Sid.", "in": "path", "name": "AssetSid", "required": true, @@ -1018,7 +1018,7 @@ } }, { - "description": null, + "description": "The URL-friendly string by which this Asset Version can be referenced.", "in": "query", "name": "Path", "required": true, @@ -1027,7 +1027,7 @@ } }, { - "description": null, + "description": "The access control which determines how the Asset Version can be accessed.", "in": "query", "name": "Visibility", "required": true, @@ -1074,12 +1074,12 @@ ] }, "/v1/Services/{ServiceSid}/Assets/{AssetSid}/Versions/{Sid}": { - "description": "Static asset versions", + "description": "The content of an Asset.", "get": { - "description": null, + "description": "Retrieve a specific Asset Version.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1091,7 +1091,7 @@ } }, { - "description": null, + "description": "Asset Sid.", "in": "path", "name": "AssetSid", "required": true, @@ -1103,7 +1103,7 @@ } }, { - "description": null, + "description": "Asset Version Sid.", "in": "path", "name": "Sid", "required": true, @@ -1148,12 +1148,12 @@ ] }, "/v1/Services/{ServiceSid}/Assets/{Sid}": { - "description": "Static assets", + "description": "A wrapper that represents a static file.", "get": { - "description": null, + "description": "Retrieve a specific Asset.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1165,7 +1165,7 @@ } }, { - "description": null, + "description": "Asset Sid.", "in": "path", "name": "Sid", "required": true, @@ -1198,10 +1198,10 @@ ] }, "post": { - "description": null, + "description": "Update a specific Asset.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1213,7 +1213,7 @@ } }, { - "description": null, + "description": "Asset Sid.", "in": "path", "name": "Sid", "required": true, @@ -1225,7 +1225,7 @@ } }, { - "description": null, + "description": "A human-readable description of this Asset.", "in": "query", "name": "FriendlyName", "required": true, @@ -1266,12 +1266,12 @@ ] }, "/v1/Services/{ServiceSid}/Builds": { - "description": "Builds of functions and assets", + "description": "A collection of Function Versions, Asset Versions, and Dependencies that form a deployable unit.", "get": { - "description": null, + "description": "Retrieve a list of all Builds.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1342,10 +1342,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Build. At least one Function Version or Asset Version is required.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1357,7 +1357,7 @@ } }, { - "description": null, + "description": "List of Asset Version Sids.", "in": "query", "name": "AssetVersions", "required": false, @@ -1372,7 +1372,7 @@ } }, { - "description": null, + "description": "List of Function Version Sids.", "in": "query", "name": "FunctionVersions", "required": false, @@ -1387,7 +1387,7 @@ } }, { - "description": null, + "description": "List of Dependencies.", "in": "query", "name": "Dependencies", "required": false, @@ -1428,12 +1428,12 @@ ] }, "/v1/Services/{ServiceSid}/Builds/{Sid}": { - "description": "Builds of functions and assets", + "description": "A collection of Function Versions, Asset Versions, and Dependencies that form a deployable unit.", "get": { - "description": null, + "description": "Retrieve a specific Build.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1445,7 +1445,7 @@ } }, { - "description": null, + "description": "Build Sid.", "in": "path", "name": "Sid", "required": true, @@ -1489,12 +1489,12 @@ ] }, "/v1/Services/{ServiceSid}/Environments": { - "description": "Isolated environments for deploying functions and assets", + "description": "Represents a deployed Build of a given set of Functions and/or Assets at a specific URL.", "get": { - "description": null, + "description": "Retrieve a list of all Environments.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1565,10 +1565,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Environment.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1580,7 +1580,7 @@ } }, { - "description": null, + "description": "A unique, addressable name of this Environment.", "in": "query", "name": "UniqueName", "required": true, @@ -1589,7 +1589,7 @@ } }, { - "description": null, + "description": "A URL-friendly name that represents this Environment.", "in": "query", "name": "DomainSuffix", "required": false, @@ -1631,12 +1631,12 @@ ] }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments": { - "description": "Deployments of builds to environments", + "description": "An association of a Build with an Environment.", "get": { - "description": null, + "description": "Retrieve a list of all Deployments.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1648,7 +1648,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -1719,10 +1719,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Deployment.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1734,7 +1734,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -1746,7 +1746,7 @@ } }, { - "description": null, + "description": "Build Sid.", "in": "query", "name": "BuildSid", "required": true, @@ -1790,12 +1790,12 @@ ] }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Deployments/{Sid}": { - "description": "Deployments of builds to environments", + "description": "An association of a Build with an Environment.", "get": { - "description": null, + "description": "Retrieve a specific Deployment.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1807,7 +1807,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -1819,7 +1819,7 @@ } }, { - "description": null, + "description": "Deployment Sid.", "in": "path", "name": "Sid", "required": true, @@ -1863,12 +1863,12 @@ ] }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables": { - "description": "Environment variable values", + "description": "A key and value pair that is specific to an Environment.", "get": { - "description": null, + "description": "Retrieve a list of all Variables.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1880,7 +1880,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -1951,10 +1951,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Variable.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -1966,7 +1966,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -1978,7 +1978,7 @@ } }, { - "description": null, + "description": "A string by which this Variable can be referenced.", "in": "query", "name": "Key", "required": true, @@ -1987,7 +1987,7 @@ } }, { - "description": null, + "description": "A string that contains the actual value of this Variable.", "in": "query", "name": "Value", "required": true, @@ -2028,12 +2028,12 @@ ] }, "/v1/Services/{ServiceSid}/Environments/{EnvironmentSid}/Variables/{Sid}": { - "description": "Environment variable values", + "description": "A key and value pair that is specific to an Environment.", "get": { - "description": null, + "description": "Retrieve a specific Variable.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2045,7 +2045,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -2057,7 +2057,7 @@ } }, { - "description": null, + "description": "Variable Sid.", "in": "path", "name": "Sid", "required": true, @@ -2090,10 +2090,10 @@ ] }, "post": { - "description": null, + "description": "Update a specific Variable.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2105,7 +2105,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "EnvironmentSid", "required": true, @@ -2117,7 +2117,7 @@ } }, { - "description": null, + "description": "Variable Sid.", "in": "path", "name": "Sid", "required": true, @@ -2129,7 +2129,7 @@ } }, { - "description": null, + "description": "A string by which this Variable can be referenced.", "in": "query", "name": "Key", "required": false, @@ -2138,7 +2138,7 @@ } }, { - "description": null, + "description": "A string that contains the actual value of this Variable.", "in": "query", "name": "Value", "required": false, @@ -2179,12 +2179,12 @@ ] }, "/v1/Services/{ServiceSid}/Environments/{Sid}": { - "description": "Isolated environments for deploying functions and assets", + "description": "Represents a deployed Build of a given set of Functions and/or Assets at a specific URL.", "get": { - "description": null, + "description": "Retrieve a specific Environment.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2196,7 +2196,7 @@ } }, { - "description": null, + "description": "Environment Sid.", "in": "path", "name": "Sid", "required": true, @@ -2241,12 +2241,12 @@ ] }, "/v1/Services/{ServiceSid}/Functions": { - "description": "Twilio functions", + "description": "A wrapper that represents a Serverless JavaScript function.", "get": { - "description": null, + "description": "Retrieve a list of all Functions.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2317,10 +2317,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Function.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2332,7 +2332,7 @@ } }, { - "description": null, + "description": "A human-readable description of this Function.", "in": "query", "name": "FriendlyName", "required": true, @@ -2373,12 +2373,12 @@ ] }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions": { - "description": "Twilio function versions", + "description": "The content of a Function.", "get": { - "description": null, + "description": "Retrieve a list of all Function Versions.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2390,7 +2390,7 @@ } }, { - "description": null, + "description": "Function Sid.", "in": "path", "name": "FunctionSid", "required": true, @@ -2461,10 +2461,10 @@ ] }, "post": { - "description": null, + "description": "Create a new Function Version.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2476,7 +2476,7 @@ } }, { - "description": null, + "description": "Function Sid.", "in": "path", "name": "FunctionSid", "required": true, @@ -2488,7 +2488,7 @@ } }, { - "description": null, + "description": "The URL-friendly string by which this Function Version can be referenced.", "in": "query", "name": "Path", "required": true, @@ -2497,7 +2497,7 @@ } }, { - "description": null, + "description": "The access control which determines how the Function Version can be accessed.", "in": "query", "name": "Visibility", "required": true, @@ -2544,12 +2544,12 @@ ] }, "/v1/Services/{ServiceSid}/Functions/{FunctionSid}/Versions/{Sid}": { - "description": "Twilio function versions", + "description": "The content of a Function.", "get": { - "description": null, + "description": "Retrieve a specific Function Version.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2561,7 +2561,7 @@ } }, { - "description": null, + "description": "Function Sid.", "in": "path", "name": "FunctionSid", "required": true, @@ -2573,7 +2573,7 @@ } }, { - "description": null, + "description": "Function Version Sid.", "in": "path", "name": "Sid", "required": true, @@ -2618,12 +2618,12 @@ ] }, "/v1/Services/{ServiceSid}/Functions/{Sid}": { - "description": "Twilio functions", + "description": "A wrapper that represents a Serverless JavaScript function.", "get": { - "description": null, + "description": "Retrieve a specific Function.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2635,7 +2635,7 @@ } }, { - "description": null, + "description": "Function Sid.", "in": "path", "name": "Sid", "required": true, @@ -2668,10 +2668,10 @@ ] }, "post": { - "description": null, + "description": "Update a specific Function.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "ServiceSid", "required": true, @@ -2683,7 +2683,7 @@ } }, { - "description": null, + "description": "Function Sid.", "in": "path", "name": "Sid", "required": true, @@ -2695,7 +2695,7 @@ } }, { - "description": null, + "description": "A human-readable description of this Function.", "in": "query", "name": "FriendlyName", "required": true, @@ -2736,12 +2736,12 @@ ] }, "/v1/Services/{Sid}": { - "description": "Containers for serverless apps", + "description": "Container for Serverless application Environments.", "get": { - "description": null, + "description": "Retrieve a specific Service.", "parameters": [ { - "description": null, + "description": "Serverless Service Sid or unique name.", "in": "path", "name": "Sid", "required": true, @@ -2774,10 +2774,10 @@ ] }, "post": { - "description": null, + "description": "Update a specific Service.", "parameters": [ { - "description": null, + "description": "Service Sid.", "in": "path", "name": "Sid", "required": true, @@ -2789,7 +2789,7 @@ } }, { - "description": null, + "description": "Whether to inject Account credentials into a Function invocation context.", "in": "query", "name": "IncludeCredentials", "required": false, @@ -2798,7 +2798,7 @@ } }, { - "description": null, + "description": "A human-readable description of this Service.", "in": "query", "name": "FriendlyName", "required": false, diff --git a/src/services/twilio-api/twilio_taskrouter.json b/src/services/twilio-api/twilio_taskrouter.json index 1b2937d9b..72e480613 100644 --- a/src/services/twilio-api/twilio_taskrouter.json +++ b/src/services/twilio-api/twilio_taskrouter.json @@ -517,6 +517,11 @@ "type": "string" } }, + "channel_optimized_routing": { + "type": { + "type": "boolean" + } + }, "date_created": { "type": { "format": "date-time", @@ -3221,7 +3226,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique ID of the Workspace that this TaskChannel belongs to.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -3295,7 +3300,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique ID of the Workspace that this TaskChannel belongs to.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -3323,6 +3328,15 @@ "schema": { "type": "string" } + }, + { + "description": "If true then prioritize longest idle workers", + "in": "query", + "name": "ChannelOptimizedRouting", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { @@ -3361,7 +3375,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique ID of the Workspace that this TaskChannel belongs to.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -3373,7 +3387,7 @@ } }, { - "description": null, + "description": "The unique ID for this TaskChannel.", "in": "path", "name": "Sid", "required": true, @@ -3410,7 +3424,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique ID of the Workspace that this TaskChannel belongs to.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -3422,7 +3436,7 @@ } }, { - "description": null, + "description": "The unique ID for this TaskChannel.", "in": "path", "name": "Sid", "required": true, @@ -3458,7 +3472,7 @@ "description": null, "parameters": [ { - "description": null, + "description": "The unique ID of the Workspace that this TaskChannel belongs to.", "in": "path", "name": "WorkspaceSid", "required": true, @@ -3470,7 +3484,7 @@ } }, { - "description": null, + "description": "The unique ID for this TaskChannel.", "in": "path", "name": "Sid", "required": true, @@ -3489,6 +3503,15 @@ "schema": { "type": "string" } + }, + { + "description": "If true then prioritize longest idle workers", + "in": "query", + "name": "ChannelOptimizedRouting", + "required": false, + "schema": { + "type": "boolean" + } } ], "responses": { diff --git a/src/services/twilio-api/twilio_wireless.json b/src/services/twilio-api/twilio_wireless.json index 3819b9c7a..db1976fa1 100644 --- a/src/services/twilio-api/twilio_wireless.json +++ b/src/services/twilio-api/twilio_wireless.json @@ -451,11 +451,6 @@ "type": "string" } }, - "imeisv": { - "type": { - "type": "string" - } - }, "last_updated": { "type": { "format": "date-time",