twilio-ruby 5.4.2 → 5.4.3

data/lib/twilio-ruby/rest/chat/v2/service/binding.rb

@@ -0,0 +1,344 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+
+module Twilio
+  module REST
+    class Chat < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          class BindingList < ListResource
+            ##
+            # Initialize the BindingList
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The service_sid
+            # @return [BindingList] BindingList
+            def initialize(version, service_sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid}
+              @uri = "/Services/#{@solution[:service_sid]}/Bindings"
+            end
+
+            ##
+            # Lists BindingInstance records from the API as a list.
+            # Unlike stream(), this operation is eager and will load `limit` records into
+            # memory before returning.
+            # @param [binding.BindingType] binding_type The binding_type
+            # @param [String] identity The identity
+            # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
+              self.stream(binding_type: binding_type, identity: identity, limit: limit, page_size: page_size).entries
+            end
+
+            ##
+            # Streams BindingInstance records from the API as an Enumerable.
+            # This operation lazily loads records as efficiently as possible until the limit
+            # is reached.
+            # @param [binding.BindingType] binding_type The binding_type
+            # @param [String] identity The identity
+            # @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(binding_type: :unset, identity: :unset, limit: nil, page_size: nil)
+              limits = @version.read_limits(limit, page_size)
+
+              page = self.page(binding_type: binding_type, identity: identity, page_size: limits[:page_size],)
+
+              @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+            end
+
+            ##
+            # When passed a block, yields BindingInstance 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 BindingInstance records from the API.
+            # Request is executed immediately.
+            # @param [binding.BindingType] binding_type The binding_type
+            # @param [String] identity The identity
+            # @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 BindingInstance
+            def page(binding_type: :unset, identity: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+              params = Twilio::Values.of({
+                  'BindingType' => binding_type,
+                  'Identity' => identity,
+                  'PageToken' => page_token,
+                  'Page' => page_number,
+                  'PageSize' => page_size,
+              })
+              response = @version.page(
+                  'GET',
+                  @uri,
+                  params
+              )
+              BindingPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Retrieve a single page of BindingInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] target_url API-generated URL for the requested results page
+            # @return [Page] Page of BindingInstance
+            def get_page(target_url)
+              response = @version.domain.request(
+                  'GET',
+                  target_url
+              )
+              BindingPage.new(@version, response, @solution)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Chat.V2.BindingList>'
+            end
+          end
+
+          class BindingPage < Page
+            ##
+            # Initialize the BindingPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [BindingPage] BindingPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of BindingInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [BindingInstance] BindingInstance
+            def get_instance(payload)
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid],)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Chat.V2.BindingPage>'
+            end
+          end
+
+          class BindingContext < InstanceContext
+            ##
+            # Initialize the BindingContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
+            # @return [BindingContext] BindingContext
+            def initialize(version, service_sid, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {service_sid: service_sid, sid: sid,}
+              @uri = "/Services/#{@solution[:service_sid]}/Bindings/#{@solution[:sid]}"
+            end
+
+            ##
+            # Fetch a BindingInstance
+            # @return [BindingInstance] Fetched BindingInstance
+            def fetch
+              params = Twilio::Values.of({})
+
+              payload = @version.fetch(
+                  'GET',
+                  @uri,
+                  params,
+              )
+
+              BindingInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid],)
+            end
+
+            ##
+            # Deletes the BindingInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              @version.delete('delete', @uri)
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Chat.V2.BindingContext #{context}>"
+            end
+          end
+
+          class BindingInstance < InstanceResource
+            ##
+            # Initialize the BindingInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] service_sid The service_sid
+            # @param [String] sid The sid
+            # @return [BindingInstance] BindingInstance
+            def initialize(version, payload, service_sid: nil, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'account_sid' => payload['account_sid'],
+                  'service_sid' => payload['service_sid'],
+                  'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                  'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'endpoint' => payload['endpoint'],
+                  'identity' => payload['identity'],
+                  'credential_sid' => payload['credential_sid'],
+                  'binding_type' => payload['binding_type'],
+                  'message_types' => payload['message_types'],
+                  'url' => payload['url'],
+                  'links' => payload['links'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'service_sid' => service_sid, '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 [BindingContext] BindingContext for this BindingInstance
+            def context
+              unless @instance_context
+                @instance_context = BindingContext.new(@version, @params['service_sid'], @params['sid'],)
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] The sid
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [String] The account_sid
+            def account_sid
+              @properties['account_sid']
+            end
+
+            ##
+            # @return [String] The service_sid
+            def service_sid
+              @properties['service_sid']
+            end
+
+            ##
+            # @return [Time] The date_created
+            def date_created
+              @properties['date_created']
+            end
+
+            ##
+            # @return [Time] The date_updated
+            def date_updated
+              @properties['date_updated']
+            end
+
+            ##
+            # @return [String] The endpoint
+            def endpoint
+              @properties['endpoint']
+            end
+
+            ##
+            # @return [String] The identity
+            def identity
+              @properties['identity']
+            end
+
+            ##
+            # @return [String] The credential_sid
+            def credential_sid
+              @properties['credential_sid']
+            end
+
+            ##
+            # @return [binding.BindingType] The binding_type
+            def binding_type
+              @properties['binding_type']
+            end
+
+            ##
+            # @return [String] The message_types
+            def message_types
+              @properties['message_types']
+            end
+
+            ##
+            # @return [String] The url
+            def url
+              @properties['url']
+            end
+
+            ##
+            # @return [String] The links
+            def links
+              @properties['links']
+            end
+
+            ##
+            # Fetch a BindingInstance
+            # @return [BindingInstance] Fetched BindingInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Deletes the BindingInstance
+            # @return [Boolean] true if delete succeeds, true otherwise
+            def delete
+              context.delete
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Chat.V2.BindingInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Chat.V2.BindingInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/chat/v2/service/channel.rb

@@ -19,9 +19,7 @@ module Twilio
               super(version)
 
               # Path Solution
-              @solution = {
-                  service_sid: service_sid
-              }
+              @solution = {service_sid: service_sid}
               @uri = "/Services/#{@solution[:service_sid]}/Channels"
             end
 
@@ -53,11 +51,7 @@ module Twilio
                   data: data
               )
 
