twilio-ruby 5.45.0 → 5.60.0

data/lib/twilio-ruby/rest/flex_api/v1/flex_flow.rb

@@ -27,7 +27,7 @@ module Twilio
           # Lists FlexFlowInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] friendly_name The `friendly_name` of the FlexFlow resources to
+          # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to
           #   read.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit.  Default is no limit
@@ -44,7 +44,7 @@ module Twilio
           # Streams FlexFlowInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] friendly_name The `friendly_name` of the FlexFlow resources to
+          # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to
           #   read.
           # @param [Integer] limit Upper limit for the number of records to return. stream()
           #    guarantees to never return more than limit. Default is no limit.
@@ -78,7 +78,7 @@ module Twilio
           ##
           # Retrieve a single page of FlexFlowInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The `friendly_name` of the FlexFlow resources to
+          # @param [String] friendly_name The `friendly_name` of the Flex Flow resources to
           #   read.
           # @param [String] page_token PageToken provided by the API
           # @param [Integer] page_number Page Number, this value is simply for client state
@@ -113,33 +113,38 @@ module Twilio
           ##
           # Create the FlexFlowInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the FlexFlow resource.
+          #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
           # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
           #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
           # @param [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the new FlexFlow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
-          # @param [String] integration_flow_sid The SID of the Flow when `integration_type`
-          #   is `studio`.
-          # @param [String] integration_url The External Webhook URL when `integration_type`
-          #   is `external`.
-          # @param [String] integration_workspace_sid The Workspace SID for a new task for
-          #   Task `integration_type`.
-          # @param [String] integration_workflow_sid The Workflow SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_channel The task channel for a new task when
-          #   `integration_type` is `task`. The default is `default`.
-          # @param [String] integration_timeout The task timeout in seconds for a new task
-          #   when `integration_type` is `task`. The default is `86,400` seconds (24 hours).
-          # @param [String] integration_priority The task priority of a new task when
-          #   `integration_type` is `task`. The default priority is `0`.
-          # @param [Boolean] integration_creation_on_message Whether to create a task when
-          #   the first message arrives when `integration_type` is `task`. If `false`, the
-          #   task is created with the channel. **Note** that does not apply when channel type
-          #   is `web`. Setting the value to `true` for channel type `web` will result in
-          #   misconfigured Flex Flow and no tasks will be created.
+          # @param [Boolean] enabled Whether the new Flex Flow is enabled.
+          # @param [flex_flow.IntegrationType] integration_type 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`.
+          # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
+          #   `integrationType` is `studio`.
+          # @param [String] integration_url The URL of the external webhook. Required when
+          #   `integrationType` is `external`.
+          # @param [String] integration_workspace_sid The Workspace SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_workflow_sid The Workflow SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_channel 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`.
+          # @param [String] integration_timeout The Task timeout in seconds for a new Task.
+          #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
+          #   not applicable otherwise.
+          # @param [String] integration_priority The Task priority of a new Task. The
+          #   default priority is 0. Optional when `integrationType` is `task`, not applicable
+          #   otherwise.
+          # @param [Boolean] integration_creation_on_message 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.
           # @param [Boolean] long_lived 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`.
