twilio-ruby 5.40.1 → 5.42.0

data/lib/twilio-ruby/rest/conversations/v1/role.rb

@@ -0,0 +1,366 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class RoleList < ListResource
+          ##
+          # Initialize the RoleList
+          # @param [Version] version Version that contains the resource
+          # @return [RoleList] RoleList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Roles"
+          end
+
+          ##
+          # Create the RoleInstance
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the new resource. It can be up to 64 characters long.
+          # @param [role.RoleType] type The type of role. Can be: `conversation` for
+          #   {Conversation}[https://www.twilio.com/docs/conversations/api/conversation-resource]
+          #   roles or `service` for {Conversation
+          #   Service}[https://www.twilio.com/docs/conversations/api/service-resource] roles.
+          # @param [String] permission A permission that you grant to the new role. Only one
+          #   permission can be granted per parameter. To assign more than one permission,
+          #   repeat this parameter for each permission value. The values for this parameter
+          #   depend on the role's `type`.
+          # @return [RoleInstance] Created RoleInstance
+          def create(friendly_name: nil, type: nil, permission: nil)
+            data = Twilio::Values.of({
+                'FriendlyName' => friendly_name,
+                'Type' => type,
+                'Permission' => Twilio.serialize_list(permission) { |e| e },
+            })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            RoleInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists RoleInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit.  Default is no limit
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams RoleInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit. Default is no limit.
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields RoleInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of RoleInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] page_token PageToken provided by the API
+          # @param [Integer] page_number Page Number, this value is simply for client state
+          # @param [Integer] page_size Number of records to return, defaults to 50
+          # @return [Page] Page of RoleInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            RolePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of RoleInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of RoleInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            RolePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.RoleList>'
+          end
+        end
+
+        class RolePage < Page
+          ##
+          # Initialize the RolePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [RolePage] RolePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of RoleInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [RoleInstance] RoleInstance
+          def get_instance(payload)
+            RoleInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.RolePage>'
+          end
+        end
+
+        class RoleContext < InstanceContext
+          ##
+          # Initialize the RoleContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid The SID of the Role resource to fetch.
+          # @return [RoleContext] RoleContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Roles/#{@solution[:sid]}"
+          end
+
+          ##
+          # Update the RoleInstance
+          # @param [String] permission A permission that you grant to the role. Only one
+          #   permission can be granted per parameter. To assign more than one permission,
+          #   repeat this parameter for each permission value. Note that the update action
+          #   replaces all previously assigned permissions with those defined in the update
+          #   action. To remove a permission, do not include it in the subsequent update
+          #   action. The values for this parameter depend on the role's `type`.
+          # @return [RoleInstance] Updated RoleInstance
+          def update(permission: nil)
+            data = Twilio::Values.of({'Permission' => Twilio.serialize_list(permission) { |e| e }, })
+
+            payload = @version.update('POST', @uri, data: data)
+
+            RoleInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Delete the RoleInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Fetch the RoleInstance
+          # @return [RoleInstance] Fetched RoleInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            RoleInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.RoleContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.RoleContext #{context}>"
+          end
+        end
+
+        class RoleInstance < InstanceResource
+          ##
+          # Initialize the RoleInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid The SID of the Role resource to fetch.
+          # @return [RoleInstance] RoleInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'sid' => payload['sid'],
+                'account_sid' => payload['account_sid'],
+                'chat_service_sid' => payload['chat_service_sid'],
+                'friendly_name' => payload['friendly_name'],
+                'type' => payload['type'],
+                'permissions' => payload['permissions'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                '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 [RoleContext] RoleContext for this RoleInstance
+          def context
+            unless @instance_context
+              @instance_context = RoleContext.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 SID of the Account that created the resource
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] The SID of the Conversation Service that the resource is associated with
+          def chat_service_sid
+            @properties['chat_service_sid']
+          end
+
+          ##
+          # @return [String] The string that you assigned to describe the resource
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [role.RoleType] The type of role
+          def type
+            @properties['type']
+          end
+
+          ##
+          # @return [String] An array of the permissions the role has been granted
+          def permissions
+            @properties['permissions']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] An absolute URL for this user role.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # Update the RoleInstance
+          # @param [String] permission A permission that you grant to the role. Only one
+          #   permission can be granted per parameter. To assign more than one permission,
+          #   repeat this parameter for each permission value. Note that the update action
+          #   replaces all previously assigned permissions with those defined in the update
+          #   action. To remove a permission, do not include it in the subsequent update
+          #   action. The values for this parameter depend on the role's `type`.
+          # @return [RoleInstance] Updated RoleInstance
+          def update(permission: nil)
+            context.update(permission: permission, )
+          end
+
+          ##
+          # Delete the RoleInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Fetch the RoleInstance
+          # @return [RoleInstance] Fetched RoleInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.RoleInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.RoleInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/conversations/v1/service.rb