-              ChannelInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-              )
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid],)
             end
 
             ##
@@ -73,11 +67,7 @@ module Twilio
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Array] Array of up to limit results
             def list(type: :unset, limit: nil, page_size: nil)
-              self.stream(
-                  type: type,
-                  limit: limit,
-                  page_size: page_size
-              ).entries
+              self.stream(type: type, limit: limit, page_size: page_size).entries
             end
 
             ##
@@ -95,10 +85,7 @@ module Twilio
             def stream(type: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(
-                  type: type,
-                  page_size: limits[:page_size],
-              )
+              page = self.page(type: type, page_size: limits[:page_size],)
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -110,9 +97,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(
-                  page_size: limits[:page_size],
-              )
+              page = self.page(page_size: limits[:page_size],)
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -181,11 +166,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ChannelInstance] ChannelInstance
             def get_instance(payload)
-              ChannelInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-              )
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid],)
             end
 
             ##
@@ -206,10 +187,7 @@ module Twilio
               super(version)
 
               # Path Solution
-              @solution = {
-                  service_sid: service_sid,
-                  sid: sid,
-              }
+              @solution = {service_sid: service_sid, sid: sid,}
               @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:sid]}"
 
               # Dependents
@@ -230,12 +208,7 @@ module Twilio
                   params,
               )
 
-              ChannelInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-                  sid: @solution[:sid],
-              )
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid],)
             end
 
             ##
@@ -270,12 +243,7 @@ module Twilio
                   data: data,
               )
 
-              ChannelInstance.new(
-                  @version,
-                  payload,
-                  service_sid: @solution[:service_sid],
-                  sid: @solution[:sid],
-              )
+              ChannelInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid],)
             end
 
             ##
@@ -286,12 +254,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MemberContext.new(
-                    @version,
-                    @solution[:service_sid],
-                    @solution[:sid],
-                    sid,
-                )
+                return MemberContext.new(@version, @solution[:service_sid], @solution[:sid], sid,)
               end
 
               unless @members
@@ -313,12 +276,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return MessageContext.new(
-                    @version,
-                    @solution[:service_sid],
-                    @solution[:sid],
-                    sid,
-                )
+                return MessageContext.new(@version, @solution[:service_sid], @solution[:sid], sid,)
               end
 
               unless @messages
@@ -340,12 +298,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return InviteContext.new(
-                    @version,
-                    @solution[:service_sid],
-                    @solution[:sid],
-                    sid,
-                )
+                return InviteContext.new(@version, @solution[:service_sid], @solution[:sid], sid,)
               end
 
               unless @invites
@@ -398,10 +351,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {
-                  'service_sid' => service_sid,
-                  'sid' => sid || @properties['sid'],
-              }
+              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'],}
             end
 
             ##
@@ -410,11 +360,7 @@ module Twilio
             # @return [ChannelContext] ChannelContext for this ChannelInstance
             def context
               unless @instance_context
-                @instance_context = ChannelContext.new(
-                    @version,
-                    @params['service_sid'],
-                    @params['sid'],
-                )
+                @instance_context = ChannelContext.new(@version, @params['service_sid'], @params['sid'],)
               end
               @instance_context
             end