@@ -147,8 +152,9 @@ module Twilio
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3, inclusive, and
-          #   the default is 0.
+          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
+          #   default is 3. Optional when `integrationType` is `external`, not applicable
+          #   otherwise.
           # @return [FlexFlowInstance] Created FlexFlowInstance
           def create(friendly_name: nil, chat_service_sid: nil, channel_type: nil, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             data = Twilio::Values.of({
@@ -216,7 +222,7 @@ module Twilio
           ##
           # Initialize the FlexFlowContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The SID of the FlexFlow resource to fetch.
+          # @param [String] sid The SID of the Flex Flow resource to fetch.
           # @return [FlexFlowContext] FlexFlowContext
           def initialize(version, sid)
             super(version)
@@ -238,33 +244,38 @@ module Twilio
           ##
           # Update the FlexFlowInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the FlexFlow resource.
+          #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
           # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
           #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
           # @param [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the FlexFlow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
-          # @param [String] integration_flow_sid The SID of the Flow when `integration_type`
-          #   is `studio`.
-          # @param [String] integration_url The External Webhook URL when `integration_type`
-          #   is `external`.
-          # @param [String] integration_workspace_sid The Workspace SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_workflow_sid The Workflow SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_channel The task channel for a new task when
-          #   `integration_type` is `task`. The default is `default`.
-          # @param [String] integration_timeout The task timeout in seconds for a new task
-          #   when `integration_type` is `task`. The default is `86,400` seconds (24 hours).
-          # @param [String] integration_priority The task priority of a new task when
-          #   `integration_type` is `task`. The default priority is `0`.
-          # @param [Boolean] integration_creation_on_message Whether to create a task when
-          #   the first message arrives when `integration_type` is `task`. If `false`, the
-          #   task is created with the channel. **Note** that does not apply when channel type
-          #   is `web`. Setting the value to `true` for channel type `web` will result in
-          #   misconfigured Flex Flow and no tasks will be created.
+          # @param [Boolean] enabled Whether the new Flex Flow is enabled.
+          # @param [flex_flow.IntegrationType] integration_type 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`.
+          # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
+          #   `integrationType` is `studio`.
+          # @param [String] integration_url The URL of the external webhook. Required when
+          #   `integrationType` is `external`.
+          # @param [String] integration_workspace_sid The Workspace SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_workflow_sid The Workflow SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_channel 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`.
+          # @param [String] integration_timeout The Task timeout in seconds for a new Task.
+          #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
+          #   not applicable otherwise.
+          # @param [String] integration_priority The Task priority of a new Task. The
+          #   default priority is 0. Optional when `integrationType` is `task`, not applicable
+          #   otherwise.
+          # @param [Boolean] integration_creation_on_message 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.
           # @param [Boolean] long_lived 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`.
@@ -272,8 +283,9 @@ module Twilio
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3, inclusive, and
-          #   the default is 0.
+          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
+          #   default is 3. Optional when `integrationType` is `external`, not applicable
+          #   otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             data = Twilio::Values.of({
@@ -328,7 +340,7 @@ module Twilio
           # Initialize the FlexFlowInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The SID of the FlexFlow resource to fetch.
+          # @param [String] sid The SID of the Flex Flow resource to fetch.
           # @return [FlexFlowInstance] FlexFlowInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -416,13 +428,13 @@ module Twilio
           end
 
           ##
-          # @return [Boolean] Whether the FlexFlow is enabled
+          # @return [Boolean] Whether the Flex Flow is enabled
           def enabled
             @properties['enabled']
           end
 
           ##
-          # @return [flex_flow.IntegrationType] The integration type
+          # @return [flex_flow.IntegrationType] The software that will handle inbound messages.
           def integration_type
             @properties['integration_type']
           end
@@ -446,7 +458,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The absolute URL of the FlexFlow resource
+          # @return [String] The absolute URL of the Flex Flow resource
           def url
             @properties['url']
           end
@@ -461,33 +473,38 @@ module Twilio
           ##
           # Update the FlexFlowInstance
           # @param [String] friendly_name A descriptive string that you create to describe
-          #   the FlexFlow resource.
+          #   the Flex Flow resource.
           # @param [String] chat_service_sid The SID of the chat service.
           # @param [flex_flow.ChannelType] channel_type The channel type. Can be: `web`,
           #   `facebook`, `sms`, `whatsapp`, `line` or `custom`.
           # @param [String] contact_identity The channel contact's Identity.
-          # @param [Boolean] enabled Whether the FlexFlow is enabled.
-          # @param [flex_flow.IntegrationType] integration_type The integration type. Can
-          #   be: `studio`, `external`, or `task`.
-          # @param [String] integration_flow_sid The SID of the Flow when `integration_type`
-          #   is `studio`.
-          # @param [String] integration_url The External Webhook URL when `integration_type`
-          #   is `external`.
-          # @param [String] integration_workspace_sid The Workspace SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_workflow_sid The Workflow SID for a new task when
-          #   `integration_type` is `task`.
-          # @param [String] integration_channel The task channel for a new task when
-          #   `integration_type` is `task`. The default is `default`.
-          # @param [String] integration_timeout The task timeout in seconds for a new task
-          #   when `integration_type` is `task`. The default is `86,400` seconds (24 hours).
-          # @param [String] integration_priority The task priority of a new task when
-          #   `integration_type` is `task`. The default priority is `0`.
-          # @param [Boolean] integration_creation_on_message Whether to create a task when
-          #   the first message arrives when `integration_type` is `task`. If `false`, the
-          #   task is created with the channel. **Note** that does not apply when channel type
-          #   is `web`. Setting the value to `true` for channel type `web` will result in
-          #   misconfigured Flex Flow and no tasks will be created.
+          # @param [Boolean] enabled Whether the new Flex Flow is enabled.
+          # @param [flex_flow.IntegrationType] integration_type 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`.
+          # @param [String] integration_flow_sid The SID of the Studio Flow. Required when
+          #   `integrationType` is `studio`.
+          # @param [String] integration_url The URL of the external webhook. Required when
+          #   `integrationType` is `external`.
+          # @param [String] integration_workspace_sid The Workspace SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_workflow_sid The Workflow SID for a new Task.
+          #   Required when `integrationType` is `task`.
+          # @param [String] integration_channel 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`.
+          # @param [String] integration_timeout The Task timeout in seconds for a new Task.
+          #   Default is 86,400 seconds (24 hours). Optional when `integrationType` is `task`,
+          #   not applicable otherwise.
+          # @param [String] integration_priority The Task priority of a new Task. The
+          #   default priority is 0. Optional when `integrationType` is `task`, not applicable
+          #   otherwise.
+          # @param [Boolean] integration_creation_on_message 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.
           # @param [Boolean] long_lived 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`.
@@ -495,8 +512,9 @@ module Twilio
           #   will remove active Proxy sessions if the associated Task is deleted outside of
           #   the Flex UI. Defaults to `false`.
           # @param [String] integration_retry_count The number of times to retry the webhook
-          #   if the first attempt fails. Can be an integer between 0 and 3, inclusive, and
-          #   the default is 0.
+          #   if the first attempt fails. Can be an integer between 0 and 3 (inclusive),
+          #   default is 3. Optional when `integrationType` is `external`, not applicable
+          #   otherwise.
           # @return [FlexFlowInstance] Updated FlexFlowInstance
           def update(friendly_name: :unset, chat_service_sid: :unset, channel_type: :unset, contact_identity: :unset, enabled: :unset, integration_type: :unset, integration_flow_sid: :unset, integration_url: :unset, integration_workspace_sid: :unset, integration_workflow_sid: :unset, integration_channel: :unset, integration_timeout: :unset, integration_priority: :unset, integration_creation_on_message: :unset, long_lived: :unset, janitor_enabled: :unset, integration_retry_count: :unset)
             context.update(

data/lib/twilio-ruby/rest/flex_api/v1/web_channel.rb

@@ -105,7 +105,7 @@ module Twilio
 
           ##
           # Create the WebChannelInstance
-          # @param [String] flex_flow_sid The SID of the FlexFlow.
+          # @param [String] flex_flow_sid The SID of the Flex Flow.
           # @param [String] identity The chat identity.
           # @param [String] customer_friendly_name The chat participant's friendly name.
           # @param [String] chat_friendly_name The chat channel's friendly name.
@@ -268,7 +268,7 @@ module Twilio
           end
 
           ##
-          # @return [String] The SID of the FlexFlow
+          # @return [String] The SID of the Flex Flow
           def flex_flow_sid
             @properties['flex_flow_sid']
           end

data/lib/twilio-ruby/rest/flex_api/v1.rb

@@ -27,11 +27,12 @@ module Twilio
         # @return [Twilio::REST::Flex_api::V1::ChannelList]
         def channel(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @channel ||= ChannelList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @channel ||= ChannelList.new self
           else
-            ChannelContext.new(self, sid)
+              ChannelContext.new(self, sid)
           end
         end
 
@@ -42,16 +43,17 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The SID of the FlexFlow resource to fetch.
+        # @param [String] sid The SID of the Flex Flow resource to fetch.
         # @return [Twilio::REST::Flex_api::V1::FlexFlowContext] if sid was passed.
         # @return [Twilio::REST::Flex_api::V1::FlexFlowList]
         def flex_flow(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @flex_flow ||= FlexFlowList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @flex_flow ||= FlexFlowList.new self
           else
-            FlexFlowContext.new(self, sid)
+              FlexFlowContext.new(self, sid)
           end
         end
 
@@ -61,11 +63,12 @@ module Twilio
         # @return [Twilio::REST::Flex_api::V1::WebChannelList]
         def web_channel(sid=:unset)
           if sid.nil?
-            raise ArgumentError, 'sid cannot be nil'
-          elsif sid == :unset
-            @web_channel ||= WebChannelList.new self
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @web_channel ||= WebChannelList.new self
           else
-            WebChannelContext.new(self, sid)
+              WebChannelContext.new(self, sid)
           end
         end
 

data/lib/twilio-ruby/rest/flex_api.rb

@@ -44,7 +44,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The unique string that we created to identify the FlexFlow
+      # @param [String] sid The unique string that we created to identify the Flex Flow
       #   resource.
       # @return [Twilio::REST::Flex_api::V1::FlexFlowInstance] if sid was passed.
       # @return [Twilio::REST::Flex_api::V1::FlexFlowList]

data/lib/twilio-ruby/rest/frontline_api/v1/user.rb

@@ -0,0 +1,233 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class FrontlineApi < Domain
+      class V1 < Version
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserList < ListResource
+          ##
+          # Initialize the UserList
+          # @param [Version] version Version that contains the resource
+          # @return [UserList] UserList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.FrontlineApi.V1.UserList>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserPage < Page
+          ##
+          # Initialize the UserPage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [UserPage] UserPage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of UserInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [UserInstance] UserInstance
+          def get_instance(payload)
+            UserInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.FrontlineApi.V1.UserPage>'
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserContext < InstanceContext
+          ##
+          # Initialize the UserContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserContext] UserContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Users/#{@solution[:sid]}"
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated` and defaults to `active`
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Avatar' => avatar, 'State' => state, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            UserInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.FrontlineApi.V1.UserContext #{context}>"
+          end
+        end
+
+        ##
+        # PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+        class UserInstance < InstanceResource
+          ##
+          # Initialize the UserInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the User resource to fetch. This value can be
+          #   either the `sid` or the `identity` of the User resource to fetch.
+          # @return [UserInstance] UserInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'identity' => payload['identity'],
+                'friendly_name' => payload['friendly_name'],
+                'avatar' => payload['avatar'],
+                'state' => payload['state'],
+                'url' => payload['url'],
+            }
+
+            # Context
+            @instance_context = nil
+            @params = {'sid' => sid || @properties['sid'], }
+          end
+
+          ##
+          # Generate an instance context for the instance, the context is capable of
+          # performing various actions.  All instance actions are proxied to the context
+          # @return [UserContext] UserContext for this UserInstance
+          def context
+            unless @instance_context
+              @instance_context = UserContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique string that identifies the resource
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The string that identifies the resource's User
+          def identity
+            @properties['identity']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the User
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [String] The avatar URL which will be shown in Frontline application
+          def avatar
+            @properties['avatar']
+          end
+
+          ##
+          # @return [user.StateType] Current state of this user
+          def state
+            @properties['state']
+          end
+
+          ##
+          # @return [String] An absolute URL for this user.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Fetch the UserInstance
+          # @return [UserInstance] Fetched UserInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Update the UserInstance
+          # @param [String] friendly_name The string that you assigned to describe the User.
+          # @param [String] avatar The avatar URL which will be shown in Frontline
+          #   application.
+          # @param [user.StateType] state Current state of this user. Can be either `active`
+          #   or `deactivated` and defaults to `active`
+          # @return [UserInstance] Updated UserInstance
+          def update(friendly_name: :unset, avatar: :unset, state: :unset)
+            context.update(friendly_name: friendly_name, avatar: avatar, state: state, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.FrontlineApi.V1.UserInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end