From d99b777f10ae5be7301192751678f9e4a560db24 Mon Sep 17 00:00:00 2001 From: Twilio Date: Tue, 12 Mar 2024 08:50:54 +0000 Subject: [PATCH] [Librarian] Regenerated @ 2264f28906b87ae1f1aedbf72f8dc0e4b57a545a --- CHANGES.md | 26 + spec/json/twilio_accounts_v1.json | 2 +- spec/json/twilio_api_v2010.json | 6 +- spec/json/twilio_bulkexports_v1.json | 2 +- spec/json/twilio_chat_v1.json | 2 +- spec/json/twilio_chat_v2.json | 2 +- spec/json/twilio_chat_v3.json | 2 +- spec/json/twilio_content_v1.json | 2 +- spec/json/twilio_conversations_v1.json | 2 +- spec/json/twilio_events_v1.json | 2 +- spec/json/twilio_flex_v1.json | 5457 +++++++++++++++++------- spec/json/twilio_flex_v2.json | 2 +- spec/json/twilio_frontline_v1.json | 2 +- spec/json/twilio_insights_v1.json | 2 +- spec/json/twilio_intelligence_v2.json | 2 +- spec/json/twilio_ip_messaging_v1.json | 2 +- spec/json/twilio_ip_messaging_v2.json | 2 +- spec/json/twilio_lookups_v1.json | 5 +- spec/json/twilio_lookups_v2.json | 2 +- spec/json/twilio_media_v1.json | 2 +- spec/json/twilio_messaging_v1.json | 12 +- spec/json/twilio_microvisor_v1.json | 2 +- spec/json/twilio_monitor_v1.json | 2 +- spec/json/twilio_notify_v1.json | 2 +- spec/json/twilio_numbers_v1.json | 4 +- spec/json/twilio_numbers_v2.json | 2 +- spec/json/twilio_preview.json | 2 +- spec/json/twilio_pricing_v1.json | 2 +- spec/json/twilio_pricing_v2.json | 2 +- spec/json/twilio_proxy_v1.json | 2 +- spec/json/twilio_routes_v2.json | 2 +- spec/json/twilio_serverless_v1.json | 2 +- spec/json/twilio_studio_v1.json | 2 +- spec/json/twilio_studio_v2.json | 2 +- spec/json/twilio_supersim_v1.json | 2 +- spec/json/twilio_sync_v1.json | 2 +- spec/json/twilio_taskrouter_v1.json | 2 +- spec/json/twilio_trunking_v1.json | 2 +- spec/json/twilio_trusthub_v1.json | 10 +- spec/json/twilio_verify_v2.json | 2 +- spec/json/twilio_video_v1.json | 2 +- spec/json/twilio_voice_v1.json | 2 +- spec/json/twilio_wireless_v1.json | 2 +- spec/yaml/twilio_accounts_v1.yaml | 2 +- spec/yaml/twilio_api_v2010.yaml | 18 +- spec/yaml/twilio_bulkexports_v1.yaml | 2 +- spec/yaml/twilio_chat_v1.yaml | 2 +- spec/yaml/twilio_chat_v2.yaml | 2 +- spec/yaml/twilio_chat_v3.yaml | 2 +- spec/yaml/twilio_content_v1.yaml | 2 +- spec/yaml/twilio_conversations_v1.yaml | 2 +- spec/yaml/twilio_events_v1.yaml | 2 +- spec/yaml/twilio_flex_v1.yaml | 1706 +++++++- spec/yaml/twilio_flex_v2.yaml | 2 +- spec/yaml/twilio_frontline_v1.yaml | 2 +- spec/yaml/twilio_insights_v1.yaml | 2 +- spec/yaml/twilio_intelligence_v2.yaml | 2 +- spec/yaml/twilio_ip_messaging_v1.yaml | 2 +- spec/yaml/twilio_ip_messaging_v2.yaml | 2 +- spec/yaml/twilio_lookups_v1.yaml | 3 +- spec/yaml/twilio_lookups_v2.yaml | 2 +- spec/yaml/twilio_media_v1.yaml | 2 +- spec/yaml/twilio_messaging_v1.yaml | 14 +- spec/yaml/twilio_microvisor_v1.yaml | 2 +- spec/yaml/twilio_monitor_v1.yaml | 2 +- spec/yaml/twilio_notify_v1.yaml | 2 +- spec/yaml/twilio_numbers_v1.yaml | 4 +- spec/yaml/twilio_numbers_v2.yaml | 2 +- spec/yaml/twilio_preview.yaml | 2 +- spec/yaml/twilio_pricing_v1.yaml | 2 +- spec/yaml/twilio_pricing_v2.yaml | 2 +- spec/yaml/twilio_proxy_v1.yaml | 2 +- spec/yaml/twilio_routes_v2.yaml | 2 +- spec/yaml/twilio_serverless_v1.yaml | 2 +- spec/yaml/twilio_studio_v1.yaml | 2 +- spec/yaml/twilio_studio_v2.yaml | 2 +- spec/yaml/twilio_supersim_v1.yaml | 2 +- spec/yaml/twilio_sync_v1.yaml | 2 +- spec/yaml/twilio_taskrouter_v1.yaml | 2 +- spec/yaml/twilio_trunking_v1.yaml | 2 +- spec/yaml/twilio_trusthub_v1.yaml | 8 +- spec/yaml/twilio_verify_v2.yaml | 2 +- spec/yaml/twilio_video_v1.yaml | 2 +- spec/yaml/twilio_voice_v1.yaml | 2 +- spec/yaml/twilio_wireless_v1.yaml | 2 +- 85 files changed, 5558 insertions(+), 1859 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 35497321..24997e4b 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,31 @@ twilio-oai changelog ==================== +[2024-03-12] Version 1.55.1 +--------------------------- +**Api** +- Correct precedence documentation for application_sid vs status_callback in message creation +- Mark MaxPrice as deprecated + +**Flex** +- Making `plugins` visibility to public + +**Messaging** +- Add new `errors` attribute to the Brand Registration resource. +- Mark `brand_feedback` attribute as deprecated. +- Mark `failure_reason` attribute as deprecated. +- The new `errors` attribute is expected to provide additional information about Brand registration failures and feedback (if any has been provided by The Campaign Registry). Consumers should use this attribute instead of `brand_feedback` and `failure_reason`. + +**Numbers** +- Correcting mount_name for porting port in fetch API + +**Trusthub** +- Add new field in statusCallbackUrl in compliance_registration. +- Add new field in isvRegisteringForSelfOrTenant in compliance_registration. + +**Twiml** +- Expanded description of Action parameter for Message verb + + [2024-02-27] Version 1.55.0 --------------------------- **Api** diff --git a/spec/json/twilio_accounts_v1.json b/spec/json/twilio_accounts_v1.json index b02c2f5a..3aafd677 100644 --- a/spec/json/twilio_accounts_v1.json +++ b/spec/json/twilio_accounts_v1.json @@ -234,7 +234,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_api_v2010.json b/spec/json/twilio_api_v2010.json index 68d8b896..b1bfd50b 100644 --- a/spec/json/twilio_api_v2010.json +++ b/spec/json/twilio_api_v2010.json @@ -9766,7 +9766,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { @@ -21061,11 +21061,11 @@ "minLength": 34, "maxLength": 34, "pattern": "^AP[0-9a-fA-F]{32}$", - "description": "The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). If this parameter is provided, the `status_callback` parameter of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL." + "description": "The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) are sent to the TwiML App's `message_status_callback` URL. Note that the `status_callback` parameter of a request takes priority over the `application_sid` parameter; if both are included `application_sid` is ignored." }, "MaxPrice": { "type": "number", - "description": "The maximum price in US dollars that you are willing to pay for this Message's delivery. The value can have up to four decimal places. When the `max_price` parameter is provided, the cost of a message is checked before it is sent. If the cost exceeds `max_price`, the message is not sent and the Message `status` is `failed`." + "description": "[DEPRECATED] This parameter will no longer have any effect as of 2024-06-03." }, "ProvideFeedback": { "type": "boolean", diff --git a/spec/json/twilio_bulkexports_v1.json b/spec/json/twilio_bulkexports_v1.json index f1d2906f..ccbf6ccf 100644 --- a/spec/json/twilio_bulkexports_v1.json +++ b/spec/json/twilio_bulkexports_v1.json @@ -271,7 +271,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v1.json b/spec/json/twilio_chat_v1.json index 11cca734..84cf3a66 100644 --- a/spec/json/twilio_chat_v1.json +++ b/spec/json/twilio_chat_v1.json @@ -878,7 +878,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v2.json b/spec/json/twilio_chat_v2.json index a004f12f..5b3e95e7 100644 --- a/spec/json/twilio_chat_v2.json +++ b/spec/json/twilio_chat_v2.json @@ -1278,7 +1278,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_chat_v3.json b/spec/json/twilio_chat_v3.json index e8515dc9..3e9d2d52 100644 --- a/spec/json/twilio_chat_v3.json +++ b/spec/json/twilio_chat_v3.json @@ -151,7 +151,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_content_v1.json b/spec/json/twilio_content_v1.json index a25decf6..de13d924 100644 --- a/spec/json/twilio_content_v1.json +++ b/spec/json/twilio_content_v1.json @@ -238,7 +238,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_conversations_v1.json b/spec/json/twilio_conversations_v1.json index 1b738f6f..95ae66f5 100644 --- a/spec/json/twilio_conversations_v1.json +++ b/spec/json/twilio_conversations_v1.json @@ -2648,7 +2648,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_events_v1.json b/spec/json/twilio_events_v1.json index d0dd1c62..fb8ef9d2 100644 --- a/spec/json/twilio_events_v1.json +++ b/spec/json/twilio_events_v1.json @@ -320,7 +320,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_flex_v1.json b/spec/json/twilio_flex_v1.json index f308aaac..68a51da6 100644 --- a/spec/json/twilio_flex_v1.json +++ b/spec/json/twilio_flex_v1.json @@ -350,6 +350,117 @@ "notstarted" ] }, + "flex.v1.plugin_configuration.configured_plugin": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Flex Plugin resource is installed for." + }, + "configuration_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin Configuration that this Flex Plugin belongs to." + }, + "plugin_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin." + }, + "plugin_version_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin Version." + }, + "phase": { + "type": "integer", + "nullable": true, + "description": "The phase this Flex Plugin would initialize at runtime." + }, + "plugin_url": { + "type": "string", + "nullable": true, + "description": "The URL of where the Flex Plugin Version JavaScript bundle is hosted on.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "The name that uniquely identifies this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name of this Flex Plugin resource." + }, + "description": { + "type": "string", + "nullable": true, + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long" + }, + "plugin_archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin is archived. The default value is false." + }, + "version": { + "type": "string", + "nullable": true, + "description": "The latest version of this Flex Plugin Version." + }, + "changelog": { + "type": "string", + "nullable": true, + "description": "A changelog that describes the changes this Flex Plugin Version brings." + }, + "plugin_version_archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Version is archived. The default value is false." + }, + "private": { + "type": "boolean", + "nullable": true, + "description": "Whether to validate the request is authorized to access the Flex Plugin Version." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin was installed specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin resource." + } + } + }, "flex.v1.flex_flow": { "type": "object", "properties": { @@ -1225,133 +1336,1774 @@ "unknown" ] }, - "flex.v1.provisioning_status": { + "flex.v1.plugin": { "type": "object", "properties": { - "status": { + "sid": { "type": "string", - "$ref": "#/components/schemas/provisioning_status_enum_status", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", "nullable": true, - "description": "Email Provisioning Status" + "description": "The unique string that we created to identify the Flex Plugin resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource." + }, + "unique_name": { + "type": "string", + "nullable": true, + "description": "The name that uniquely identifies this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "description": { + "type": "string", + "nullable": true, + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT-7 when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT-7 when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, "url": { "type": "string", "format": "uri", "nullable": true, - "description": "The absolute URL of the resource." + "description": "The absolute URL of the Flex Plugin resource." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true } } }, - "provisioning_status_enum_status": { - "type": "string", - "enum": [ - "active", - "in-progress", - "not-configured", - "failed" - ] - }, - "flex.v1.web_channel": { + "flex.v1.plugin_archive": { "type": "object", "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin resource." + }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin resource and owns this resource." }, - "flex_flow_sid": { + "unique_name": { + "type": "string", + "nullable": true, + "description": "The name that uniquely identifies this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "friendly_name": { + "type": "string", + "nullable": true, + "description": "The friendly name this Flex Plugin resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "description": { + "type": "string", + "nullable": true, + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin resource." + } + } + }, + "flex.v1.plugin_configuration": { + "type": "object", + "properties": { + "sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$", + "pattern": "^FJ[0-9a-fA-F]{32}$", "nullable": true, - "description": "The SID of the Flex Flow." + "description": "The unique string that we created to identify the Flex Plugin Configuration resource." }, - "sid": { + "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$", + "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, - "description": "The unique string that we created to identify the WebChannel resource." + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource." }, - "url": { + "name": { "type": "string", - "format": "uri", "nullable": true, - "description": "The absolute URL of the WebChannel resource." + "description": "The name of this Flex Plugin Configuration." + }, + "description": { + "type": "string", + "nullable": true, + "description": "The description of the Flex Plugin Configuration resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Configuration is archived. The default value is false." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, - "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + "description": "The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." }, - "date_updated": { + "url": { "type": "string", - "format": "date-time", + "format": "uri", "nullable": true, - "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + "description": "The absolute URL of the Flex Plugin Configuration resource." + }, + "links": { + "type": "object", + "format": "uri-map", + "nullable": true } } }, - "web_channel_enum_chat_status": { - "type": "string", - "enum": [ - "inactive" - ] - } - }, - "securitySchemes": { - "accountSid_authToken": { + "flex.v1.plugin_configuration_archive": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Configuration resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Configuration resource and owns this resource." + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of this Flex Plugin Configuration." + }, + "description": { + "type": "string", + "nullable": true, + "description": "The description of the Flex Plugin Configuration resource.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Configuration is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Configuration was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Configuration resource." + } + } + }, + "flex.v1.plugin_release": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FK[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Plugin Release resource." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Plugin Release resource and owns this resource." + }, + "configuration_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FJ[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Plugin Configuration resource to release." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Release was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Plugin Release resource." + } + } + }, + "flex.v1.plugin.plugin_version": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Version resource." + }, + "plugin_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin resource this Flex Plugin Version belongs to." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource." + }, + "version": { + "type": "string", + "nullable": true, + "description": "The unique version of this Flex Plugin Version." + }, + "plugin_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of where the Flex Plugin Version JavaScript bundle is hosted on.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "changelog": { + "type": "string", + "nullable": true, + "description": "A changelog that describes the changes this Flex Plugin Version brings.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "private": { + "type": "boolean", + "nullable": true, + "description": "Whether to inject credentials while accessing this Plugin Version. The default value is false." + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Version is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Version resource." + } + } + }, + "flex.v1.plugin_version_archive": { + "type": "object", + "properties": { + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FV[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the Flex Plugin Version resource." + }, + "plugin_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FP[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Plugin resource this Flex Plugin Version belongs to." + }, + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource." + }, + "version": { + "type": "string", + "nullable": true, + "description": "The unique version of this Flex Plugin Version." + }, + "plugin_url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The URL of where the Flex Plugin Version JavaScript bundle is hosted on.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "changelog": { + "type": "string", + "nullable": true, + "description": "A changelog that describes the changes this Flex Plugin Version brings.", + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + "private": { + "type": "boolean", + "nullable": true, + "description": "Whether to inject credentials while accessing this Plugin Version. The default value is false." + }, + "archived": { + "type": "boolean", + "nullable": true, + "description": "Whether the Flex Plugin Version is archived. The default value is false." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the Flex Plugin Version resource." + } + } + }, + "flex.v1.provisioning_status": { + "type": "object", + "properties": { + "status": { + "type": "string", + "$ref": "#/components/schemas/provisioning_status_enum_status", + "nullable": true, + "description": "Email Provisioning Status" + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the resource." + } + } + }, + "provisioning_status_enum_status": { + "type": "string", + "enum": [ + "active", + "in-progress", + "not-configured", + "failed" + ] + }, + "flex.v1.web_channel": { + "type": "object", + "properties": { + "account_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^AC[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the WebChannel resource and owns this Workflow." + }, + "flex_flow_sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The SID of the Flex Flow." + }, + "sid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$", + "nullable": true, + "description": "The unique string that we created to identify the WebChannel resource." + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true, + "description": "The absolute URL of the WebChannel resource." + }, + "date_created": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + }, + "date_updated": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format." + } + } + }, + "web_channel_enum_chat_status": { + "type": "string", + "enum": [ + "inactive" + ] + } + }, + "securitySchemes": { + "accountSid_authToken": { "type": "http", "scheme": "basic" } - } - }, - "info": { - "title": "Twilio - Flex", - "description": "This is the public Twilio REST API.", - "termsOfService": "https://www.twilio.com/legal/tos", - "contact": { - "name": "Twilio Support", - "url": "https://support.twilio.com", - "email": "support@twilio.com" - }, - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + } + }, + "info": { + "title": "Twilio - Flex", + "description": "This is the public Twilio REST API.", + "termsOfService": "https://www.twilio.com/legal/tos", + "contact": { + "name": "Twilio Support", + "url": "https://support.twilio.com", + "email": "support@twilio.com" + }, + "license": { + "name": "Apache 2.0", + "url": "https://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.55.1" + }, + "openapi": "3.0.1", + "paths": { + "/v1/Channels": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex chat channels", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "flex_flow_sid", + "user_sid", + "task_sid" + ], + "pathType": "list", + "mountName": "channel" + }, + "get": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "parameters": [ + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListChannelResponse", + "properties": { + "flex_chat_channels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.channel" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListChannel", + "x-maturity": [ + "GA" + ] + }, + "post": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.channel" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateChannel", + "x-maturity": [ + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateChannelRequest", + "properties": { + "FlexFlowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$", + "description": "The SID of the Flex Flow." + }, + "Identity": { + "type": "string", + "description": "The `identity` value that uniquely identifies the new resource's chat User." + }, + "ChatUserFriendlyName": { + "type": "string", + "description": "The chat participant's friendly name." + }, + "ChatFriendlyName": { + "type": "string", + "description": "The chat channel's friendly name." + }, + "Target": { + "type": "string", + "description": "The Target Contact Identity, for example the phone number of an SMS." + }, + "ChatUniqueName": { + "type": "string", + "description": "The chat channel's unique name." + }, + "PreEngagementData": { + "type": "string", + "description": "The pre-engagement data." + }, + "TaskSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WT[0-9a-fA-F]{32}$", + "description": "The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`" + }, + "TaskAttributes": { + "type": "string", + "description": "The Task attributes to be added for the TaskRouter Task." + }, + "LongLived": { + "type": "boolean", + "description": "Whether to create the channel as long-lived." + } + }, + "required": [ + "FlexFlowSid", + "Identity", + "ChatUserFriendlyName", + "ChatFriendlyName" + ] + } + } + } + } + } + }, + "/v1/Channels/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex chat channels", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "flex_flow_sid", + "user_sid", + "task_sid" + ], + "pathType": "instance", + "mountName": "channel" + }, + "get": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex chat channel resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.channel" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchChannel", + "x-maturity": [ + "GA" + ] + }, + "delete": { + "description": "", + "tags": [ + "FlexV1Channel" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex chat channel resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^CH[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteChannel", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/Configuration": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Configuration for a Flex instance", + "x-twilio": { + "defaultOutputProperties": [ + "status", + "ui_language", + "ui_version", + "service_version" + ], + "pathType": "instance" + }, + "get": { + "description": "", + "tags": [ + "FlexV1Configuration" + ], + "parameters": [ + { + "name": "UiVersion", + "in": "query", + "description": "The Pinned UI version of the Configuration resource to fetch.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.configuration" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchConfiguration", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/PluginService/Configurations/{ConfigurationSid}/Plugins": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "plugin_sid", + "plugin_version_sid", + "plugin_url", + "phase" + ], + "pathType": "list", + "parent": "/PluginService/Configurations/{Sid}", + "className": "configured_plugin" + }, + "get": { + "description": "", + "tags": [ + "FlexV1ConfiguredPlugin" + ], + "parameters": [ + { + "name": "ConfigurationSid", + "in": "path", + "description": "The SID of the Flex Plugin Configuration the resource to belongs to.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListConfiguredPluginResponse", + "properties": { + "plugins": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.plugin_configuration.configured_plugin" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListConfiguredPlugin", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "plugin_sid", + "plugin_version_sid", + "plugin_url", + "phase" + ], + "pathType": "instance", + "parent": "/PluginService/Configurations/{Sid}", + "className": "configured_plugin" + }, + "get": { + "description": "", + "tags": [ + "FlexV1ConfiguredPlugin" + ], + "parameters": [ + { + "name": "ConfigurationSid", + "in": "path", + "description": "The SID of the Flex Plugin Configuration the resource to belongs to.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "PluginSid", + "in": "path", + "description": "The unique string that we created to identify the Flex Plugin resource.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.plugin_configuration.configured_plugin" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchConfiguredPlugin", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/FlexFlows": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex Flow", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name", + "channel_type", + "integration_type" + ], + "pathType": "list", + "mountName": "flex_flow" + }, + "get": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "FriendlyName", + "in": "query", + "description": "The `friendly_name` of the Flex Flow resources to read.", + "schema": { + "type": "string" + }, + "x-twilio": { + "pii": { + "handling": "standard", + "deleteSla": 30 + } + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListFlexFlowResponse", + "properties": { + "flex_flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "ListFlexFlow", + "x-maturity": [ + "GA" + ] + }, + "post": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateFlexFlow", + "x-maturity": [ + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateFlexFlowRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the Flex Flow resource." + }, + "ChatServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "The SID of the chat service." + }, + "ChannelType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_channel_type", + "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." + }, + "ContactIdentity": { + "type": "string", + "description": "The channel contact's Identity." + }, + "Enabled": { + "type": "boolean", + "description": "Whether the new Flex Flow is enabled." + }, + "IntegrationType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_integration_type", + "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." + }, + "Integration.FlowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." + }, + "Integration.Url": { + "type": "string", + "format": "uri", + "description": "The URL of the external webhook. Required when `integrationType` is `external`." + }, + "Integration.WorkspaceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.WorkflowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.Channel": { + "type": "string", + "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." + }, + "Integration.Timeout": { + "type": "integer", + "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.Priority": { + "type": "integer", + "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.CreationOnMessage": { + "type": "boolean", + "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." + }, + "LongLived": { + "type": "boolean", + "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." + }, + "JanitorEnabled": { + "type": "boolean", + "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + }, + "Integration.RetryCount": { + "type": "integer", + "description": "The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise." + } + }, + "required": [ + "FriendlyName", + "ChatServiceSid", + "ChannelType" + ] + } + } + } + } + } + }, + "/v1/FlexFlows/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "Flex Flow", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "friendly_name", + "channel_type", + "integration_type" + ], + "pathType": "instance", + "mountName": "flex_flow" + }, + "get": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Flow resource to fetch.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchFlexFlow", + "x-maturity": [ + "GA" + ] + }, + "post": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Flow resource to update.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.flex_flow" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateFlexFlow", + "x-maturity": [ + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateFlexFlowRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "A descriptive string that you create to describe the Flex Flow resource." + }, + "ChatServiceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^IS[0-9a-fA-F]{32}$", + "description": "The SID of the chat service." + }, + "ChannelType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_channel_type", + "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." + }, + "ContactIdentity": { + "type": "string", + "description": "The channel contact's Identity." + }, + "Enabled": { + "type": "boolean", + "description": "Whether the new Flex Flow is enabled." + }, + "IntegrationType": { + "type": "string", + "$ref": "#/components/schemas/flex_flow_enum_integration_type", + "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." + }, + "Integration.FlowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FW[0-9a-fA-F]{32}$", + "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." + }, + "Integration.Url": { + "type": "string", + "format": "uri", + "description": "The URL of the external webhook. Required when `integrationType` is `external`." + }, + "Integration.WorkspaceSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WS[0-9a-fA-F]{32}$", + "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.WorkflowSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WW[0-9a-fA-F]{32}$", + "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + }, + "Integration.Channel": { + "type": "string", + "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." + }, + "Integration.Timeout": { + "type": "integer", + "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.Priority": { + "type": "integer", + "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." + }, + "Integration.CreationOnMessage": { + "type": "boolean", + "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." + }, + "LongLived": { + "type": "boolean", + "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." + }, + "JanitorEnabled": { + "type": "boolean", + "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + }, + "Integration.RetryCount": { + "type": "integer", + "description": "The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise." + } + } + } + } + } + } + }, + "delete": { + "description": "", + "tags": [ + "FlexV1FlexFlow" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Flow resource to delete.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FO[0-9a-fA-F]{32}$" + }, + "required": true + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteFlexFlow", + "x-maturity": [ + "GA" + ] + } }, - "version": "1.55.0" - }, - "openapi": "3.0.1", - "paths": { - "/v1/Channels": { + "/v1/Insights/QualityManagement/Assessments": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Flex chat channels", + "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid", - "flex_flow_sid", - "user_sid", - "task_sid" + "account_sid", + "assessment_sid", + "assessment" ], "pathType": "list", - "mountName": "channel" + "className": "assessments" + }, + "post": { + "description": "Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.", + "tags": [ + "FlexV1Assessments" + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_assessments" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateInsightsAssessments", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateInsightsAssessmentsRequest", + "properties": { + "CategorySid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$", + "description": "The SID of the category " + }, + "CategoryName": { + "type": "string", + "description": "The name of the category" + }, + "SegmentId": { + "type": "string", + "description": "Segment Id of the conversation" + }, + "AgentId": { + "type": "string", + "description": "The id of the Agent" + }, + "Offset": { + "type": "number", + "description": "The offset of the conversation." + }, + "MetricId": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$", + "description": "The question SID selected for assessment" + }, + "MetricName": { + "type": "string", + "description": "The question name of the assessment" + }, + "AnswerText": { + "type": "string", + "description": "The answer text selected by user" + }, + "AnswerId": { + "type": "string", + "description": "The id of the answer selected by user" + }, + "QuestionnaireSid": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GM[0-9a-fA-F]{32}$", + "description": "Questionnaire SID of the associated question" + } + }, + "required": [ + "CategorySid", + "CategoryName", + "SegmentId", + "AgentId", + "Offset", + "MetricId", + "MetricName", + "AnswerText", + "AnswerId", + "QuestionnaireSid" + ] + } + } + } + } }, "get": { - "description": "", + "description": "Get assessments done for a conversation by logged in user", "tags": [ - "FlexV1Channel" + "FlexV1Assessments" ], "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "SegmentId", + "in": "query", + "description": "The id of the segment.", + "schema": { + "type": "string" + } + }, { "name": "PageSize", "in": "query", @@ -1386,12 +3138,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListChannelResponse", + "title": "ListInsightsAssessmentsResponse", "properties": { - "flex_chat_channels": { + "assessments": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.channel" + "$ref": "#/components/schemas/flex.v1.insights_assessments" } }, "meta": { @@ -1438,26 +3190,65 @@ "accountSid_authToken": [] } ], - "operationId": "ListChannel", + "operationId": "ListInsightsAssessments", "x-maturity": [ - "GA" + "Preview" ] + } + }, + "/v1/Insights/QualityManagement/Assessments/{AssessmentSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "assessment_sid", + "assessment" + ], + "pathType": "instance", + "className": "assessments" }, "post": { - "description": "", + "description": "Update a specific Assessment assessed earlier", "tags": [ - "FlexV1Channel" + "FlexV1Assessments" + ], + "parameters": [ + { + "name": "AssessmentSid", + "in": "path", + "description": "The SID of the assessment to be modified", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FM[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.channel" + "$ref": "#/components/schemas/flex.v1.insights_assessments" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -1465,69 +3256,34 @@ "accountSid_authToken": [] } ], - "operationId": "CreateChannel", + "operationId": "UpdateInsightsAssessments", "x-maturity": [ - "GA" + "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateChannelRequest", + "title": "UpdateInsightsAssessmentsRequest", "properties": { - "FlexFlowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$", - "description": "The SID of the Flex Flow." - }, - "Identity": { - "type": "string", - "description": "The `identity` value that uniquely identifies the new resource's chat User." - }, - "ChatUserFriendlyName": { - "type": "string", - "description": "The chat participant's friendly name." - }, - "ChatFriendlyName": { - "type": "string", - "description": "The chat channel's friendly name." - }, - "Target": { - "type": "string", - "description": "The Target Contact Identity, for example the phone number of an SMS." - }, - "ChatUniqueName": { - "type": "string", - "description": "The chat channel's unique name." - }, - "PreEngagementData": { - "type": "string", - "description": "The pre-engagement data." + "Offset": { + "type": "number", + "description": "The offset of the conversation" }, - "TaskSid": { + "AnswerText": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WT[0-9a-fA-F]{32}$", - "description": "The SID of the TaskRouter Task. Only valid when integration type is `task`. `null` for integration types `studio` & `external`" + "description": "The answer text selected by user" }, - "TaskAttributes": { + "AnswerId": { "type": "string", - "description": "The Task attributes to be added for the TaskRouter Task." - }, - "LongLived": { - "type": "boolean", - "description": "Whether to create the channel as long-lived." + "description": "The id of the answer selected by user" } }, "required": [ - "FlexFlowSid", - "Identity", - "ChatUserFriendlyName", - "ChatFriendlyName" + "Offset", + "AnswerText", + "AnswerId" ] } } @@ -1535,52 +3291,47 @@ } } }, - "/v1/Channels/{Sid}": { + "/v1/Insights/QualityManagement/Assessments/Comments": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Flex chat channels", + "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid", - "flex_flow_sid", - "user_sid", - "task_sid" + "account_sid", + "assessment_sid", + "comment" ], - "pathType": "instance", - "mountName": "channel" + "pathType": "list", + "mountName": "insights_assessments_comment" }, - "get": { - "description": "", + "post": { + "description": "To create a comment assessment for a conversation", "tags": [ - "FlexV1Channel" + "FlexV1InsightsAssessmentsComment" ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex chat channel resource to fetch.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.channel" + "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1588,33 +3339,164 @@ "accountSid_authToken": [] } ], - "operationId": "FetchChannel", + "operationId": "CreateInsightsAssessmentsComment", "x-maturity": [ - "GA" - ] + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateInsightsAssessmentsCommentRequest", + "properties": { + "CategoryId": { + "type": "string", + "description": "The ID of the category" + }, + "CategoryName": { + "type": "string", + "description": "The name of the category" + }, + "Comment": { + "type": "string", + "description": "The Assessment comment." + }, + "SegmentId": { + "type": "string", + "description": "The id of the segment." + }, + "AgentId": { + "type": "string", + "description": "The id of the agent." + }, + "Offset": { + "type": "number", + "description": "The offset" + } + }, + "required": [ + "CategoryId", + "CategoryName", + "Comment", + "SegmentId", + "AgentId", + "Offset" + ] + } + } + } + } }, - "delete": { - "description": "", + "get": { + "description": "To create a comment assessment for a conversation", "tags": [ - "FlexV1Channel" + "FlexV1InsightsAssessmentsComment" ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex chat channel resource to delete.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^CH[0-9a-fA-F]{32}$" + "type": "string" + } + }, + { + "name": "SegmentId", + "in": "query", + "description": "The id of the segment.", + "schema": { + "type": "string" + } + }, + { + "name": "AgentId", + "in": "query", + "description": "The id of the agent.", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListInsightsAssessmentsCommentResponse", + "properties": { + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } }, - "required": true - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "description": "OK" } }, "security": [ @@ -1622,38 +3504,75 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteChannel", + "operationId": "ListInsightsAssessmentsComment", "x-maturity": [ - "GA" + "Preview" ] } }, - "/v1/Configuration": { + "/v1/Insights/Conversations": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Configuration for a Flex instance", + "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "status", - "ui_language", - "ui_version", - "service_version" + "conversation_id", + "account_id", + "segment_count", + "segments" ], - "pathType": "instance" + "pathType": "list", + "mountName": "insights_conversations", + "className": "insights_conversations" }, "get": { - "description": "", + "description": "To get conversation with segment id", "tags": [ - "FlexV1Configuration" + "FlexV1InsightsConversations" ], "parameters": [ { - "name": "UiVersion", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "SegmentId", "in": "query", - "description": "The Pinned UI version of the Configuration resource to fetch.", + "description": "Unique Id of the segment for which conversation details needs to be fetched", + "schema": { + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" } @@ -1664,7 +3583,48 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.configuration" + "type": "object", + "title": "ListInsightsConversationsResponse", + "properties": { + "conversations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.insights_conversations" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } } } }, @@ -1676,48 +3636,124 @@ "accountSid_authToken": [] } ], - "operationId": "FetchConfiguration", + "operationId": "ListInsightsConversations", "x-maturity": [ - "GA" + "Preview" ] } }, - "/v1/FlexFlows": { + "/v1/Insights/QualityManagement/Questionnaires": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Flex Flow", + "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid", - "friendly_name", - "channel_type", - "integration_type" + "account_sid", + "questionnaire_sid", + "name" ], "pathType": "list", - "mountName": "flex_flow" + "mountName": "insights_questionnaires", + "className": "insights_questionnaires" }, - "get": { - "description": "", + "post": { + "description": "To create a Questionnaire", "tags": [ - "FlexV1FlexFlow" + "FlexV1InsightsQuestionnaires" ], "parameters": [ { - "name": "FriendlyName", - "in": "query", - "description": "The `friendly_name` of the Flex Flow resources to read.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { "type": "string" + } + } + ], + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + } + } }, - "x-twilio": { - "pii": { - "handling": "standard", - "deleteSla": 30 + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateInsightsQuestionnaires", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateInsightsQuestionnairesRequest", + "properties": { + "Name": { + "type": "string", + "description": "The name of this questionnaire" + }, + "Description": { + "type": "string", + "description": "The description of this questionnaire" + }, + "Active": { + "type": "boolean", + "description": "The flag to enable or disable questionnaire" + }, + "QuestionSids": { + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "description": "The list of questions sids under a questionnaire" + } + }, + "required": [ + "Name" + ] } } + } + } + }, + "get": { + "description": "To get all questionnaires with questions", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + }, + { + "name": "IncludeInactive", + "in": "query", + "description": "Flag indicating whether to include inactive questionnaires or not", + "schema": { + "type": "boolean" + } }, { "name": "PageSize", @@ -1753,12 +3789,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListFlexFlowResponse", + "title": "ListInsightsQuestionnairesResponse", "properties": { - "flex_flows": { + "questionnaires": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires" } }, "meta": { @@ -1805,26 +3841,66 @@ "accountSid_authToken": [] } ], - "operationId": "ListFlexFlow", + "operationId": "ListInsightsQuestionnaires", "x-maturity": [ - "GA" + "Preview" ] + } + }, + "/v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "questionnaire_sid", + "name" + ], + "pathType": "instance", + "mountName": "insights_questionnaires", + "className": "insights_questionnaires" }, "post": { - "description": "", + "description": "To update the questionnaire", "tags": [ - "FlexV1FlexFlow" + "FlexV1InsightsQuestionnaires" + ], + "parameters": [ + { + "name": "QuestionnaireSid", + "in": "path", + "description": "The SID of the questionnaire", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GM[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -1832,158 +3908,181 @@ "accountSid_authToken": [] } ], - "operationId": "CreateFlexFlow", + "operationId": "UpdateInsightsQuestionnaires", "x-maturity": [ - "GA" + "Preview" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateFlexFlowRequest", + "title": "UpdateInsightsQuestionnairesRequest", "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the Flex Flow resource." - }, - "ChatServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "The SID of the chat service." - }, - "ChannelType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_channel_type", - "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." - }, - "ContactIdentity": { - "type": "string", - "description": "The channel contact's Identity." - }, - "Enabled": { + "Active": { "type": "boolean", - "description": "Whether the new Flex Flow is enabled." - }, - "IntegrationType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_integration_type", - "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." - }, - "Integration.FlowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." - }, - "Integration.Url": { - "type": "string", - "format": "uri", - "description": "The URL of the external webhook. Required when `integrationType` is `external`." - }, - "Integration.WorkspaceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." + "description": "The flag to enable or disable questionnaire" }, - "Integration.WorkflowSid": { + "Name": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." + "description": "The name of this questionnaire" }, - "Integration.Channel": { + "Description": { "type": "string", - "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." - }, - "Integration.Timeout": { - "type": "integer", - "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.Priority": { - "type": "integer", - "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.CreationOnMessage": { - "type": "boolean", - "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." - }, - "LongLived": { - "type": "boolean", - "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." - }, - "JanitorEnabled": { - "type": "boolean", - "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." + "description": "The description of this questionnaire" }, - "Integration.RetryCount": { - "type": "integer", - "description": "The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise." + "QuestionSids": { + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "description": "The list of questions sids under a questionnaire" } }, "required": [ - "FriendlyName", - "ChatServiceSid", - "ChannelType" + "Active" ] } } } } + }, + "delete": { + "description": "To delete the questionnaire", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], + "parameters": [ + { + "name": "QuestionnaireSid", + "in": "path", + "description": "The SID of the questionnaire", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GM[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "The resource was deleted successfully." + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "DeleteInsightsQuestionnaires", + "x-maturity": [ + "Preview" + ] + }, + "get": { + "description": "To get the Questionnaire Detail", + "tags": [ + "FlexV1InsightsQuestionnaires" + ], + "parameters": [ + { + "name": "QuestionnaireSid", + "in": "path", + "description": "The SID of the questionnaire", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GM[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchInsightsQuestionnaires", + "x-maturity": [ + "Preview" + ] } }, - "/v1/FlexFlows/{Sid}": { + "/v1/Insights/QualityManagement/Categories": { "servers": [ { "url": "https://flex-api.twilio.com" } ], - "description": "Flex Flow", + "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid", - "friendly_name", - "channel_type", - "integration_type" + "account_sid", + "category_sid", + "name" ], - "pathType": "instance", - "mountName": "flex_flow" + "pathType": "list", + "mountName": "insights_questionnaires_category" }, - "get": { - "description": "", + "post": { + "description": "To create a category for Questions", "tags": [ - "FlexV1FlexFlow" + "FlexV1InsightsQuestionnairesCategory" ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex Flow resource to fetch.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -1991,28 +4090,70 @@ "accountSid_authToken": [] } ], - "operationId": "FetchFlexFlow", + "operationId": "CreateInsightsQuestionnairesCategory", "x-maturity": [ - "GA" - ] + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreateInsightsQuestionnairesCategoryRequest", + "properties": { + "Name": { + "type": "string", + "description": "The name of this category." + } + }, + "required": [ + "Name" + ] + } + } + } + } }, - "post": { - "description": "", + "get": { + "description": "To get all the categories", "tags": [ - "FlexV1FlexFlow" + "FlexV1InsightsQuestionnairesCategory" ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Flex Flow resource to update.", + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } } ], "responses": { @@ -2020,7 +4161,48 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.flex_flow" + "type": "object", + "title": "ListInsightsQuestionnairesCategoryResponse", + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } } } }, @@ -2032,101 +4214,91 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateFlexFlow", + "operationId": "ListInsightsQuestionnairesCategory", "x-maturity": [ - "GA" + "Preview" + ] + } + }, + "/v1/Insights/QualityManagement/Categories/{CategorySid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "account_sid", + "category_sid", + "name" ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateFlexFlowRequest", - "properties": { - "FriendlyName": { - "type": "string", - "description": "A descriptive string that you create to describe the Flex Flow resource." - }, - "ChatServiceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^IS[0-9a-fA-F]{32}$", - "description": "The SID of the chat service." - }, - "ChannelType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_channel_type", - "description": "The channel type. One of `web`, `facebook`, `sms`, `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send to Flex widget passes it on to the Task attributes for Tasks created based on this Flex Flow. The Task attributes will be used by the Flex UI to render the respective Task as appropriate (applying channel-specific design and length limits). If `channelType` is `facebook`, `whatsapp` or `line`, the Send to Flex widget should set the Task Channel to Programmable Chat." - }, - "ContactIdentity": { - "type": "string", - "description": "The channel contact's Identity." - }, - "Enabled": { - "type": "boolean", - "description": "Whether the new Flex Flow is enabled." - }, - "IntegrationType": { - "type": "string", - "$ref": "#/components/schemas/flex_flow_enum_integration_type", - "description": "The software that will handle inbound messages. [Integration Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) can be: `studio`, `external`, or `task`." - }, - "Integration.FlowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FW[0-9a-fA-F]{32}$", - "description": "The SID of the Studio Flow. Required when `integrationType` is `studio`." - }, - "Integration.Url": { - "type": "string", - "format": "uri", - "description": "The URL of the external webhook. Required when `integrationType` is `external`." - }, - "Integration.WorkspaceSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WS[0-9a-fA-F]{32}$", - "description": "The Workspace SID for a new Task. Required when `integrationType` is `task`." - }, - "Integration.WorkflowSid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WW[0-9a-fA-F]{32}$", - "description": "The Workflow SID for a new Task. Required when `integrationType` is `task`." - }, - "Integration.Channel": { + "pathType": "instance", + "mountName": "insights_questionnaires_category" + }, + "post": { + "description": "To update the category for Questions", + "tags": [ + "FlexV1InsightsQuestionnairesCategory" + ], + "parameters": [ + { + "name": "CategorySid", + "in": "path", + "description": "The SID of the category to be updated", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "UpdateInsightsQuestionnairesCategory", + "x-maturity": [ + "Preview" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdateInsightsQuestionnairesCategoryRequest", + "properties": { + "Name": { "type": "string", - "description": "The Task Channel SID (TCXXXX) or unique name (e.g., `sms`) to use for the Task that will be created. Applicable and required when `integrationType` is `task`. The default value is `default`." - }, - "Integration.Timeout": { - "type": "integer", - "description": "The Task timeout in seconds for a new Task. Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.Priority": { - "type": "integer", - "description": "The Task priority of a new Task. The default priority is 0. Optional when `integrationType` is `task`, not applicable otherwise." - }, - "Integration.CreationOnMessage": { - "type": "boolean", - "description": "In the context of outbound messaging, defines whether to create a Task immediately (and therefore reserve the conversation to current agent), or delay Task creation until the customer sends the first response. Set to false to create immediately, true to delay Task creation. This setting is only applicable for outbound messaging." - }, - "LongLived": { - "type": "boolean", - "description": "When enabled, Flex will keep the chat channel active so that it may be used for subsequent interactions with a contact identity. Defaults to `false`." - }, - "JanitorEnabled": { - "type": "boolean", - "description": "When enabled, the Messaging Channel Janitor will remove active Proxy sessions if the associated Task is deleted outside of the Flex UI. Defaults to `false`." - }, - "Integration.RetryCount": { - "type": "integer", - "description": "The number of times to retry the Studio Flow or webhook in case of failure. Takes integer values from 0 to 3 with the default being 3. Optional when `integrationType` is `studio` or `external`, not applicable otherwise." + "description": "The name of this category." } - } + }, + "required": [ + "Name" + ] } } } @@ -2135,20 +4307,28 @@ "delete": { "description": "", "tags": [ - "FlexV1FlexFlow" + "FlexV1InsightsQuestionnairesCategory" ], "parameters": [ { - "name": "Sid", + "name": "CategorySid", "in": "path", - "description": "The SID of the Flex Flow resource to delete.", + "description": "The SID of the category to be deleted", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FO[0-9a-fA-F]{32}$" + "pattern": "^FY[0-9a-fA-F]{32}$" }, "required": true + }, + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } } ], "responses": { @@ -2161,13 +4341,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteFlexFlow", + "operationId": "DeleteInsightsQuestionnairesCategory", "x-maturity": [ - "GA" + "Preview" ] } }, - "/v1/Insights/QualityManagement/Assessments": { + "/v1/Insights/QualityManagement/Questions": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -2177,16 +4357,16 @@ "x-twilio": { "defaultOutputProperties": [ "account_sid", - "assessment_sid", - "assessment" + "question_sid", + "question" ], "pathType": "list", - "className": "assessments" + "mountName": "insights_questionnaires_question" }, "post": { - "description": "Add assessments against conversation to dynamo db. Used in assessments screen by user. Users can select the questionnaire and pick up answers for each and every question.", + "description": "To create a question for a Category", "tags": [ - "FlexV1Assessments" + "FlexV1InsightsQuestionnairesQuestion" ], "parameters": [ { @@ -2203,7 +4383,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_assessments" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" } } }, @@ -2215,7 +4395,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsAssessments", + "operationId": "CreateInsightsQuestionnairesQuestion", "x-maturity": [ "Preview" ], @@ -2224,69 +4404,37 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsAssessmentsRequest", + "title": "CreateInsightsQuestionnairesQuestionRequest", "properties": { "CategorySid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^FY[0-9a-fA-F]{32}$", - "description": "The SID of the category " - }, - "CategoryName": { - "type": "string", - "description": "The name of the category" - }, - "SegmentId": { - "type": "string", - "description": "Segment Id of the conversation" - }, - "AgentId": { - "type": "string", - "description": "The id of the Agent" - }, - "Offset": { - "type": "number", - "description": "The offset of the conversation." - }, - "MetricId": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$", - "description": "The question SID selected for assessment" + "description": "The SID of the category" }, - "MetricName": { + "Question": { "type": "string", - "description": "The question name of the assessment" + "description": "The question." }, - "AnswerText": { + "AnswerSetId": { "type": "string", - "description": "The answer text selected by user" + "description": "The answer_set for the question." }, - "AnswerId": { - "type": "string", - "description": "The id of the answer selected by user" + "AllowNa": { + "type": "boolean", + "description": "The flag to enable for disable NA for answer." }, - "QuestionnaireSid": { + "Description": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$", - "description": "Questionnaire SID of the associated question" + "description": "The description for the question." } }, "required": [ "CategorySid", - "CategoryName", - "SegmentId", - "AgentId", - "Offset", - "MetricId", - "MetricName", - "AnswerText", - "AnswerId", - "QuestionnaireSid" + "Question", + "AnswerSetId", + "AllowNa" ] } } @@ -2294,9 +4442,9 @@ } }, "get": { - "description": "Get assessments done for a conversation by logged in user", + "description": "To get all the question for the given categories", "tags": [ - "FlexV1Assessments" + "FlexV1InsightsQuestionnairesQuestion" ], "parameters": [ { @@ -2308,11 +4456,17 @@ } }, { - "name": "SegmentId", + "name": "CategorySid", "in": "query", - "description": "The id of the segment.", + "description": "The list of category SIDs", "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$" + } } }, { @@ -2349,12 +4503,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsAssessmentsResponse", + "title": "ListInsightsQuestionnairesQuestionResponse", "properties": { - "assessments": { + "questions": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_assessments" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" } }, "meta": { @@ -2401,13 +4555,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessments", + "operationId": "ListInsightsQuestionnairesQuestion", "x-maturity": [ "Preview" ] } }, - "/v1/Insights/QualityManagement/Assessments/{AssessmentSid}": { + "/v1/Insights/QualityManagement/Questions/{QuestionSid}": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -2417,27 +4571,27 @@ "x-twilio": { "defaultOutputProperties": [ "account_sid", - "assessment_sid", - "assessment" + "question_sid", + "question" ], "pathType": "instance", - "className": "assessments" + "mountName": "insights_questionnaires_question" }, "post": { - "description": "Update a specific Assessment assessed earlier", + "description": "To update the question", "tags": [ - "FlexV1Assessments" + "FlexV1InsightsQuestionnairesQuestion" ], "parameters": [ { - "name": "AssessmentSid", + "name": "QuestionSid", "in": "path", - "description": "The SID of the assessment to be modified", + "description": "The SID of the question", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FM[0-9a-fA-F]{32}$" + "pattern": "^GE[0-9a-fA-F]{32}$" }, "required": true }, @@ -2455,7 +4609,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_assessments" + "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" } } }, @@ -2467,7 +4621,7 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsAssessments", + "operationId": "UpdateInsightsQuestionnairesQuestion", "x-maturity": [ "Preview" ], @@ -2476,54 +4630,58 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsAssessmentsRequest", + "title": "UpdateInsightsQuestionnairesQuestionRequest", "properties": { - "Offset": { - "type": "number", - "description": "The offset of the conversation" + "AllowNa": { + "type": "boolean", + "description": "The flag to enable for disable NA for answer." }, - "AnswerText": { + "CategorySid": { "type": "string", - "description": "The answer text selected by user" + "minLength": 34, + "maxLength": 34, + "pattern": "^FY[0-9a-fA-F]{32}$", + "description": "The SID of the category" }, - "AnswerId": { + "Question": { "type": "string", - "description": "The id of the answer selected by user" + "description": "The question." + }, + "Description": { + "type": "string", + "description": "The description for the question." + }, + "AnswerSetId": { + "type": "string", + "description": "The answer_set for the question." } }, "required": [ - "Offset", - "AnswerText", - "AnswerId" + "AllowNa" ] } } } } - } - }, - "/v1/Insights/QualityManagement/Assessments/Comments": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "account_sid", - "assessment_sid", - "comment" - ], - "pathType": "list", - "mountName": "insights_assessments_comment" }, - "post": { - "description": "To create a comment assessment for a conversation", + "delete": { + "description": "", "tags": [ - "FlexV1InsightsAssessmentsComment" + "FlexV1InsightsQuestionnairesQuestion" ], "parameters": [ + { + "name": "QuestionSid", + "in": "path", + "description": "The SID of the question", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^GE[0-9a-fA-F]{32}$" + }, + "required": true + }, { "name": "Authorization", "in": "header", @@ -2534,15 +4692,8 @@ } ], "responses": { - "201": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" - } - } - }, - "description": "Created" + "204": { + "description": "The resource was deleted successfully." } }, "security": [ @@ -2550,59 +4701,35 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsAssessmentsComment", + "operationId": "DeleteInsightsQuestionnairesQuestion", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateInsightsAssessmentsCommentRequest", - "properties": { - "CategoryId": { - "type": "string", - "description": "The ID of the category" - }, - "CategoryName": { - "type": "string", - "description": "The name of the category" - }, - "Comment": { - "type": "string", - "description": "The Assessment comment." - }, - "SegmentId": { - "type": "string", - "description": "The id of the segment." - }, - "AgentId": { - "type": "string", - "description": "The id of the agent." - }, - "Offset": { - "type": "number", - "description": "The offset" - } - }, - "required": [ - "CategoryId", - "CategoryName", - "Comment", - "SegmentId", - "AgentId", - "Offset" - ] - } - } - } + ] + } + }, + "/v1/Insights/Segments": { + "servers": [ + { + "url": "https://flex-api.twilio.com" } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "segment_id", + "external_id", + "account_id", + "agent_id", + "queue" + ], + "pathType": "list", + "mountName": "insights_segments", + "className": "insights_segments" }, "get": { - "description": "To create a comment assessment for a conversation", + "description": "To get segments for given reservation Ids", "tags": [ - "FlexV1InsightsAssessmentsComment" + "FlexV1InsightsSegments" ], "parameters": [ { @@ -2616,17 +4743,23 @@ { "name": "SegmentId", "in": "query", - "description": "The id of the segment.", + "description": "To unique id of the segment", "schema": { "type": "string" } }, { - "name": "AgentId", + "name": "ReservationId", "in": "query", - "description": "The id of the agent.", + "description": "The list of reservation Ids", "schema": { - "type": "string" + "type": "array", + "items": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^WR[0-9a-fA-F]{32}$" + } } }, { @@ -2663,12 +4796,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsAssessmentsCommentResponse", + "title": "ListInsightsSegmentsResponse", "properties": { - "comments": { + "segments": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_assessments_comment" + "$ref": "#/components/schemas/flex.v1.insights_segments" } }, "meta": { @@ -2715,13 +4848,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsAssessmentsComment", + "operationId": "ListInsightsSegments", "x-maturity": [ "Preview" ] } }, - "/v1/Insights/Conversations": { + "/v1/Insights/Session": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -2730,19 +4863,18 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "conversation_id", - "account_id", - "segment_count", - "segments" + "workspace_id", + "session_expiry", + "session_id", + "base_url" ], - "pathType": "list", - "mountName": "insights_conversations", - "className": "insights_conversations" + "pathType": "instance", + "mountName": "insights_session" }, - "get": { - "description": "To get conversation with segment id", + "post": { + "description": "To obtain session details for fetching reports and dashboards", "tags": [ - "FlexV1InsightsConversations" + "FlexV1InsightsSession" ], "parameters": [ { @@ -2752,90 +4884,69 @@ "schema": { "type": "string" } - }, - { - "name": "SegmentId", - "in": "query", - "description": "Unique Id of the segment for which conversation details needs to be fetched", - "schema": { - "type": "string" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "type": "object", - "title": "ListInsightsConversationsResponse", - "properties": { - "conversations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/flex.v1.insights_conversations" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } + "$ref": "#/components/schemas/flex.v1.insights_session" + } + } + }, + "description": "Created" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "CreateInsightsSession", + "x-maturity": [ + "Preview" + ] + } + }, + "/v1/Insights/QualityManagement/Settings/AnswerSets": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "answer_sets", + "answer_set_categories", + "not_applicable" + ], + "pathType": "list", + "mountName": "insights_settings_answer_sets", + "className": "insights_settings_answer_sets" + }, + "get": { + "description": "To get the Answer Set Settings for an Account", + "tags": [ + "FlexV1InsightsSettingsAnswerSets" + ], + "parameters": [ + { + "name": "Authorization", + "in": "header", + "description": "The Authorization HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.insights_settings_answersets" } } }, @@ -2847,13 +4958,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsConversations", + "operationId": "FetchInsightsSettingsAnswersets", "x-maturity": [ "Preview" ] } }, - "/v1/Insights/QualityManagement/Questionnaires": { + "/v1/Insights/QualityManagement/Settings/CommentTags": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -2862,18 +4973,15 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "questionnaire_sid", - "name" + "comments" ], "pathType": "list", - "mountName": "insights_questionnaires", - "className": "insights_questionnaires" + "mountName": "insights_settings_comment" }, - "post": { - "description": "To create a Questionnaire", + "get": { + "description": "To get the Comment Settings for an Account", "tags": [ - "FlexV1InsightsQuestionnaires" + "FlexV1InsightsSettingsComment" ], "parameters": [ { @@ -2886,15 +4994,15 @@ } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + "$ref": "#/components/schemas/flex.v1.insights_settings_comment" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -2902,52 +5010,31 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsQuestionnaires", + "operationId": "FetchInsightsSettingsComment", "x-maturity": [ "Preview" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "CreateInsightsQuestionnairesRequest", - "properties": { - "Name": { - "type": "string", - "description": "The name of this questionnaire" - }, - "Description": { - "type": "string", - "description": "The description of this questionnaire" - }, - "Active": { - "type": "boolean", - "description": "The flag to enable or disable questionnaire" - }, - "QuestionSids": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" - }, - "description": "The list of questions sids under a questionnaire" - } - }, - "required": [ - "Name" - ] - } - } - } + ] + } + }, + "/v1/Insights/UserRoles": { + "servers": [ + { + "url": "https://flex-api.twilio.com" } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "roles" + ], + "pathType": "instance", + "mountName": "insights_user_roles", + "className": "insights_user_roles" }, "get": { - "description": "To get all questionnaires with questions", + "description": "This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user", "tags": [ - "FlexV1InsightsQuestionnaires" + "FlexV1InsightsUserRoles" ], "parameters": [ { @@ -2957,41 +5044,6 @@ "schema": { "type": "string" } - }, - { - "name": "IncludeInactive", - "in": "query", - "description": "Flag indicating whether to include inactive questionnaires or not", - "schema": { - "type": "boolean" - } - }, - { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", - "schema": { - "type": "string" - } } ], "responses": { @@ -2999,48 +5051,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListInsightsQuestionnairesResponse", - "properties": { - "questionnaires": { - "type": "array", - "items": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } + "$ref": "#/components/schemas/flex.v1.insights_user_roles" } } }, @@ -3052,13 +5063,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnaires", + "operationId": "FetchInsightsUserRoles", "x-maturity": [ "Preview" ] } }, - "/v1/Insights/QualityManagement/Questionnaires/{QuestionnaireSid}": { + "/v1/Interactions/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -3067,51 +5078,98 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "questionnaire_sid", - "name" + "sid" ], "pathType": "instance", - "mountName": "insights_questionnaires", - "className": "insights_questionnaires" + "dependentProperties": { + "channels": { + "mapping": { + "interaction_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels" + } + }, + "mountName": "interaction" }, - "post": { - "description": "To update the questionnaire", + "get": { + "description": "", "tags": [ - "FlexV1InsightsQuestionnaires" + "FlexV1Interaction" ], "parameters": [ { - "name": "QuestionnaireSid", + "name": "Sid", "in": "path", - "description": "The SID of the questionnaire", + "description": "The SID of the Interaction resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true - }, + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.interaction" + } + } + }, + "description": "OK" + } + }, + "security": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } + "accountSid_authToken": [] + } + ], + "operationId": "FetchInteraction", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/Interactions": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "pathType": "list", + "dependentProperties": { + "channels": { + "mapping": { + "interaction_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels" } + }, + "mountName": "interaction" + }, + "post": { + "description": "Create a new Interaction.", + "tags": [ + "FlexV1Interaction" ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + "$ref": "#/components/schemas/flex.v1.interaction" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -3119,115 +5177,101 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsQuestionnaires", + "operationId": "CreateInteraction", "x-maturity": [ - "Preview" + "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsQuestionnairesRequest", + "title": "CreateInteractionRequest", "properties": { - "Active": { - "type": "boolean", - "description": "The flag to enable or disable questionnaire" + "Channel": { + "description": "The Interaction's channel." }, - "Name": { - "type": "string", - "description": "The name of this questionnaire" + "Routing": { + "description": "The Interaction's routing logic." }, - "Description": { + "InteractionContextSid": { "type": "string", - "description": "The description of this questionnaire" - }, - "QuestionSids": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" - }, - "description": "The list of questions sids under a questionnaire" + "minLength": 34, + "maxLength": 34, + "pattern": "^HQ[0-9a-fA-F]{32}$", + "description": "The Interaction context sid is used for adding a context lookup sid" } }, "required": [ - "Active" + "Channel", + "Routing" ] } } } } - }, - "delete": { - "description": "To delete the questionnaire", - "tags": [ - "FlexV1InsightsQuestionnaires" + } + }, + "/v1/Interactions/{InteractionSid}/Channels/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid" ], - "parameters": [ - { - "name": "QuestionnaireSid", - "in": "path", - "description": "The SID of the questionnaire", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$" + "pathType": "instance", + "dependentProperties": { + "invites": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" }, - "required": true + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites" }, - { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." + "participants": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants" } }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteInsightsQuestionnaires", - "x-maturity": [ - "Preview" - ] + "parent": "/Interactions/{Sid}", + "className": "interaction_channel" }, "get": { - "description": "To get the Questionnaire Detail", + "description": "Fetch a Channel for an Interaction.", "tags": [ - "FlexV1InsightsQuestionnaires" + "FlexV1InteractionChannel" ], "parameters": [ { - "name": "QuestionnaireSid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the questionnaire", + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GM[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3235,7 +5279,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" } } }, @@ -3247,53 +5291,52 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsQuestionnaires", + "operationId": "FetchInteractionChannel", "x-maturity": [ - "Preview" + "GA" ] - } - }, - "/v1/Insights/QualityManagement/Categories": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "account_sid", - "category_sid", - "name" - ], - "pathType": "list", - "mountName": "insights_questionnaires_category" }, "post": { - "description": "To create a category for Questions", + "description": "Update an existing Interaction Channel.", "tags": [ - "FlexV1InsightsQuestionnairesCategory" + "FlexV1InteractionChannel" ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" } } }, - "description": "Created" + "description": "OK" } }, "security": [ @@ -3301,43 +5344,83 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsQuestionnairesCategory", + "operationId": "UpdateInteractionChannel", "x-maturity": [ - "Preview" + "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsQuestionnairesCategoryRequest", + "title": "UpdateInteractionChannelRequest", "properties": { - "Name": { + "Status": { "type": "string", - "description": "The name of this category." + "$ref": "#/components/schemas/interaction_channel_enum_update_channel_status", + "description": "Required. Indicates the Interaction channel's status. When a channel is set to `closed`, all tasks are put in the `wrapping` state by default unless the Routing status is set to `closed` in which case the tasks will be `completed`. When a channel is set to `inactive`, it is mandatory to set the Routing status as `closed` else the request will be invalid. Value: `closed`, `inactive`" + }, + "Routing": { + "description": "It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`." } }, "required": [ - "Name" + "Status" ] } } } } + } + }, + "/v1/Interactions/{InteractionSid}/Channels": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid" + ], + "pathType": "list", + "dependentProperties": { + "invites": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites" + }, + "participants": { + "mapping": { + "interaction_sid": "interaction_sid", + "channel_sid": "sid" + }, + "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants" + } + }, + "parent": "/Interactions/{Sid}", + "className": "interaction_channel" }, "get": { - "description": "To get all the categories", + "description": "List all Channels for an Interaction.", "tags": [ - "FlexV1InsightsQuestionnairesCategory" + "FlexV1InteractionChannel" ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -3373,12 +5456,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsQuestionnairesCategoryResponse", + "title": "ListInteractionChannelResponse", "properties": { - "categories": { + "channels": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" } }, "meta": { @@ -3425,13 +5508,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesCategory", + "operationId": "ListInteractionChannel", "x-maturity": [ - "Preview" + "GA" ] } }, - "/v1/Insights/QualityManagement/Categories/{CategorySid}": { + "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -3440,50 +5523,53 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "category_sid", - "name" + "sid" ], - "pathType": "instance", - "mountName": "insights_questionnaires_category" + "pathType": "list", + "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", + "className": "interaction_channel_invite" }, "post": { - "description": "To update the category for Questions", + "description": "Invite an Agent or a TaskQueue to a Channel.", "tags": [ - "FlexV1InsightsQuestionnairesCategory" + "FlexV1InteractionChannelInvite" ], "parameters": [ { - "name": "CategorySid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the category to be updated", + "description": "The Interaction SID for this Channel.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "ChannelSid", + "in": "path", + "description": "The Channel SID for this Invite.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { - "200": { + "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_category" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" } } }, - "description": "OK" + "description": "Created" } }, "security": [ @@ -3491,60 +5577,138 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsQuestionnairesCategory", + "operationId": "CreateInteractionChannelInvite", "x-maturity": [ - "Preview" + "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsQuestionnairesCategoryRequest", + "title": "CreateInteractionChannelInviteRequest", "properties": { - "Name": { - "type": "string", - "description": "The name of this category." + "Routing": { + "description": "The Interaction's routing logic." } }, "required": [ - "Name" + "Routing" ] } } } } }, - "delete": { - "description": "", + "get": { + "description": "List all Invites for a Channel.", "tags": [ - "FlexV1InsightsQuestionnairesCategory" + "FlexV1InteractionChannelInvite" ], "parameters": [ { - "name": "CategorySid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the category to be deleted", + "description": "The Interaction SID for this Channel.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "ChannelSid", + "in": "path", + "description": "The Channel SID for this Participant.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", "schema": { "type": "string" } } ], "responses": { - "204": { - "description": "The resource was deleted successfully." + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "ListInteractionChannelInviteResponse", + "properties": { + "invites": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } + } + } + }, + "description": "OK" } }, "security": [ @@ -3552,13 +5716,13 @@ "accountSid_authToken": [] } ], - "operationId": "DeleteInsightsQuestionnairesCategory", + "operationId": "ListInteractionChannelInvite", "x-maturity": [ - "Preview" + "GA" ] } }, - "/v1/Insights/QualityManagement/Questions": { + "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -3567,26 +5731,41 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "question_sid", - "question" + "sid" ], "pathType": "list", - "mountName": "insights_questionnaires_question" + "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", + "className": "interaction_channel_participant" }, "post": { - "description": "To create a question for a Category", + "description": "Add a Participant to a Channel.", "tags": [ - "FlexV1InsightsQuestionnairesQuestion" + "FlexV1InteractionChannelParticipant" ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The Interaction Sid for the new Channel Participant.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "ChannelSid", + "in": "path", + "description": "The Channel Sid for the new Channel Participant.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3594,7 +5773,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" } } }, @@ -3606,46 +5785,32 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInsightsQuestionnairesQuestion", + "operationId": "CreateInteractionChannelParticipant", "x-maturity": [ - "Preview" + "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInsightsQuestionnairesQuestionRequest", + "title": "CreateInteractionChannelParticipantRequest", "properties": { - "CategorySid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$", - "description": "The SID of the category" - }, - "Question": { - "type": "string", - "description": "The question." - }, - "AnswerSetId": { + "Type": { "type": "string", - "description": "The answer_set for the question." + "$ref": "#/components/schemas/interaction_channel_participant_enum_type", + "description": "Participant type. Can be: `agent`, `customer`, `supervisor`, `external` or `unknown`." }, - "AllowNa": { - "type": "boolean", - "description": "The flag to enable for disable NA for answer." + "MediaProperties": { + "description": "JSON representing the Media Properties for the new Participant." }, - "Description": { - "type": "string", - "description": "The description for the question." + "RoutingProperties": { + "description": "Object representing the Routing Properties for the new Participant." } }, "required": [ - "CategorySid", - "Question", - "AnswerSetId", - "AllowNa" + "Type", + "MediaProperties" ] } } @@ -3653,32 +5818,34 @@ } }, "get": { - "description": "To get all the question for the given categories", + "description": "List all Participants for a Channel.", "tags": [ - "FlexV1InsightsQuestionnairesQuestion" + "FlexV1InteractionChannelParticipant" ], "parameters": [ { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "InteractionSid", + "in": "path", + "description": "The Interaction Sid for this channel.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^KD[0-9a-fA-F]{32}$" + }, + "required": true }, { - "name": "CategorySid", - "in": "query", - "description": "The list of category SIDs", + "name": "ChannelSid", + "in": "path", + "description": "The Channel Sid for this Participant.", "schema": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$" - } - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true }, { "name": "PageSize", @@ -3714,12 +5881,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsQuestionnairesQuestionResponse", + "title": "ListInteractionChannelParticipantResponse", "properties": { - "questions": { + "participants": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" } }, "meta": { @@ -3766,13 +5933,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsQuestionnairesQuestion", + "operationId": "ListInteractionChannelParticipant", "x-maturity": [ - "Preview" + "GA" ] } }, - "/v1/Insights/QualityManagement/Questions/{QuestionSid}": { + "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -3781,38 +5948,53 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "account_sid", - "question_sid", - "question" + "sid" ], "pathType": "instance", - "mountName": "insights_questionnaires_question" + "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", + "className": "interaction_channel_participant" }, "post": { - "description": "To update the question", + "description": "Update an existing Channel Participant.", "tags": [ - "FlexV1InsightsQuestionnairesQuestion" + "FlexV1InteractionChannelParticipant" ], "parameters": [ { - "name": "QuestionSid", + "name": "InteractionSid", "in": "path", - "description": "The SID of the question", + "description": "The Interaction Sid for this channel.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" + "pattern": "^KD[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", + "name": "ChannelSid", + "in": "path", + "description": "The Channel Sid for this Participant.", "schema": { - "type": "string" - } + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UO[0-9a-fA-F]{32}$" + }, + "required": true + }, + { + "name": "Sid", + "in": "path", + "description": "The unique string created by Twilio to identify an Interaction Channel resource.", + "schema": { + "type": "string", + "minLength": 34, + "maxLength": 34, + "pattern": "^UT[0-9a-fA-F]{32}$" + }, + "required": true } ], "responses": { @@ -3820,7 +6002,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_questionnaires_question" + "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" } } }, @@ -3832,93 +6014,33 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInsightsQuestionnairesQuestion", + "operationId": "UpdateInteractionChannelParticipant", "x-maturity": [ - "Preview" + "GA" ], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "UpdateInsightsQuestionnairesQuestionRequest", + "title": "UpdateInteractionChannelParticipantRequest", "properties": { - "AllowNa": { - "type": "boolean", - "description": "The flag to enable for disable NA for answer." - }, - "CategorySid": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^FY[0-9a-fA-F]{32}$", - "description": "The SID of the category" - }, - "Question": { - "type": "string", - "description": "The question." - }, - "Description": { - "type": "string", - "description": "The description for the question." - }, - "AnswerSetId": { + "Status": { "type": "string", - "description": "The answer_set for the question." + "$ref": "#/components/schemas/interaction_channel_participant_enum_status", + "description": "The Participant's status. Can be: `closed` or `wrapup`. Participant must be an agent." } }, "required": [ - "AllowNa" + "Status" ] } } } } - }, - "delete": { - "description": "", - "tags": [ - "FlexV1InsightsQuestionnairesQuestion" - ], - "parameters": [ - { - "name": "QuestionSid", - "in": "path", - "description": "The SID of the question", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^GE[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "Authorization", - "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "The resource was deleted successfully." - } - }, - "security": [ - { - "accountSid_authToken": [] - } - ], - "operationId": "DeleteInsightsQuestionnairesQuestion", - "x-maturity": [ - "Preview" - ] } }, - "/v1/Insights/Segments": { + "/v1/PluginService/Plugins": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -3927,52 +6049,34 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "segment_id", - "external_id", - "account_id", - "agent_id", - "queue" + "sid", + "unique_name", + "friendly_name" ], "pathType": "list", - "mountName": "insights_segments", - "className": "insights_segments" + "dependentProperties": { + "plugin_versions": { + "mapping": { + "plugin_sid": "sid" + }, + "resource_url": "/v1/PluginService/Plugins/{plugin_sid}/Versions" + } + } }, "get": { - "description": "To get segments for given reservation Ids", + "description": "", "tags": [ - "FlexV1InsightsSegments" + "FlexV1Plugin" ], "parameters": [ { - "name": "Authorization", + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", - "schema": { - "type": "string" - } - }, - { - "name": "SegmentId", - "in": "query", - "description": "To unique id of the segment", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } }, - { - "name": "ReservationId", - "in": "query", - "description": "The list of reservation Ids", - "schema": { - "type": "array", - "items": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^WR[0-9a-fA-F]{32}$" - } - } - }, { "name": "PageSize", "in": "query", @@ -4007,12 +6111,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInsightsSegmentsResponse", + "title": "ListPluginResponse", "properties": { - "segments": { + "plugins": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.insights_segments" + "$ref": "#/components/schemas/flex.v1.plugin" } }, "meta": { @@ -4059,39 +6163,21 @@ "accountSid_authToken": [] } ], - "operationId": "ListInsightsSegments", + "operationId": "ListPlugin", "x-maturity": [ - "Preview" + "GA" ] - } - }, - "/v1/Insights/Session": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "workspace_id", - "session_expiry", - "session_id", - "base_url" - ], - "pathType": "instance", - "mountName": "insights_session" }, "post": { - "description": "To obtain session details for fetching reports and dashboards", + "description": "", "tags": [ - "FlexV1InsightsSession" + "FlexV1Plugin" ], "parameters": [ { - "name": "Authorization", + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4102,7 +6188,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_session" + "$ref": "#/components/schemas/flex.v1.plugin" } } }, @@ -4113,14 +6199,41 @@ { "accountSid_authToken": [] } - ], - "operationId": "CreateInsightsSession", - "x-maturity": [ - "Preview" - ] + ], + "operationId": "CreatePlugin", + "x-maturity": [ + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "CreatePluginRequest", + "properties": { + "UniqueName": { + "type": "string", + "description": "The Flex Plugin's unique name." + }, + "FriendlyName": { + "type": "string", + "description": "The Flex Plugin's friendly name." + }, + "Description": { + "type": "string", + "description": "A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long" + } + }, + "required": [ + "UniqueName" + ] + } + } + } + } } }, - "/v1/Insights/QualityManagement/Settings/AnswerSets": { + "/v1/PluginService/Plugins/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -4129,24 +6242,39 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "answer_sets", - "answer_set_categories", - "not_applicable" + "sid", + "unique_name", + "friendly_name" ], - "pathType": "list", - "mountName": "insights_settings_answer_sets", - "className": "insights_settings_answer_sets" + "pathType": "instance", + "dependentProperties": { + "plugin_versions": { + "mapping": { + "plugin_sid": "sid" + }, + "resource_url": "/v1/PluginService/Plugins/{plugin_sid}/Versions" + } + } }, "get": { - "description": "To get the Answer Set Settings for an Account", + "description": "", "tags": [ - "FlexV1InsightsSettingsAnswerSets" + "FlexV1Plugin" ], "parameters": [ { - "name": "Authorization", + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4157,7 +6285,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_settings_answersets" + "$ref": "#/components/schemas/flex.v1.plugin" } } }, @@ -4169,36 +6297,30 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsAnswersets", + "operationId": "FetchPlugin", "x-maturity": [ - "Preview" + "GA" ] - } - }, - "/v1/Insights/QualityManagement/Settings/CommentTags": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "comments" - ], - "pathType": "list", - "mountName": "insights_settings_comment" }, - "get": { - "description": "To get the Comment Settings for an Account", + "post": { + "description": "", "tags": [ - "FlexV1InsightsSettingsComment" + "FlexV1Plugin" ], "parameters": [ { - "name": "Authorization", + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin resource to update.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4209,7 +6331,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_settings_comment" + "$ref": "#/components/schemas/flex.v1.plugin" } } }, @@ -4221,13 +6343,33 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsSettingsComment", + "operationId": "UpdatePlugin", "x-maturity": [ - "Preview" - ] + "GA" + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "schema": { + "type": "object", + "title": "UpdatePluginRequest", + "properties": { + "FriendlyName": { + "type": "string", + "description": "The Flex Plugin's friendly name." + }, + "Description": { + "type": "string", + "description": "A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long" + } + } + } + } + } + } } }, - "/v1/Insights/UserRoles": { + "/v1/PluginService/Plugins/{Sid}/Archive": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -4236,22 +6378,32 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "roles" + "sid", + "unique_name", + "friendly_name" ], "pathType": "instance", - "mountName": "insights_user_roles", - "className": "insights_user_roles" + "mountName": "plugin_archive" }, - "get": { - "description": "This is used by Flex UI and Quality Management to fetch the Flex Insights roles for the user", + "post": { + "description": "", "tags": [ - "FlexV1InsightsUserRoles" + "FlexV1PluginArchive" ], "parameters": [ { - "name": "Authorization", + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin resource to archive.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", "in": "header", - "description": "The Authorization HTTP request header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -4262,7 +6414,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.insights_user_roles" + "$ref": "#/components/schemas/flex.v1.plugin_archive" } } }, @@ -4274,13 +6426,13 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInsightsUserRoles", + "operationId": "UpdatePluginArchive", "x-maturity": [ - "Preview" + "GA" ] } }, - "/v1/Interactions/{Sid}": { + "/v1/PluginService/Configurations": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -4289,36 +6441,61 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "name", + "description" ], - "pathType": "instance", + "pathType": "list", "dependentProperties": { - "channels": { + "plugins": { "mapping": { - "interaction_sid": "sid" + "configuration_sid": "sid" }, - "resource_url": "/v1/Interactions/{interaction_sid}/Channels" + "resource_url": "/v1/PluginService/Configurations/{configuration_sid}/Plugins" } }, - "mountName": "interaction" + "mountName": "plugin_configurations" }, "get": { "description": "", "tags": [ - "FlexV1Interaction" + "FlexV1PluginConfiguration" ], "parameters": [ { - "name": "Sid", - "in": "path", - "description": "The SID of the Interaction resource to fetch.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } + }, + { + "name": "PageSize", + "in": "query", + "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + }, + { + "name": "Page", + "in": "query", + "description": "The page index. This value is simply for client state.", + "schema": { + "type": "integer", + "minimum": 0 + } + }, + { + "name": "PageToken", + "in": "query", + "description": "The page token. This is provided by the API.", + "schema": { + "type": "string" + } } ], "responses": { @@ -4326,7 +6503,48 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction" + "type": "object", + "title": "ListPluginConfigurationResponse", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/flex.v1.plugin_configuration" + } + }, + "meta": { + "type": "object", + "properties": { + "first_page_url": { + "type": "string", + "format": "uri" + }, + "next_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "page": { + "type": "integer" + }, + "page_size": { + "type": "integer" + }, + "previous_page_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "key": { + "type": "string" + } + } + } + } } } }, @@ -4338,45 +6556,32 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteraction", + "operationId": "ListPluginConfiguration", "x-maturity": [ "GA" ] - } - }, - "/v1/Interactions": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "dependentProperties": { - "channels": { - "mapping": { - "interaction_sid": "sid" - }, - "resource_url": "/v1/Interactions/{interaction_sid}/Channels" - } - }, - "mountName": "interaction" }, "post": { - "description": "Create a new Interaction.", + "description": "", "tags": [ - "FlexV1Interaction" + "FlexV1PluginConfiguration" + ], + "parameters": [ + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + } ], "responses": { "201": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction" + "$ref": "#/components/schemas/flex.v1.plugin_configuration" } } }, @@ -4388,7 +6593,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInteraction", + "operationId": "CreatePluginConfiguration", "x-maturity": [ "GA" ], @@ -4397,25 +6602,24 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInteractionRequest", + "title": "CreatePluginConfigurationRequest", "properties": { - "Channel": { - "description": "The Interaction's channel." + "Name": { + "type": "string", + "description": "The Flex Plugin Configuration's name." }, - "Routing": { - "description": "The Interaction's routing logic." + "Plugins": { + "type": "array", + "items": {}, + "description": "A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version." }, - "InteractionContextSid": { + "Description": { "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^HQ[0-9a-fA-F]{32}$", - "description": "The Interaction context sid is used for adding a context lookup sid" + "description": "The Flex Plugin Configuration's description." } }, "required": [ - "Channel", - "Routing" + "Name" ] } } @@ -4423,7 +6627,7 @@ } } }, - "/v1/Interactions/{InteractionSid}/Channels/{Sid}": { + "/v1/PluginService/Configurations/{Sid}": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -4432,57 +6636,46 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "name", + "description" ], "pathType": "instance", "dependentProperties": { - "invites": { - "mapping": { - "interaction_sid": "interaction_sid", - "channel_sid": "sid" - }, - "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites" - }, - "participants": { + "plugins": { "mapping": { - "interaction_sid": "interaction_sid", - "channel_sid": "sid" + "configuration_sid": "sid" }, - "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants" + "resource_url": "/v1/PluginService/Configurations/{configuration_sid}/Plugins" } }, - "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "mountName": "plugin_configurations" }, "get": { - "description": "Fetch a Channel for an Interaction.", + "description": "", "tags": [ - "FlexV1InteractionChannel" + "FlexV1PluginConfiguration" ], "parameters": [ { - "name": "InteractionSid", + "name": "Sid", "in": "path", - "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "description": "The SID of the Flex Plugin Configuration resource to fetch.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "pattern": "^FJ[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4490,7 +6683,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + "$ref": "#/components/schemas/flex.v1.plugin_configuration" } } }, @@ -4502,40 +6695,53 @@ "accountSid_authToken": [] } ], - "operationId": "FetchInteractionChannel", + "operationId": "FetchPluginConfiguration", "x-maturity": [ "GA" ] + } + }, + "/v1/PluginService/Configurations/{Sid}/Archive": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "name", + "description" + ], + "pathType": "instance", + "mountName": "plugin_configuration_archive" }, "post": { - "description": "Update an existing Interaction Channel.", + "description": "", "tags": [ - "FlexV1InteractionChannel" + "FlexV1PluginConfigurationArchive" ], "parameters": [ { - "name": "InteractionSid", + "name": "Sid", "in": "path", - "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "description": "The SID of the Flex Plugin Configuration resource to archive.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "pattern": "^FJ[0-9a-fA-F]{32}$" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4543,7 +6749,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + "$ref": "#/components/schemas/flex.v1.plugin_configuration_archive" } } }, @@ -4555,36 +6761,13 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInteractionChannel", + "operationId": "UpdatePluginConfigurationArchive", "x-maturity": [ "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateInteractionChannelRequest", - "properties": { - "Status": { - "type": "string", - "$ref": "#/components/schemas/interaction_channel_enum_update_channel_status", - "description": "Required. Indicates the Interaction channel's status. When a channel is set to `closed`, all tasks are put in the `wrapping` state by default unless the Routing status is set to `closed` in which case the tasks will be `completed`. When a channel is set to `inactive`, it is mandatory to set the Routing status as `closed` else the request will be invalid. Value: `closed`, `inactive`" - }, - "Routing": { - "description": "It changes the state of associated tasks. Routing status is required, When the channel status is set to `inactive`. Allowed Value for routing status is `closed`. Otherwise Optional, if not specified, all tasks will be set to `wrapping`." - } - }, - "required": [ - "Status" - ] - } - } - } - } + ] } }, - "/v1/Interactions/{InteractionSid}/Channels": { + "/v1/PluginService/Releases": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -4593,45 +6776,26 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "configuration_sid", + "date_created" ], "pathType": "list", - "dependentProperties": { - "invites": { - "mapping": { - "interaction_sid": "interaction_sid", - "channel_sid": "sid" - }, - "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Invites" - }, - "participants": { - "mapping": { - "interaction_sid": "interaction_sid", - "channel_sid": "sid" - }, - "resource_url": "/v1/Interactions/{interaction_sid}/Channels/{channel_sid}/Participants" - } - }, - "parent": "/Interactions/{Sid}", - "className": "interaction_channel" + "mountName": "plugin_releases" }, "get": { - "description": "List all Channels for an Interaction.", + "description": "", "tags": [ - "FlexV1InteractionChannel" + "FlexV1PluginRelease" ], "parameters": [ { - "name": "InteractionSid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction resource, prefixed with KD.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } }, { "name": "PageSize", @@ -4667,12 +6831,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInteractionChannelResponse", + "title": "ListPluginReleaseResponse", "properties": { - "channels": { + "releases": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel" + "$ref": "#/components/schemas/flex.v1.plugin_release" } }, "meta": { @@ -4719,56 +6883,24 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannel", + "operationId": "ListPluginRelease", "x-maturity": [ "GA" ] - } - }, - "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Invites": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_invite" }, "post": { - "description": "Invite an Agent or a TaskQueue to a Channel.", + "description": "", "tags": [ - "FlexV1InteractionChannelInvite" + "FlexV1PluginRelease" ], "parameters": [ { - "name": "InteractionSid", - "in": "path", - "description": "The Interaction SID for this Channel.", - "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" - }, - "required": true - }, - { - "name": "ChannelSid", - "in": "path", - "description": "The Channel SID for this Invite.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4776,7 +6908,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + "$ref": "#/components/schemas/flex.v1.plugin_release" } } }, @@ -4788,7 +6920,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInteractionChannelInvite", + "operationId": "CreatePluginRelease", "x-maturity": [ "GA" ], @@ -4797,49 +6929,125 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInteractionChannelInviteRequest", + "title": "CreatePluginReleaseRequest", "properties": { - "Routing": { - "description": "The Interaction's routing logic." + "ConfigurationId": { + "type": "string", + "description": "The SID or the Version of the Flex Plugin Configuration to release." } }, "required": [ - "Routing" + "ConfigurationId" ] } } } } + } + }, + "/v1/PluginService/Releases/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "configuration_sid", + "date_created" + ], + "pathType": "instance", + "mountName": "plugin_releases" + }, + "get": { + "description": "", + "tags": [ + "FlexV1PluginRelease" + ], + "parameters": [ + { + "name": "Sid", + "in": "path", + "description": "The SID of the Flex Plugin Release resource to fetch.", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flex.v1.plugin_release" + } + } + }, + "description": "OK" + } + }, + "security": [ + { + "accountSid_authToken": [] + } + ], + "operationId": "FetchPluginRelease", + "x-maturity": [ + "GA" + ] + } + }, + "/v1/PluginService/Plugins/{PluginSid}/Versions": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "plugin_sid", + "version" + ], + "pathType": "list", + "parent": "/PluginService/Plugins/{Sid}", + "mountName": "plugin_versions", + "className": "plugin_versions" }, "get": { - "description": "List all Invites for a Channel.", + "description": "", "tags": [ - "FlexV1InteractionChannelInvite" + "FlexV1PluginVersions" ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction SID for this Channel.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", - "in": "path", - "description": "The Channel SID for this Participant.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } }, { "name": "PageSize", @@ -4875,12 +7083,12 @@ "application/json": { "schema": { "type": "object", - "title": "ListInteractionChannelInviteResponse", + "title": "ListPluginVersionResponse", "properties": { - "invites": { + "plugin_versions": { "type": "array", "items": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_invite" + "$ref": "#/components/schemas/flex.v1.plugin.plugin_version" } }, "meta": { @@ -4927,56 +7135,33 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelInvite", + "operationId": "ListPluginVersion", "x-maturity": [ "GA" ] - } - }, - "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants": { - "servers": [ - { - "url": "https://flex-api.twilio.com" - } - ], - "description": "TODO: Resource-level docs", - "x-twilio": { - "defaultOutputProperties": [ - "sid" - ], - "pathType": "list", - "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_participant" }, "post": { - "description": "Add a Participant to a Channel.", + "description": "", "tags": [ - "FlexV1InteractionChannelParticipant" + "FlexV1PluginVersions" ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction Sid for the new Channel Participant.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", - "in": "path", - "description": "The Channel Sid for the new Channel Participant.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -4984,7 +7169,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" + "$ref": "#/components/schemas/flex.v1.plugin.plugin_version" } } }, @@ -4996,7 +7181,7 @@ "accountSid_authToken": [] } ], - "operationId": "CreateInteractionChannelParticipant", + "operationId": "CreatePluginVersion", "x-maturity": [ "GA" ], @@ -5005,82 +7190,82 @@ "application/x-www-form-urlencoded": { "schema": { "type": "object", - "title": "CreateInteractionChannelParticipantRequest", + "title": "CreatePluginVersionRequest", "properties": { - "Type": { + "Version": { "type": "string", - "$ref": "#/components/schemas/interaction_channel_participant_enum_type", - "description": "Participant type. Can be: `agent`, `customer`, `supervisor`, `external` or `unknown`." + "description": "The Flex Plugin Version's version." }, - "MediaProperties": { - "description": "JSON representing the Media Properties for the new Participant." + "PluginUrl": { + "type": "string", + "format": "uri", + "description": "The URL of the Flex Plugin Version bundle" }, - "RoutingProperties": { - "description": "Object representing the Routing Properties for the new Participant." + "Changelog": { + "type": "string", + "description": "The changelog of the Flex Plugin Version." + }, + "Private": { + "type": "boolean", + "description": "Whether this Flex Plugin Version requires authorization." } }, "required": [ - "Type", - "MediaProperties" + "Version", + "PluginUrl" ] } } } } + } + }, + "/v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}": { + "servers": [ + { + "url": "https://flex-api.twilio.com" + } + ], + "description": "TODO: Resource-level docs", + "x-twilio": { + "defaultOutputProperties": [ + "sid", + "plugin_sid", + "version" + ], + "pathType": "instance", + "parent": "/PluginService/Plugins/{Sid}", + "mountName": "plugin_versions", + "className": "plugin_versions" }, "get": { - "description": "List all Participants for a Channel.", + "description": "", "tags": [ - "FlexV1InteractionChannelParticipant" + "FlexV1PluginVersions" ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction Sid for this channel.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", + "name": "Sid", "in": "path", - "description": "The Channel Sid for this Participant.", + "description": "The SID of the Flex Plugin Version resource to fetch.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "PageSize", - "in": "query", - "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.", - "schema": { - "type": "integer", - "minimum": 1, - "maximum": 1000 - } - }, - { - "name": "Page", - "in": "query", - "description": "The page index. This value is simply for client state.", - "schema": { - "type": "integer", - "minimum": 0 - } - }, - { - "name": "PageToken", - "in": "query", - "description": "The page token. This is provided by the API.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { "type": "string" } @@ -5091,48 +7276,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "title": "ListInteractionChannelParticipantResponse", - "properties": { - "participants": { - "type": "array", - "items": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" - } - }, - "meta": { - "type": "object", - "properties": { - "first_page_url": { - "type": "string", - "format": "uri" - }, - "next_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "page": { - "type": "integer" - }, - "page_size": { - "type": "integer" - }, - "previous_page_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri" - }, - "key": { - "type": "string" - } - } - } - } + "$ref": "#/components/schemas/flex.v1.plugin.plugin_version" } } }, @@ -5144,13 +7288,13 @@ "accountSid_authToken": [] } ], - "operationId": "ListInteractionChannelParticipant", + "operationId": "FetchPluginVersion", "x-maturity": [ "GA" ] } }, - "/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants/{Sid}": { + "/v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive": { "servers": [ { "url": "https://flex-api.twilio.com" @@ -5159,53 +7303,44 @@ "description": "TODO: Resource-level docs", "x-twilio": { "defaultOutputProperties": [ - "sid" + "sid", + "plugin_sid", + "version" ], "pathType": "instance", - "parent": "/Interactions/{InteractionSid}/Channels/{Sid}", - "className": "interaction_channel_participant" + "mountName": "plugin_version_archive" }, "post": { - "description": "Update an existing Channel Participant.", + "description": "", "tags": [ - "FlexV1InteractionChannelParticipant" + "FlexV1PluginVersionArchive" ], "parameters": [ { - "name": "InteractionSid", + "name": "PluginSid", "in": "path", - "description": "The Interaction Sid for this channel.", + "description": "The SID of the Flex Plugin the resource to belongs to.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^KD[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "ChannelSid", + "name": "Sid", "in": "path", - "description": "The Channel Sid for this Participant.", + "description": "The SID of the Flex Plugin Version resource to archive.", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UO[0-9a-fA-F]{32}$" + "type": "string" }, "required": true }, { - "name": "Sid", - "in": "path", - "description": "The unique string created by Twilio to identify an Interaction Channel resource.", + "name": "Flex-Metadata", + "in": "header", + "description": "The Flex-Metadata HTTP request header", "schema": { - "type": "string", - "minLength": 34, - "maxLength": 34, - "pattern": "^UT[0-9a-fA-F]{32}$" - }, - "required": true + "type": "string" + } } ], "responses": { @@ -5213,7 +7348,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flex.v1.interaction.interaction_channel.interaction_channel_participant" + "$ref": "#/components/schemas/flex.v1.plugin_version_archive" } } }, @@ -5225,30 +7360,10 @@ "accountSid_authToken": [] } ], - "operationId": "UpdateInteractionChannelParticipant", + "operationId": "UpdatePluginVersionArchive", "x-maturity": [ "GA" - ], - "requestBody": { - "content": { - "application/x-www-form-urlencoded": { - "schema": { - "type": "object", - "title": "UpdateInteractionChannelParticipantRequest", - "properties": { - "Status": { - "type": "string", - "$ref": "#/components/schemas/interaction_channel_participant_enum_status", - "description": "The Participant's status. Can be: `closed` or `wrapup`. Participant must be an agent." - } - }, - "required": [ - "Status" - ] - } - } - } - } + ] } }, "/v1/account/provision/status": { @@ -5647,6 +7762,9 @@ { "name": "FlexV1Configuration" }, + { + "name": "FlexV1ConfiguredPlugin" + }, { "name": "FlexV1FlexFlow" }, @@ -5692,6 +7810,27 @@ { "name": "FlexV1InteractionChannelParticipant" }, + { + "name": "FlexV1Plugin" + }, + { + "name": "FlexV1PluginArchive" + }, + { + "name": "FlexV1PluginConfiguration" + }, + { + "name": "FlexV1PluginConfigurationArchive" + }, + { + "name": "FlexV1PluginRelease" + }, + { + "name": "FlexV1PluginVersionArchive" + }, + { + "name": "FlexV1PluginVersions" + }, { "name": "FlexV1ProvisioningStatus" }, diff --git a/spec/json/twilio_flex_v2.json b/spec/json/twilio_flex_v2.json index e42346fd..1d947af4 100644 --- a/spec/json/twilio_flex_v2.json +++ b/spec/json/twilio_flex_v2.json @@ -40,7 +40,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_frontline_v1.json b/spec/json/twilio_frontline_v1.json index 0e8dd130..e1a8bd20 100644 --- a/spec/json/twilio_frontline_v1.json +++ b/spec/json/twilio_frontline_v1.json @@ -86,7 +86,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_insights_v1.json b/spec/json/twilio_insights_v1.json index a419a762..a2d48cb7 100644 --- a/spec/json/twilio_insights_v1.json +++ b/spec/json/twilio_insights_v1.json @@ -1549,7 +1549,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_intelligence_v2.json b/spec/json/twilio_intelligence_v2.json index bdbeb351..0967e615 100644 --- a/spec/json/twilio_intelligence_v2.json +++ b/spec/json/twilio_intelligence_v2.json @@ -413,7 +413,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v1.json b/spec/json/twilio_ip_messaging_v1.json index 6d8f9fac..038583e7 100644 --- a/spec/json/twilio_ip_messaging_v1.json +++ b/spec/json/twilio_ip_messaging_v1.json @@ -680,7 +680,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_ip_messaging_v2.json b/spec/json/twilio_ip_messaging_v2.json index 4e9e3c1b..c8d0e68f 100644 --- a/spec/json/twilio_ip_messaging_v2.json +++ b/spec/json/twilio_ip_messaging_v2.json @@ -989,7 +989,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_lookups_v1.json b/spec/json/twilio_lookups_v1.json index 55329e17..e71c73a7 100644 --- a/spec/json/twilio_lookups_v1.json +++ b/spec/json/twilio_lookups_v1.json @@ -99,7 +99,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { @@ -130,8 +130,7 @@ "in": "path", "description": "The phone number to lookup in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.", "schema": { - "type": "string", - "format": "phone-number" + "type": "string" }, "x-twilio": { "pii": { diff --git a/spec/json/twilio_lookups_v2.json b/spec/json/twilio_lookups_v2.json index 74ec9a96..bcf69d62 100644 --- a/spec/json/twilio_lookups_v2.json +++ b/spec/json/twilio_lookups_v2.json @@ -147,7 +147,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_media_v1.json b/spec/json/twilio_media_v1.json index 3c29a7cc..9976ef3f 100644 --- a/spec/json/twilio_media_v1.json +++ b/spec/json/twilio_media_v1.json @@ -421,7 +421,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_messaging_v1.json b/spec/json/twilio_messaging_v1.json index 8ba2e67a..c431b698 100644 --- a/spec/json/twilio_messaging_v1.json +++ b/spec/json/twilio_messaging_v1.json @@ -148,7 +148,13 @@ "failure_reason": { "type": "string", "nullable": true, - "description": "A reason why brand registration has failed. Only applicable when status is FAILED." + "description": "DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED." + }, + "errors": { + "type": "array", + "items": {}, + "nullable": true, + "description": "A list of errors that occurred during the brand registration process." }, "url": { "type": "string", @@ -168,7 +174,7 @@ "$ref": "#/components/schemas/brand_registrations_enum_brand_feedback" }, "nullable": true, - "description": "Feedback on how to improve brand score" + "description": "DEPRECATED. Feedback on how to improve brand score" }, "identity_status": { "type": "string", @@ -1399,7 +1405,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_microvisor_v1.json b/spec/json/twilio_microvisor_v1.json index b3fd25c2..5347a507 100644 --- a/spec/json/twilio_microvisor_v1.json +++ b/spec/json/twilio_microvisor_v1.json @@ -273,7 +273,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_monitor_v1.json b/spec/json/twilio_monitor_v1.json index 387f5db8..a5e343f5 100644 --- a/spec/json/twilio_monitor_v1.json +++ b/spec/json/twilio_monitor_v1.json @@ -341,7 +341,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_notify_v1.json b/spec/json/twilio_notify_v1.json index 4d495762..ec9a39d9 100644 --- a/spec/json/twilio_notify_v1.json +++ b/spec/json/twilio_notify_v1.json @@ -478,7 +478,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_numbers_v1.json b/spec/json/twilio_numbers_v1.json index eb269951..be6baee1 100644 --- a/spec/json/twilio_numbers_v1.json +++ b/spec/json/twilio_numbers_v1.json @@ -329,7 +329,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { @@ -562,7 +562,7 @@ "port_in_request_sid" ], "pathType": "instance", - "mountName": "porting_port_ins", + "mountName": "porting_port_ins_fetch", "className": "porting_port_in_fetch" }, "get": { diff --git a/spec/json/twilio_numbers_v2.json b/spec/json/twilio_numbers_v2.json index ed663b44..2df5d083 100644 --- a/spec/json/twilio_numbers_v2.json +++ b/spec/json/twilio_numbers_v2.json @@ -1214,7 +1214,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_preview.json b/spec/json/twilio_preview.json index 8796045a..5b68b80b 100644 --- a/spec/json/twilio_preview.json +++ b/spec/json/twilio_preview.json @@ -1904,7 +1904,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v1.json b/spec/json/twilio_pricing_v1.json index 0240fb05..cbf39ee3 100644 --- a/spec/json/twilio_pricing_v1.json +++ b/spec/json/twilio_pricing_v1.json @@ -417,7 +417,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_pricing_v2.json b/spec/json/twilio_pricing_v2.json index a4abecf5..e291cc2c 100644 --- a/spec/json/twilio_pricing_v2.json +++ b/spec/json/twilio_pricing_v2.json @@ -416,7 +416,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_proxy_v1.json b/spec/json/twilio_proxy_v1.json index 2106bb49..2d2ec162 100644 --- a/spec/json/twilio_proxy_v1.json +++ b/spec/json/twilio_proxy_v1.json @@ -876,7 +876,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_routes_v2.json b/spec/json/twilio_routes_v2.json index 138a3265..a4724631 100644 --- a/spec/json/twilio_routes_v2.json +++ b/spec/json/twilio_routes_v2.json @@ -176,7 +176,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_serverless_v1.json b/spec/json/twilio_serverless_v1.json index 3da14fe7..fed0c333 100644 --- a/spec/json/twilio_serverless_v1.json +++ b/spec/json/twilio_serverless_v1.json @@ -916,7 +916,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v1.json b/spec/json/twilio_studio_v1.json index ba9f2947..6772c301 100644 --- a/spec/json/twilio_studio_v1.json +++ b/spec/json/twilio_studio_v1.json @@ -630,7 +630,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_studio_v2.json b/spec/json/twilio_studio_v2.json index edcd6f2c..c26cc80d 100644 --- a/spec/json/twilio_studio_v2.json +++ b/spec/json/twilio_studio_v2.json @@ -518,7 +518,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_supersim_v1.json b/spec/json/twilio_supersim_v1.json index d7862dcb..9b255479 100644 --- a/spec/json/twilio_supersim_v1.json +++ b/spec/json/twilio_supersim_v1.json @@ -920,7 +920,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_sync_v1.json b/spec/json/twilio_sync_v1.json index 264b4496..374b5914 100644 --- a/spec/json/twilio_sync_v1.json +++ b/spec/json/twilio_sync_v1.json @@ -871,7 +871,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_taskrouter_v1.json b/spec/json/twilio_taskrouter_v1.json index d37009c4..03b8f380 100644 --- a/spec/json/twilio_taskrouter_v1.json +++ b/spec/json/twilio_taskrouter_v1.json @@ -2117,7 +2117,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trunking_v1.json b/spec/json/twilio_trunking_v1.json index 561b3feb..eb60d0ed 100644 --- a/spec/json/twilio_trunking_v1.json +++ b/spec/json/twilio_trunking_v1.json @@ -596,7 +596,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_trusthub_v1.json b/spec/json/twilio_trusthub_v1.json index 919912bb..14bf3131 100644 --- a/spec/json/twilio_trusthub_v1.json +++ b/spec/json/twilio_trusthub_v1.json @@ -932,7 +932,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { @@ -1282,6 +1282,14 @@ "IsIsvEmbed": { "type": "boolean", "description": "Indicates if the inquiry is being started from an ISV embedded component." + }, + "IsvRegisteringForSelfOrTenant": { + "type": "string", + "description": "Indicates if the isv registering for self or tenant." + }, + "StatusCallbackUrl": { + "type": "string", + "description": "The url we call to inform you of bundle changes." } }, "required": [ diff --git a/spec/json/twilio_verify_v2.json b/spec/json/twilio_verify_v2.json index d646e78c..d95f95d1 100644 --- a/spec/json/twilio_verify_v2.json +++ b/spec/json/twilio_verify_v2.json @@ -1568,7 +1568,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_video_v1.json b/spec/json/twilio_video_v1.json index 42c4782e..681cc934 100644 --- a/spec/json/twilio_video_v1.json +++ b/spec/json/twilio_video_v1.json @@ -1360,7 +1360,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_voice_v1.json b/spec/json/twilio_voice_v1.json index 4f313460..594bd943 100644 --- a/spec/json/twilio_voice_v1.json +++ b/spec/json/twilio_voice_v1.json @@ -583,7 +583,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/json/twilio_wireless_v1.json b/spec/json/twilio_wireless_v1.json index d61b01c3..4dec917e 100644 --- a/spec/json/twilio_wireless_v1.json +++ b/spec/json/twilio_wireless_v1.json @@ -632,7 +632,7 @@ "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, - "version": "1.55.0" + "version": "1.55.1" }, "openapi": "3.0.1", "paths": { diff --git a/spec/yaml/twilio_accounts_v1.yaml b/spec/yaml/twilio_accounts_v1.yaml index b3391fbe..7eeecd4b 100644 --- a/spec/yaml/twilio_accounts_v1.yaml +++ b/spec/yaml/twilio_accounts_v1.yaml @@ -198,7 +198,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/AuthTokens/Promote: diff --git a/spec/yaml/twilio_api_v2010.yaml b/spec/yaml/twilio_api_v2010.yaml index 3b93c2cc..ce8b0361 100644 --- a/spec/yaml/twilio_api_v2010.yaml +++ b/spec/yaml/twilio_api_v2010.yaml @@ -9263,7 +9263,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: @@ -18549,17 +18549,15 @@ paths: maxLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ description: The SID of the associated [TwiML Application](https://www.twilio.com/docs/usage/api/applications). - If this parameter is provided, the `status_callback` parameter - of this request is ignored; [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) - are sent to the TwiML App's `message_status_callback` URL. + [Message status callback requests](https://www.twilio.com/docs/sms/api/message-resource#twilios-request-to-the-statuscallback-url) + are sent to the TwiML App's `message_status_callback` URL. Note + that the `status_callback` parameter of a request takes priority + over the `application_sid` parameter; if both are included `application_sid` + is ignored. MaxPrice: type: number - description: The maximum price in US dollars that you are willing - to pay for this Message's delivery. The value can have up to four - decimal places. When the `max_price` parameter is provided, the - cost of a message is checked before it is sent. If the cost exceeds - `max_price`, the message is not sent and the Message `status` - is `failed`. + description: '[DEPRECATED] This parameter will no longer have any + effect as of 2024-06-03.' ProvideFeedback: type: boolean description: Boolean indicating whether or not you intend to provide diff --git a/spec/yaml/twilio_bulkexports_v1.yaml b/spec/yaml/twilio_bulkexports_v1.yaml index 6928d2b3..59a74407 100644 --- a/spec/yaml/twilio_bulkexports_v1.yaml +++ b/spec/yaml/twilio_bulkexports_v1.yaml @@ -246,7 +246,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Exports/{ResourceType}/Days/{Day}: diff --git a/spec/yaml/twilio_chat_v1.yaml b/spec/yaml/twilio_chat_v1.yaml index 8dd1f0f3..97b17ea9 100644 --- a/spec/yaml/twilio_chat_v1.yaml +++ b/spec/yaml/twilio_chat_v1.yaml @@ -831,7 +831,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: diff --git a/spec/yaml/twilio_chat_v2.yaml b/spec/yaml/twilio_chat_v2.yaml index 580fee44..c3379e94 100644 --- a/spec/yaml/twilio_chat_v2.yaml +++ b/spec/yaml/twilio_chat_v2.yaml @@ -1200,7 +1200,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: diff --git a/spec/yaml/twilio_chat_v3.yaml b/spec/yaml/twilio_chat_v3.yaml index b69f7a42..568e5c01 100644 --- a/spec/yaml/twilio_chat_v3.yaml +++ b/spec/yaml/twilio_chat_v3.yaml @@ -125,7 +125,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v3/Services/{ServiceSid}/Channels/{Sid}: diff --git a/spec/yaml/twilio_content_v1.yaml b/spec/yaml/twilio_content_v1.yaml index a802dd31..f8031d1e 100644 --- a/spec/yaml/twilio_content_v1.yaml +++ b/spec/yaml/twilio_content_v1.yaml @@ -222,7 +222,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Content/{Sid}/ApprovalRequests: diff --git a/spec/yaml/twilio_conversations_v1.yaml b/spec/yaml/twilio_conversations_v1.yaml index 2cd22806..62ddea6d 100644 --- a/spec/yaml/twilio_conversations_v1.yaml +++ b/spec/yaml/twilio_conversations_v1.yaml @@ -2390,7 +2390,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Configuration: diff --git a/spec/yaml/twilio_events_v1.yaml b/spec/yaml/twilio_events_v1.yaml index 86b7edfc..a31241b2 100644 --- a/spec/yaml/twilio_events_v1.yaml +++ b/spec/yaml/twilio_events_v1.yaml @@ -267,7 +267,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Types: diff --git a/spec/yaml/twilio_flex_v1.yaml b/spec/yaml/twilio_flex_v1.yaml index 0f1452c0..c9609b8d 100644 --- a/spec/yaml/twilio_flex_v1.yaml +++ b/spec/yaml/twilio_flex_v1.yaml @@ -301,6 +301,103 @@ components: - ok - inprogress - notstarted + flex.v1.plugin_configuration.configured_plugin: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that the Flex Plugin resource is installed for. + configuration_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin Configuration that this Flex Plugin + belongs to. + plugin_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin. + plugin_version_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FV[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin Version. + phase: + type: integer + nullable: true + description: The phase this Flex Plugin would initialize at runtime. + plugin_url: + type: string + nullable: true + description: The URL of where the Flex Plugin Version JavaScript bundle + is hosted on. + x-twilio: + pii: + handling: standard + deleteSla: 30 + unique_name: + type: string + nullable: true + description: The name that uniquely identifies this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + friendly_name: + type: string + nullable: true + description: The friendly name of this Flex Plugin resource. + description: + type: string + nullable: true + description: A descriptive string that you create to describe the plugin + resource. It can be up to 500 characters long + plugin_archived: + type: boolean + nullable: true + description: Whether the Flex Plugin is archived. The default value is false. + version: + type: string + nullable: true + description: The latest version of this Flex Plugin Version. + changelog: + type: string + nullable: true + description: A changelog that describes the changes this Flex Plugin Version + brings. + plugin_version_archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Version is archived. The default value + is false. + private: + type: boolean + nullable: true + description: Whether to validate the request is authorized to access the + Flex Plugin Version. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin was installed + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin resource. flex.v1.flex_flow: type: object properties: @@ -1042,29 +1139,86 @@ components: - external - agent - unknown - flex.v1.provisioning_status: + flex.v1.plugin: type: object properties: - status: + sid: type: string - $ref: '#/components/schemas/provisioning_status_enum_status' + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ nullable: true - description: Email Provisioning Status + description: The unique string that we created to identify the Flex Plugin + resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Plugin resource and owns this resource. + unique_name: + type: string + nullable: true + description: The name that uniquely identifies this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + friendly_name: + type: string + nullable: true + description: The friendly name this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + description: + type: string + nullable: true + description: A descriptive string that you create to describe the plugin + resource. It can be up to 500 characters long + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin is archived. The default value is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT-7 when the Flex Plugin was created + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT-7 when the Flex Plugin was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true - description: The absolute URL of the resource. - provisioning_status_enum_status: - type: string - enum: - - active - - in-progress - - not-configured - - failed - flex.v1.web_channel: + description: The absolute URL of the Flex Plugin resource. + links: + type: object + format: uri-map + nullable: true + flex.v1.plugin_archive: type: object properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + resource. account_sid: type: string minLength: 34 @@ -1072,42 +1226,398 @@ components: pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) - that created the WebChannel resource and owns this Workflow. - flex_flow_sid: + that created the Flex Plugin resource and owns this resource. + unique_name: + type: string + nullable: true + description: The name that uniquely identifies this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + friendly_name: + type: string + nullable: true + description: The friendly name this Flex Plugin resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + description: + type: string + nullable: true + description: A descriptive string that you create to describe the plugin + resource. It can be up to 500 characters long + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin is archived. The default value is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin resource. + flex.v1.plugin_configuration: + type: object + properties: + sid: type: string minLength: 34 maxLength: 34 - pattern: ^FO[0-9a-fA-F]{32}$ + pattern: ^FJ[0-9a-fA-F]{32}$ nullable: true - description: The SID of the Flex Flow. - sid: + description: The unique string that we created to identify the Flex Plugin + Configuration resource. + account_sid: type: string minLength: 34 maxLength: 34 - pattern: ^CH[0-9a-fA-F]{32}$ + pattern: ^AC[0-9a-fA-F]{32}$ nullable: true - description: The unique string that we created to identify the WebChannel - resource. + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Plugin Configuration resource and owns this resource. + name: + type: string + nullable: true + description: The name of this Flex Plugin Configuration. + description: + type: string + nullable: true + description: The description of the Flex Plugin Configuration resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Configuration is archived. The default + value is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Configuration + was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. url: type: string format: uri nullable: true - description: The absolute URL of the WebChannel resource. + description: The absolute URL of the Flex Plugin Configuration resource. + links: + type: object + format: uri-map + nullable: true + flex.v1.plugin_configuration_archive: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Configuration resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Plugin Configuration resource and owns this resource. + name: + type: string + nullable: true + description: The name of this Flex Plugin Configuration. + description: + type: string + nullable: true + description: The description of the Flex Plugin Configuration resource. + x-twilio: + pii: + handling: standard + deleteSla: 30 + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Configuration is archived. The default + value is false. date_created: type: string format: date-time nullable: true - description: The date and time in GMT when the resource was created specified - in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - date_updated: + description: The date and time in GMT when the Flex Plugin Configuration + was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) + format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Configuration resource. + flex.v1.plugin_release: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FK[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Plugin Release + resource. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Plugin Release resource and owns this resource. + configuration_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Plugin Configuration resource to release. + date_created: type: string format: date-time nullable: true - description: The date and time in GMT when the resource was last updated + description: The date and time in GMT when the Flex Plugin Release was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. - web_channel_enum_chat_status: - type: string - enum: + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Plugin Release resource. + flex.v1.plugin.plugin_version: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FV[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Version resource. + plugin_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin resource this Flex Plugin Version + belongs to. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Plugin Version resource and owns this resource. + version: + type: string + nullable: true + description: The unique version of this Flex Plugin Version. + plugin_url: + type: string + format: uri + nullable: true + description: The URL of where the Flex Plugin Version JavaScript bundle + is hosted on. + x-twilio: + pii: + handling: standard + deleteSla: 30 + changelog: + type: string + nullable: true + description: A changelog that describes the changes this Flex Plugin Version + brings. + x-twilio: + pii: + handling: standard + deleteSla: 30 + private: + type: boolean + nullable: true + description: Whether to inject credentials while accessing this Plugin Version. + The default value is false. + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Version is archived. The default value + is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Version was created + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Version resource. + flex.v1.plugin_version_archive: + type: object + properties: + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FV[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the Flex Plugin + Version resource. + plugin_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FP[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Plugin resource this Flex Plugin Version + belongs to. + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the Flex Plugin Version resource and owns this resource. + version: + type: string + nullable: true + description: The unique version of this Flex Plugin Version. + plugin_url: + type: string + format: uri + nullable: true + description: The URL of where the Flex Plugin Version JavaScript bundle + is hosted on. + x-twilio: + pii: + handling: standard + deleteSla: 30 + changelog: + type: string + nullable: true + description: A changelog that describes the changes this Flex Plugin Version + brings. + x-twilio: + pii: + handling: standard + deleteSla: 30 + private: + type: boolean + nullable: true + description: Whether to inject credentials while accessing this Plugin Version. + The default value is false. + archived: + type: boolean + nullable: true + description: Whether the Flex Plugin Version is archived. The default value + is false. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the Flex Plugin Version was created + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the Flex Plugin Version resource. + flex.v1.provisioning_status: + type: object + properties: + status: + type: string + $ref: '#/components/schemas/provisioning_status_enum_status' + nullable: true + description: Email Provisioning Status + url: + type: string + format: uri + nullable: true + description: The absolute URL of the resource. + provisioning_status_enum_status: + type: string + enum: + - active + - in-progress + - not-configured + - failed + flex.v1.web_channel: + type: object + properties: + account_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^AC[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) + that created the WebChannel resource and owns this Workflow. + flex_flow_sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FO[0-9a-fA-F]{32}$ + nullable: true + description: The SID of the Flex Flow. + sid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^CH[0-9a-fA-F]{32}$ + nullable: true + description: The unique string that we created to identify the WebChannel + resource. + url: + type: string + format: uri + nullable: true + description: The absolute URL of the WebChannel resource. + date_created: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was created specified + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + date_updated: + type: string + format: date-time + nullable: true + description: The date and time in GMT when the resource was last updated + specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. + web_channel_enum_chat_status: + type: string + enum: - inactive securitySchemes: accountSid_authToken: @@ -1124,7 +1634,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Channels: @@ -1365,32 +1875,36 @@ paths: operationId: FetchConfiguration x-maturity: - GA - /v1/FlexFlows: + /v1/PluginService/Configurations/{ConfigurationSid}/Plugins: servers: - url: https://flex-api.twilio.com - description: Flex Flow + description: 'TODO: Resource-level docs' x-twilio: defaultOutputProperties: - - sid - - friendly_name - - channel_type - - integration_type + - plugin_sid + - plugin_version_sid + - plugin_url + - phase pathType: list - mountName: flex_flow + parent: /PluginService/Configurations/{Sid} + className: configured_plugin get: description: '' tags: - - FlexV1FlexFlow + - FlexV1ConfiguredPlugin parameters: - - name: FriendlyName - in: query - description: The `friendly_name` of the Flex Flow resources to read. + - name: ConfigurationSid + in: path + description: The SID of the Flex Plugin Configuration the resource to belongs + to. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header schema: type: string - x-twilio: - pii: - handling: standard - deleteSla: 30 - name: PageSize in: query description: How many resources to return in each list page. The default is @@ -1416,12 +1930,12 @@ paths: application/json: schema: type: object - title: ListFlexFlowResponse + title: ListConfiguredPluginResponse properties: - flex_flows: + plugins: type: array items: - $ref: '#/components/schemas/flex.v1.flex_flow' + $ref: '#/components/schemas/flex.v1.plugin_configuration.configured_plugin' meta: type: object properties: @@ -1448,67 +1962,202 @@ paths: description: OK security: - accountSid_authToken: [] - operationId: ListFlexFlow + operationId: ListConfiguredPlugin x-maturity: - GA - post: + /v1/PluginService/Configurations/{ConfigurationSid}/Plugins/{PluginSid}: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - plugin_sid + - plugin_version_sid + - plugin_url + - phase + pathType: instance + parent: /PluginService/Configurations/{Sid} + className: configured_plugin + get: description: '' tags: - - FlexV1FlexFlow + - FlexV1ConfiguredPlugin + parameters: + - name: ConfigurationSid + in: path + description: The SID of the Flex Plugin Configuration the resource to belongs + to. + schema: + type: string + required: true + - name: PluginSid + in: path + description: The unique string that we created to identify the Flex Plugin + resource. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string responses: - '201': + '200': content: application/json: schema: - $ref: '#/components/schemas/flex.v1.flex_flow' - description: Created + $ref: '#/components/schemas/flex.v1.plugin_configuration.configured_plugin' + description: OK security: - accountSid_authToken: [] - operationId: CreateFlexFlow + operationId: FetchConfiguredPlugin x-maturity: - GA - requestBody: - content: - application/x-www-form-urlencoded: - schema: - type: object - title: CreateFlexFlowRequest - properties: - FriendlyName: - type: string - description: A descriptive string that you create to describe the - Flex Flow resource. - ChatServiceSid: - type: string - minLength: 34 - maxLength: 34 - pattern: ^IS[0-9a-fA-F]{32}$ - description: The SID of the chat service. - ChannelType: - type: string - $ref: '#/components/schemas/flex_flow_enum_channel_type' - description: "The channel type. One of `web`, `facebook`, `sms`,\ - \ `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send\ - \ to Flex widget passes it on to the Task attributes for Tasks\ - \ created based on this Flex Flow. The Task attributes will be\ - \ used by the Flex UI to render the respective Task as appropriate\ - \ (applying channel-specific design and length limits). If `channelType`\ - \ is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ - \ should set the Task Channel to Programmable Chat." - ContactIdentity: - type: string - description: The channel contact's Identity. - Enabled: - type: boolean - description: Whether the new Flex Flow is enabled. - IntegrationType: - type: string - $ref: '#/components/schemas/flex_flow_enum_integration_type' - description: 'The software that will handle inbound messages. [Integration - Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) - can be: `studio`, `external`, or `task`.' - Integration.FlowSid: - type: string + /v1/FlexFlows: + servers: + - url: https://flex-api.twilio.com + description: Flex Flow + x-twilio: + defaultOutputProperties: + - sid + - friendly_name + - channel_type + - integration_type + pathType: list + mountName: flex_flow + get: + description: '' + tags: + - FlexV1FlexFlow + parameters: + - name: FriendlyName + in: query + description: The `friendly_name` of the Flex Flow resources to read. + schema: + type: string + x-twilio: + pii: + handling: standard + deleteSla: 30 + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListFlexFlowResponse + properties: + flex_flows: + type: array + items: + $ref: '#/components/schemas/flex.v1.flex_flow' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListFlexFlow + x-maturity: + - GA + post: + description: '' + tags: + - FlexV1FlexFlow + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.flex_flow' + description: Created + security: + - accountSid_authToken: [] + operationId: CreateFlexFlow + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreateFlexFlowRequest + properties: + FriendlyName: + type: string + description: A descriptive string that you create to describe the + Flex Flow resource. + ChatServiceSid: + type: string + minLength: 34 + maxLength: 34 + pattern: ^IS[0-9a-fA-F]{32}$ + description: The SID of the chat service. + ChannelType: + type: string + $ref: '#/components/schemas/flex_flow_enum_channel_type' + description: "The channel type. One of `web`, `facebook`, `sms`,\ + \ `whatsapp`, `line` or `custom`. By default, Studio\u2019s Send\ + \ to Flex widget passes it on to the Task attributes for Tasks\ + \ created based on this Flex Flow. The Task attributes will be\ + \ used by the Flex UI to render the respective Task as appropriate\ + \ (applying channel-specific design and length limits). If `channelType`\ + \ is `facebook`, `whatsapp` or `line`, the Send to Flex widget\ + \ should set the Task Channel to Programmable Chat." + ContactIdentity: + type: string + description: The channel contact's Identity. + Enabled: + type: boolean + description: Whether the new Flex Flow is enabled. + IntegrationType: + type: string + $ref: '#/components/schemas/flex_flow_enum_integration_type' + description: 'The software that will handle inbound messages. [Integration + Type](https://www.twilio.com/docs/flex/developer/messaging/manage-flows#integration-types) + can be: `studio`, `external`, or `task`.' + Integration.FlowSid: + type: string minLength: 34 maxLength: 34 pattern: ^FW[0-9a-fA-F]{32}$ @@ -3823,6 +4472,861 @@ paths: must be an agent.' required: - Status + /v1/PluginService/Plugins: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: list + dependentProperties: + plugin_versions: + mapping: + plugin_sid: sid + resource_url: /v1/PluginService/Plugins/{plugin_sid}/Versions + get: + description: '' + tags: + - FlexV1Plugin + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListPluginResponse + properties: + plugins: + type: array + items: + $ref: '#/components/schemas/flex.v1.plugin' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListPlugin + x-maturity: + - GA + post: + description: '' + tags: + - FlexV1Plugin + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin' + description: Created + security: + - accountSid_authToken: [] + operationId: CreatePlugin + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePluginRequest + properties: + UniqueName: + type: string + description: The Flex Plugin's unique name. + FriendlyName: + type: string + description: The Flex Plugin's friendly name. + Description: + type: string + description: A descriptive string that you create to describe the + plugin resource. It can be up to 500 characters long + required: + - UniqueName + /v1/PluginService/Plugins/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: instance + dependentProperties: + plugin_versions: + mapping: + plugin_sid: sid + resource_url: /v1/PluginService/Plugins/{plugin_sid}/Versions + get: + description: '' + tags: + - FlexV1Plugin + parameters: + - name: Sid + in: path + description: The SID of the Flex Plugin resource to fetch. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPlugin + x-maturity: + - GA + post: + description: '' + tags: + - FlexV1Plugin + parameters: + - name: Sid + in: path + description: The SID of the Flex Plugin resource to update. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdatePlugin + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: UpdatePluginRequest + properties: + FriendlyName: + type: string + description: The Flex Plugin's friendly name. + Description: + type: string + description: A descriptive string that you update to describe the + plugin resource. It can be up to 500 characters long + /v1/PluginService/Plugins/{Sid}/Archive: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - unique_name + - friendly_name + pathType: instance + mountName: plugin_archive + post: + description: '' + tags: + - FlexV1PluginArchive + parameters: + - name: Sid + in: path + description: The SID of the Flex Plugin resource to archive. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_archive' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdatePluginArchive + x-maturity: + - GA + /v1/PluginService/Configurations: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - name + - description + pathType: list + dependentProperties: + plugins: + mapping: + configuration_sid: sid + resource_url: /v1/PluginService/Configurations/{configuration_sid}/Plugins + mountName: plugin_configurations + get: + description: '' + tags: + - FlexV1PluginConfiguration + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListPluginConfigurationResponse + properties: + configurations: + type: array + items: + $ref: '#/components/schemas/flex.v1.plugin_configuration' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListPluginConfiguration + x-maturity: + - GA + post: + description: '' + tags: + - FlexV1PluginConfiguration + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_configuration' + description: Created + security: + - accountSid_authToken: [] + operationId: CreatePluginConfiguration + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePluginConfigurationRequest + properties: + Name: + type: string + description: The Flex Plugin Configuration's name. + Plugins: + type: array + items: {} + description: A list of objects that describe the plugin versions + included in the configuration. Each object contains the sid of + the plugin version. + Description: + type: string + description: The Flex Plugin Configuration's description. + required: + - Name + /v1/PluginService/Configurations/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - name + - description + pathType: instance + dependentProperties: + plugins: + mapping: + configuration_sid: sid + resource_url: /v1/PluginService/Configurations/{configuration_sid}/Plugins + mountName: plugin_configurations + get: + description: '' + tags: + - FlexV1PluginConfiguration + parameters: + - name: Sid + in: path + description: The SID of the Flex Plugin Configuration resource to fetch. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_configuration' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPluginConfiguration + x-maturity: + - GA + /v1/PluginService/Configurations/{Sid}/Archive: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - name + - description + pathType: instance + mountName: plugin_configuration_archive + post: + description: '' + tags: + - FlexV1PluginConfigurationArchive + parameters: + - name: Sid + in: path + description: The SID of the Flex Plugin Configuration resource to archive. + schema: + type: string + minLength: 34 + maxLength: 34 + pattern: ^FJ[0-9a-fA-F]{32}$ + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_configuration_archive' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdatePluginConfigurationArchive + x-maturity: + - GA + /v1/PluginService/Releases: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - configuration_sid + - date_created + pathType: list + mountName: plugin_releases + get: + description: '' + tags: + - FlexV1PluginRelease + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListPluginReleaseResponse + properties: + releases: + type: array + items: + $ref: '#/components/schemas/flex.v1.plugin_release' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListPluginRelease + x-maturity: + - GA + post: + description: '' + tags: + - FlexV1PluginRelease + parameters: + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_release' + description: Created + security: + - accountSid_authToken: [] + operationId: CreatePluginRelease + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePluginReleaseRequest + properties: + ConfigurationId: + type: string + description: The SID or the Version of the Flex Plugin Configuration + to release. + required: + - ConfigurationId + /v1/PluginService/Releases/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - configuration_sid + - date_created + pathType: instance + mountName: plugin_releases + get: + description: '' + tags: + - FlexV1PluginRelease + parameters: + - name: Sid + in: path + description: The SID of the Flex Plugin Release resource to fetch. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_release' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPluginRelease + x-maturity: + - GA + /v1/PluginService/Plugins/{PluginSid}/Versions: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - plugin_sid + - version + pathType: list + parent: /PluginService/Plugins/{Sid} + mountName: plugin_versions + className: plugin_versions + get: + description: '' + tags: + - FlexV1PluginVersions + parameters: + - name: PluginSid + in: path + description: The SID of the Flex Plugin the resource to belongs to. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + - name: PageSize + in: query + description: How many resources to return in each list page. The default is + 50, and the maximum is 1000. + schema: + type: integer + minimum: 1 + maximum: 1000 + - name: Page + in: query + description: The page index. This value is simply for client state. + schema: + type: integer + minimum: 0 + - name: PageToken + in: query + description: The page token. This is provided by the API. + schema: + type: string + responses: + '200': + content: + application/json: + schema: + type: object + title: ListPluginVersionResponse + properties: + plugin_versions: + type: array + items: + $ref: '#/components/schemas/flex.v1.plugin.plugin_version' + meta: + type: object + properties: + first_page_url: + type: string + format: uri + next_page_url: + type: string + format: uri + nullable: true + page: + type: integer + page_size: + type: integer + previous_page_url: + type: string + format: uri + nullable: true + url: + type: string + format: uri + key: + type: string + description: OK + security: + - accountSid_authToken: [] + operationId: ListPluginVersion + x-maturity: + - GA + post: + description: '' + tags: + - FlexV1PluginVersions + parameters: + - name: PluginSid + in: path + description: The SID of the Flex Plugin the resource to belongs to. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin.plugin_version' + description: Created + security: + - accountSid_authToken: [] + operationId: CreatePluginVersion + x-maturity: + - GA + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + title: CreatePluginVersionRequest + properties: + Version: + type: string + description: The Flex Plugin Version's version. + PluginUrl: + type: string + format: uri + description: The URL of the Flex Plugin Version bundle + Changelog: + type: string + description: The changelog of the Flex Plugin Version. + Private: + type: boolean + description: Whether this Flex Plugin Version requires authorization. + required: + - Version + - PluginUrl + /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - plugin_sid + - version + pathType: instance + parent: /PluginService/Plugins/{Sid} + mountName: plugin_versions + className: plugin_versions + get: + description: '' + tags: + - FlexV1PluginVersions + parameters: + - name: PluginSid + in: path + description: The SID of the Flex Plugin the resource to belongs to. + schema: + type: string + required: true + - name: Sid + in: path + description: The SID of the Flex Plugin Version resource to fetch. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin.plugin_version' + description: OK + security: + - accountSid_authToken: [] + operationId: FetchPluginVersion + x-maturity: + - GA + /v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}/Archive: + servers: + - url: https://flex-api.twilio.com + description: 'TODO: Resource-level docs' + x-twilio: + defaultOutputProperties: + - sid + - plugin_sid + - version + pathType: instance + mountName: plugin_version_archive + post: + description: '' + tags: + - FlexV1PluginVersionArchive + parameters: + - name: PluginSid + in: path + description: The SID of the Flex Plugin the resource to belongs to. + schema: + type: string + required: true + - name: Sid + in: path + description: The SID of the Flex Plugin Version resource to archive. + schema: + type: string + required: true + - name: Flex-Metadata + in: header + description: The Flex-Metadata HTTP request header + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/flex.v1.plugin_version_archive' + description: OK + security: + - accountSid_authToken: [] + operationId: UpdatePluginVersionArchive + x-maturity: + - GA /v1/account/provision/status: servers: - url: https://flex-api.twilio.com @@ -4076,6 +5580,7 @@ tags: - name: FlexV1Assessments - name: FlexV1Channel - name: FlexV1Configuration +- name: FlexV1ConfiguredPlugin - name: FlexV1FlexFlow - name: FlexV1InsightsAssessmentsComment - name: FlexV1InsightsConversations @@ -4091,6 +5596,13 @@ tags: - name: FlexV1InteractionChannel - name: FlexV1InteractionChannelInvite - name: FlexV1InteractionChannelParticipant +- name: FlexV1Plugin +- name: FlexV1PluginArchive +- name: FlexV1PluginConfiguration +- name: FlexV1PluginConfigurationArchive +- name: FlexV1PluginRelease +- name: FlexV1PluginVersionArchive +- name: FlexV1PluginVersions - name: FlexV1ProvisioningStatus - name: FlexV1WebChannel x-maturity: diff --git a/spec/yaml/twilio_flex_v2.yaml b/spec/yaml/twilio_flex_v2.yaml index d3fee56a..9f37681f 100644 --- a/spec/yaml/twilio_flex_v2.yaml +++ b/spec/yaml/twilio_flex_v2.yaml @@ -32,7 +32,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/WebChats: diff --git a/spec/yaml/twilio_frontline_v1.yaml b/spec/yaml/twilio_frontline_v1.yaml index aa95fb49..93599d8d 100644 --- a/spec/yaml/twilio_frontline_v1.yaml +++ b/spec/yaml/twilio_frontline_v1.yaml @@ -68,7 +68,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Users/{Sid}: diff --git a/spec/yaml/twilio_insights_v1.yaml b/spec/yaml/twilio_insights_v1.yaml index 321bafa2..d1ee3433 100644 --- a/spec/yaml/twilio_insights_v1.yaml +++ b/spec/yaml/twilio_insights_v1.yaml @@ -1353,7 +1353,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Voice/Settings: diff --git a/spec/yaml/twilio_intelligence_v2.yaml b/spec/yaml/twilio_intelligence_v2.yaml index 8048c000..6b79001f 100644 --- a/spec/yaml/twilio_intelligence_v2.yaml +++ b/spec/yaml/twilio_intelligence_v2.yaml @@ -364,7 +364,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/Transcripts/{Sid}/Media: diff --git a/spec/yaml/twilio_ip_messaging_v1.yaml b/spec/yaml/twilio_ip_messaging_v1.yaml index e7ff62f5..61da1e83 100644 --- a/spec/yaml/twilio_ip_messaging_v1.yaml +++ b/spec/yaml/twilio_ip_messaging_v1.yaml @@ -535,7 +535,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Channels/{Sid}: diff --git a/spec/yaml/twilio_ip_messaging_v2.yaml b/spec/yaml/twilio_ip_messaging_v2.yaml index d79cd9a9..5ca4bcf9 100644 --- a/spec/yaml/twilio_ip_messaging_v2.yaml +++ b/spec/yaml/twilio_ip_messaging_v2.yaml @@ -776,7 +776,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/Bindings: diff --git a/spec/yaml/twilio_lookups_v1.yaml b/spec/yaml/twilio_lookups_v1.yaml index 119c9406..fa39dc74 100644 --- a/spec/yaml/twilio_lookups_v1.yaml +++ b/spec/yaml/twilio_lookups_v1.yaml @@ -77,7 +77,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/PhoneNumbers/{PhoneNumber}: @@ -103,7 +103,6 @@ paths: number. schema: type: string - format: phone-number x-twilio: pii: handling: standard diff --git a/spec/yaml/twilio_lookups_v2.yaml b/spec/yaml/twilio_lookups_v2.yaml index 3f80a704..5c9f67ae 100644 --- a/spec/yaml/twilio_lookups_v2.yaml +++ b/spec/yaml/twilio_lookups_v2.yaml @@ -128,7 +128,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_media_v1.yaml b/spec/yaml/twilio_media_v1.yaml index ae1c608e..8c6f29fc 100644 --- a/spec/yaml/twilio_media_v1.yaml +++ b/spec/yaml/twilio_media_v1.yaml @@ -387,7 +387,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/MediaProcessors: diff --git a/spec/yaml/twilio_messaging_v1.yaml b/spec/yaml/twilio_messaging_v1.yaml index 8596a6f2..184c1d7e 100644 --- a/spec/yaml/twilio_messaging_v1.yaml +++ b/spec/yaml/twilio_messaging_v1.yaml @@ -140,8 +140,14 @@ components: failure_reason: type: string nullable: true - description: A reason why brand registration has failed. Only applicable - when status is FAILED. + description: DEPRECATED. A reason why brand registration has failed. Only + applicable when status is FAILED. + errors: + type: array + items: {} + nullable: true + description: A list of errors that occurred during the brand registration + process. url: type: string format: uri @@ -159,7 +165,7 @@ components: type: string $ref: '#/components/schemas/brand_registrations_enum_brand_feedback' nullable: true - description: Feedback on how to improve brand score + description: DEPRECATED. Feedback on how to improve brand score identity_status: type: string $ref: '#/components/schemas/brand_registrations_enum_identity_status' @@ -1326,7 +1332,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/AlphaSenders: diff --git a/spec/yaml/twilio_microvisor_v1.yaml b/spec/yaml/twilio_microvisor_v1.yaml index 008a281f..ead63788 100644 --- a/spec/yaml/twilio_microvisor_v1.yaml +++ b/spec/yaml/twilio_microvisor_v1.yaml @@ -229,7 +229,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Configs: diff --git a/spec/yaml/twilio_monitor_v1.yaml b/spec/yaml/twilio_monitor_v1.yaml index 64de4ecf..61170f7c 100644 --- a/spec/yaml/twilio_monitor_v1.yaml +++ b/spec/yaml/twilio_monitor_v1.yaml @@ -340,7 +340,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Alerts/{Sid}: diff --git a/spec/yaml/twilio_notify_v1.yaml b/spec/yaml/twilio_notify_v1.yaml index 66bada48..1b6b07ea 100644 --- a/spec/yaml/twilio_notify_v1.yaml +++ b/spec/yaml/twilio_notify_v1.yaml @@ -486,7 +486,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Bindings/{Sid}: diff --git a/spec/yaml/twilio_numbers_v1.yaml b/spec/yaml/twilio_numbers_v1.yaml index 72dfd4ad..b7cfdb4e 100644 --- a/spec/yaml/twilio_numbers_v1.yaml +++ b/spec/yaml/twilio_numbers_v1.yaml @@ -311,7 +311,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/HostedNumber/Eligibility/Bulk: @@ -463,7 +463,7 @@ paths: defaultOutputProperties: - port_in_request_sid pathType: instance - mountName: porting_port_ins + mountName: porting_port_ins_fetch className: porting_port_in_fetch get: description: Fetch a port in request by SID diff --git a/spec/yaml/twilio_numbers_v2.yaml b/spec/yaml/twilio_numbers_v2.yaml index fc24f97a..b145218e 100644 --- a/spec/yaml/twilio_numbers_v2.yaml +++ b/spec/yaml/twilio_numbers_v2.yaml @@ -1070,7 +1070,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/HostedNumber/AuthorizationDocuments/{Sid}: diff --git a/spec/yaml/twilio_preview.yaml b/spec/yaml/twilio_preview.yaml index aa191513..f5c49bce 100644 --- a/spec/yaml/twilio_preview.yaml +++ b/spec/yaml/twilio_preview.yaml @@ -1643,7 +1643,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /DeployedDevices/Fleets/{FleetSid}/Certificates/{Sid}: diff --git a/spec/yaml/twilio_pricing_v1.yaml b/spec/yaml/twilio_pricing_v1.yaml index babcb2a5..4c33c8c9 100644 --- a/spec/yaml/twilio_pricing_v1.yaml +++ b/spec/yaml/twilio_pricing_v1.yaml @@ -327,7 +327,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Messaging: diff --git a/spec/yaml/twilio_pricing_v2.yaml b/spec/yaml/twilio_pricing_v2.yaml index b8e99f15..3ec94be4 100644 --- a/spec/yaml/twilio_pricing_v2.yaml +++ b/spec/yaml/twilio_pricing_v2.yaml @@ -330,7 +330,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/Trunking/Countries: diff --git a/spec/yaml/twilio_proxy_v1.yaml b/spec/yaml/twilio_proxy_v1.yaml index 1d24e631..60c58f87 100644 --- a/spec/yaml/twilio_proxy_v1.yaml +++ b/spec/yaml/twilio_proxy_v1.yaml @@ -823,7 +823,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}: diff --git a/spec/yaml/twilio_routes_v2.yaml b/spec/yaml/twilio_routes_v2.yaml index 340da6ac..0a51a9e7 100644 --- a/spec/yaml/twilio_routes_v2.yaml +++ b/spec/yaml/twilio_routes_v2.yaml @@ -148,7 +148,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/PhoneNumbers/{PhoneNumber}: diff --git a/spec/yaml/twilio_serverless_v1.yaml b/spec/yaml/twilio_serverless_v1.yaml index e959935a..cb84d690 100644 --- a/spec/yaml/twilio_serverless_v1.yaml +++ b/spec/yaml/twilio_serverless_v1.yaml @@ -829,7 +829,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Assets: diff --git a/spec/yaml/twilio_studio_v1.yaml b/spec/yaml/twilio_studio_v1.yaml index f2569780..54b9f703 100644 --- a/spec/yaml/twilio_studio_v1.yaml +++ b/spec/yaml/twilio_studio_v1.yaml @@ -559,7 +559,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Flows/{FlowSid}/Engagements: diff --git a/spec/yaml/twilio_studio_v2.yaml b/spec/yaml/twilio_studio_v2.yaml index 0ce48fb1..56e1e092 100644 --- a/spec/yaml/twilio_studio_v2.yaml +++ b/spec/yaml/twilio_studio_v2.yaml @@ -444,7 +444,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/Flows/{FlowSid}/Executions: diff --git a/spec/yaml/twilio_supersim_v1.yaml b/spec/yaml/twilio_supersim_v1.yaml index 2107a5a9..f80b4fb9 100644 --- a/spec/yaml/twilio_supersim_v1.yaml +++ b/spec/yaml/twilio_supersim_v1.yaml @@ -875,7 +875,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Sims/{SimSid}/BillingPeriods: diff --git a/spec/yaml/twilio_sync_v1.yaml b/spec/yaml/twilio_sync_v1.yaml index 09620b30..4d34cd05 100644 --- a/spec/yaml/twilio_sync_v1.yaml +++ b/spec/yaml/twilio_sync_v1.yaml @@ -796,7 +796,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/Documents/{Sid}: diff --git a/spec/yaml/twilio_taskrouter_v1.yaml b/spec/yaml/twilio_taskrouter_v1.yaml index 2349ee4d..1442846c 100644 --- a/spec/yaml/twilio_taskrouter_v1.yaml +++ b/spec/yaml/twilio_taskrouter_v1.yaml @@ -1937,7 +1937,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Workspaces/{WorkspaceSid}/Activities/{Sid}: diff --git a/spec/yaml/twilio_trunking_v1.yaml b/spec/yaml/twilio_trunking_v1.yaml index d4181a3e..032e5b37 100644 --- a/spec/yaml/twilio_trunking_v1.yaml +++ b/spec/yaml/twilio_trunking_v1.yaml @@ -567,7 +567,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}: diff --git a/spec/yaml/twilio_trusthub_v1.yaml b/spec/yaml/twilio_trusthub_v1.yaml index 99765d10..9d8da630 100644 --- a/spec/yaml/twilio_trusthub_v1.yaml +++ b/spec/yaml/twilio_trusthub_v1.yaml @@ -822,7 +822,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/ComplianceInquiries/Customers/Initialize: @@ -1086,6 +1086,12 @@ paths: type: boolean description: Indicates if the inquiry is being started from an ISV embedded component. + IsvRegisteringForSelfOrTenant: + type: string + description: Indicates if the isv registering for self or tenant. + StatusCallbackUrl: + type: string + description: The url we call to inform you of bundle changes. required: - EndUserType - PhoneNumberType diff --git a/spec/yaml/twilio_verify_v2.yaml b/spec/yaml/twilio_verify_v2.yaml index 2daafe4b..e06fdd36 100644 --- a/spec/yaml/twilio_verify_v2.yaml +++ b/spec/yaml/twilio_verify_v2.yaml @@ -1413,7 +1413,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v2/Services/{ServiceSid}/AccessTokens: diff --git a/spec/yaml/twilio_video_v1.yaml b/spec/yaml/twilio_video_v1.yaml index 9caa5da7..e5cf0ed6 100644 --- a/spec/yaml/twilio_video_v1.yaml +++ b/spec/yaml/twilio_video_v1.yaml @@ -1291,7 +1291,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Compositions/{Sid}: diff --git a/spec/yaml/twilio_voice_v1.yaml b/spec/yaml/twilio_voice_v1.yaml index 708e4dd3..8ee05f1f 100644 --- a/spec/yaml/twilio_voice_v1.yaml +++ b/spec/yaml/twilio_voice_v1.yaml @@ -533,7 +533,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/Archives/{Date}/Calls/{Sid}: diff --git a/spec/yaml/twilio_wireless_v1.yaml b/spec/yaml/twilio_wireless_v1.yaml index 35ad104c..17677f12 100644 --- a/spec/yaml/twilio_wireless_v1.yaml +++ b/spec/yaml/twilio_wireless_v1.yaml @@ -592,7 +592,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: 1.55.0 + version: 1.55.1 openapi: 3.0.1 paths: /v1/UsageRecords: