twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,392 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Chat < Domain
+      class V2 < Version
+        class ServiceContext < InstanceContext
+          class UserContext < InstanceContext
+            class UserBindingList < ListResource
+              ##
+              # Initialize the UserBindingList
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User
+              #   Binding resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User
+              #   Binding resource.  See {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @return [UserBindingList] UserBindingList
+              def initialize(version, service_sid: nil, user_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, user_sid: user_sid}
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Bindings"
+              end
+
+              ##
+              # Lists UserBindingInstance records from the API as a list.
+              # Unlike stream(), this operation is eager and will load `limit` records into
+              # memory before returning.
+              # @param [Array[user_binding.BindingType]] binding_type The push technology used
+              #   by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See
+              #   {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @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, limit: nil, page_size: nil)
+                self.stream(binding_type: binding_type, limit: limit, page_size: page_size).entries
+              end
+
+              ##
+              # Streams UserBindingInstance records from the API as an Enumerable.
+              # This operation lazily loads records as efficiently as possible until the limit
+              # is reached.
+              # @param [Array[user_binding.BindingType]] binding_type The push technology used
+              #   by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See
+              #   {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @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, limit: nil, page_size: nil)
+                limits = @version.read_limits(limit, page_size)
+
+                page = self.page(binding_type: binding_type, page_size: limits[:page_size], )
+
+                @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+              end
+
+              ##
+              # When passed a block, yields UserBindingInstance 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 UserBindingInstance records from the API.
+              # Request is executed immediately.
+              # @param [Array[user_binding.BindingType]] binding_type The push technology used
+              #   by the User Binding resources to read. Can be: `apn`, `gcm`, or `fcm`.  See
+              #   {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @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 UserBindingInstance
+              def page(binding_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                params = Twilio::Values.of({
+                    'BindingType' => Twilio.serialize_list(binding_type) { |e| e },
+                    'PageToken' => page_token,
+                    'Page' => page_number,
+                    'PageSize' => page_size,
+                })
+
+                response = @version.page('GET', @uri, params: params)
+
+                UserBindingPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Retrieve a single page of UserBindingInstance records from the API.
+              # Request is executed immediately.
+              # @param [String] target_url API-generated URL for the requested results page
+              # @return [Page] Page of UserBindingInstance
+              def get_page(target_url)
+                response = @version.domain.request(
+                    'GET',
+                    target_url
+                )
+                UserBindingPage.new(@version, response, @solution)
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Chat.V2.UserBindingList>'
+              end
+            end
+
+            class UserBindingPage < Page
+              ##
+              # Initialize the UserBindingPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [UserBindingPage] UserBindingPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of UserBindingInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [UserBindingInstance] UserBindingInstance
+              def get_instance(payload)
+                UserBindingInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Chat.V2.UserBindingPage>'
+              end
+            end
+
+            class UserBindingContext < InstanceContext
+              ##
+              # Initialize the UserBindingContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] to fetch the
+              #   User Binding resource from.
+              # @param [String] user_sid The SID of the
+              #   {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User
+              #   Binding resource to fetch.  See {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @param [String] sid The SID of the User Binding resource to fetch.
+              # @return [UserBindingContext] UserBindingContext
+              def initialize(version, service_sid, user_sid, sid)
+                super(version)
+
+                # Path Solution
+                @solution = {service_sid: service_sid, user_sid: user_sid, sid: sid, }
+                @uri = "/Services/#{@solution[:service_sid]}/Users/#{@solution[:user_sid]}/Bindings/#{@solution[:sid]}"
+              end
+
+              ##
+              # Fetch the UserBindingInstance
+              # @return [UserBindingInstance] Fetched UserBindingInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                UserBindingInstance.new(
+                    @version,
+                    payload,
+                    service_sid: @solution[:service_sid],
+                    user_sid: @solution[:user_sid],
+                    sid: @solution[:sid],
+                )
+              end
+
+              ##
+              # Delete the UserBindingInstance
+              # @return [Boolean] true if delete succeeds, false 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.UserBindingContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Chat.V2.UserBindingContext #{context}>"
+              end
+            end
+
+            class UserBindingInstance < InstanceResource
+              ##
+              # Initialize the UserBindingInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] service_sid The SID of the
+              #   {Service}[https://www.twilio.com/docs/chat/rest/service-resource] the User
+              #   Binding resource is associated with.
+              # @param [String] user_sid The SID of the
+              #   {User}[https://www.twilio.com/docs/chat/rest/user-resource] with the User
+              #   Binding resource.  See {push notification
+              #   configuration}[https://www.twilio.com/docs/chat/push-notification-configuration]
+              #   for more info.
+              # @param [String] sid The SID of the User Binding resource to fetch.
+              # @return [UserBindingInstance] UserBindingInstance
+              def initialize(version, payload, service_sid: nil, user_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'],
+                    'user_sid' => payload['user_sid'],
+                    'credential_sid' => payload['credential_sid'],
+                    'binding_type' => payload['binding_type'],
+                    'message_types' => payload['message_types'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'service_sid' => service_sid, 'user_sid' => user_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 [UserBindingContext] UserBindingContext for this UserBindingInstance
+              def context
+                unless @instance_context
+                  @instance_context = UserBindingContext.new(
+                      @version,
+                      @params['service_sid'],
+                      @params['user_sid'],
+                      @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 Service that the resource is associated with
+              def service_sid
+                @properties['service_sid']
+              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] The unique endpoint identifier for the User Binding
+              def endpoint
+                @properties['endpoint']
+              end
+
+              ##
+              # @return [String] The string that identifies the resource's User
+              def identity
+                @properties['identity']
+              end
+
+              ##
+              # @return [String] The SID of the User with the binding
+              def user_sid
+                @properties['user_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Credential for the binding
+              def credential_sid
+                @properties['credential_sid']
+              end
+
+              ##
+              # @return [user_binding.BindingType] The push technology to use for the binding
+              def binding_type
+                @properties['binding_type']
+              end
+
+              ##
+              # @return [Array[String]] The Programmable Chat message types the binding is subscribed to
+              def message_types
+                @properties['message_types']
+              end
+
+              ##
+              # @return [String] The absolute URL of the User Binding resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch the UserBindingInstance
+              # @return [UserBindingInstance] Fetched UserBindingInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Delete the UserBindingInstance
+              # @return [Boolean] true if delete succeeds, false 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.UserBindingInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Chat.V2.UserBindingInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end