@@ -0,0 +1,434 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Conversations < Domain
+      class V1 < Version
+        class ServiceList < ListResource
+          ##
+          # Initialize the ServiceList
+          # @param [Version] version Version that contains the resource
+          # @return [ServiceList] ServiceList
+          def initialize(version)
+            super(version)
+
+            # Path Solution
+            @solution = {}
+            @uri = "/Services"
+          end
+
+          ##
+          # Create the ServiceInstance
+          # @param [String] friendly_name The human-readable name of this service, limited
+          #   to 256 characters. Optional.
+          # @return [ServiceInstance] Created ServiceInstance
+          def create(friendly_name: nil)
+            data = Twilio::Values.of({'FriendlyName' => friendly_name, })
+
+            payload = @version.create('POST', @uri, data: data)
+
+            ServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Lists ServiceInstance records from the API as a list.
+          # Unlike stream(), this operation is eager and will load `limit` records into
+          # memory before returning.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit.  Default is no limit
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records.  If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Array] Array of up to limit results
+          def list(limit: nil, page_size: nil)
+            self.stream(limit: limit, page_size: page_size).entries
+          end
+
+          ##
+          # Streams ServiceInstance records from the API as an Enumerable.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          # @param [Integer] limit Upper limit for the number of records to return. stream()
+          #    guarantees to never return more than limit. Default is no limit.
+          # @param [Integer] page_size Number of records to fetch per request, when
+          #    not set will use the default value of 50 records. If no page_size is defined
+          #    but a limit is defined, stream() will attempt to read the limit with the most
+          #    efficient page size, i.e. min(limit, 1000)
+          # @return [Enumerable] Enumerable that will yield up to limit results
+          def stream(limit: nil, page_size: nil)
+            limits = @version.read_limits(limit, page_size)
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+          end
+
+          ##
+          # When passed a block, yields ServiceInstance records from the API.
+          # This operation lazily loads records as efficiently as possible until the limit
+          # is reached.
+          def each
+            limits = @version.read_limits
+
+            page = self.page(page_size: limits[:page_size], )
+
+            @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] page_token PageToken provided by the API
+          # @param [Integer] page_number Page Number, this value is simply for client state
+          # @param [Integer] page_size Number of records to return, defaults to 50
+          # @return [Page] Page of ServiceInstance
+          def page(page_token: :unset, page_number: :unset, page_size: :unset)
+            params = Twilio::Values.of({
+                'PageToken' => page_token,
+                'Page' => page_number,
+                'PageSize' => page_size,
+            })
+
+            response = @version.page('GET', @uri, params: params)
+
+            ServicePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Retrieve a single page of ServiceInstance records from the API.
+          # Request is executed immediately.
+          # @param [String] target_url API-generated URL for the requested results page
+          # @return [Page] Page of ServiceInstance
+          def get_page(target_url)
+            response = @version.domain.request(
+                'GET',
+                target_url
+            )
+            ServicePage.new(@version, response, @solution)
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '#<Twilio.Conversations.V1.ServiceList>'
+          end
+        end
+
+        class ServicePage < Page
+          ##
+          # Initialize the ServicePage
+          # @param [Version] version Version that contains the resource
+          # @param [Response] response Response from the API
+          # @param [Hash] solution Path solution for the resource
+          # @return [ServicePage] ServicePage
+          def initialize(version, response, solution)
+            super(version, response)
+
+            # Path Solution
+            @solution = solution
+          end
+
+          ##
+          # Build an instance of ServiceInstance
+          # @param [Hash] payload Payload response from the API
+          # @return [ServiceInstance] ServiceInstance
+          def get_instance(payload)
+            ServiceInstance.new(@version, payload, )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            '<Twilio.Conversations.V1.ServicePage>'
+          end
+        end
+
+        class ServiceContext < InstanceContext
+          ##
+          # Initialize the ServiceContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   resource.
+          # @return [ServiceContext] ServiceContext
+          def initialize(version, sid)
+            super(version)
+
+            # Path Solution
+            @solution = {sid: sid, }
+            @uri = "/Services/#{@solution[:sid]}"
+
+            # Dependents
+            @conversations = nil
+            @bindings = nil
+            @users = nil
+            @roles = nil
+            @configuration = nil
+          end
+
+          ##
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+             @version.delete('DELETE', @uri)
+          end
+
+          ##
+          # Fetch the ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            payload = @version.fetch('GET', @uri)
+
+            ServiceInstance.new(@version, payload, sid: @solution[:sid], )
+          end
+
+          ##
+          # Access the conversations
+          # @return [ConversationList]
+          # @return [ConversationContext] if sid was passed.
+          def conversations(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return ConversationContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @conversations
+              @conversations = ConversationList.new(@version, chat_service_sid: @solution[:sid], )
+            end
+
+            @conversations
+          end
+
+          ##
+          # Access the bindings
+          # @return [BindingList]
+          # @return [BindingContext] if sid was passed.
+          def bindings(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return BindingContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @bindings
+              @bindings = BindingList.new(@version, chat_service_sid: @solution[:sid], )
+            end
+
+            @bindings
+          end
+
+          ##
+          # Access the users
+          # @return [UserList]
+          # @return [UserContext] if sid was passed.
+          def users(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return UserContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @users
+              @users = UserList.new(@version, chat_service_sid: @solution[:sid], )
+            end
+
+            @users
+          end
+
+          ##
+          # Access the roles
+          # @return [RoleList]
+          # @return [RoleContext] if sid was passed.
+          def roles(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return RoleContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @roles
+              @roles = RoleList.new(@version, chat_service_sid: @solution[:sid], )
+            end
+
+            @roles
+          end
+
+          ##
+          # Access the configuration
+          # @return [ConfigurationList]
+          # @return [ConfigurationContext]
+          def configuration
+            ConfigurationContext.new(@version, @solution[:sid], )
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ServiceContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Conversations.V1.ServiceContext #{context}>"
+          end
+        end
+
+        class ServiceInstance < InstanceResource
+          ##
+          # Initialize the ServiceInstance
+          # @param [Version] version Version that contains the resource
+          # @param [Hash] payload payload that contains response from Twilio
+          # @param [String] sid A 34 character string that uniquely identifies this
+          #   resource.
+          # @return [ServiceInstance] ServiceInstance
+          def initialize(version, payload, sid: nil)
+            super(version)
+
+            # Marshaled Properties
+            @properties = {
+                'account_sid' => payload['account_sid'],
+                'sid' => payload['sid'],
+                'friendly_name' => payload['friendly_name'],
+                'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                'url' => payload['url'],
+                'links' => payload['links'],
+            }
+
+            # 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 [ServiceContext] ServiceContext for this ServiceInstance
+          def context
+            unless @instance_context
+              @instance_context = ServiceContext.new(@version, @params['sid'], )
+            end
+            @instance_context
+          end
+
+          ##
+          # @return [String] The unique ID of the Account responsible for this service.
+          def account_sid
+            @properties['account_sid']
+          end
+
+          ##
+          # @return [String] A 34 character string that uniquely identifies this resource.
+          def sid
+            @properties['sid']
+          end
+
+          ##
+          # @return [String] The human-readable name of this service.
+          def friendly_name
+            @properties['friendly_name']
+          end
+
+          ##
+          # @return [Time] The date that this resource was created.
+          def date_created
+            @properties['date_created']
+          end
+
+          ##
+          # @return [Time] The date that this resource was last updated.
+          def date_updated
+            @properties['date_updated']
+          end
+
+          ##
+          # @return [String] An absolute URL for this service.
+          def url
+            @properties['url']
+          end
+
+          ##
+          # @return [String] Absolute URLs to access the conversations, users, roles, bindings and configuration of this service.
+          def links
+            @properties['links']
+          end
+
+          ##
+          # Delete the ServiceInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
+          def delete
+            context.delete
+          end
+
+          ##
+          # Fetch the ServiceInstance
+          # @return [ServiceInstance] Fetched ServiceInstance
+          def fetch
+            context.fetch
+          end
+
+          ##
+          # Access the conversations
+          # @return [conversations] conversations
+          def conversations
+            context.conversations
+          end
+
+          ##
+          # Access the bindings
+          # @return [bindings] bindings
+          def bindings
+            context.bindings
+          end
+
+          ##
+          # Access the users
+          # @return [users] users
+          def users
+            context.users
+          end
+
+          ##
+          # Access the roles
+          # @return [roles] roles
+          def roles
+            context.roles
+          end
+
+          ##
+          # Access the configuration
+          # @return [configuration] configuration
+          def configuration
+            context.configuration
+          end
+
+          ##
+          # Provide a user friendly representation
+          def to_s
+            values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.ServiceInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Conversations.V1.ServiceInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end