twilio-ruby 4.6.1 → 6.9.0

data/lib/twilio-ruby/rest/trusthub/v1/customer_profiles/customer_profiles_channel_endpoint_assignment.rb

@@ -0,0 +1,364 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Trusthub
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Trusthub < TrusthubBase
+            class V1 < Version
+                class CustomerProfilesContext < InstanceContext
+
+                     class CustomerProfilesChannelEndpointAssignmentList < ListResource
+                    ##
+                    # Initialize the CustomerProfilesChannelEndpointAssignmentList
+                    # @param [Version] version Version that contains the resource
+                    # @return [CustomerProfilesChannelEndpointAssignmentList] CustomerProfilesChannelEndpointAssignmentList
+                    def initialize(version, customer_profile_sid: nil)
+                        super(version)
+                        # Path Solution
+                        @solution = { customer_profile_sid: customer_profile_sid }
+                        @uri = "/CustomerProfiles/#{@solution[:customer_profile_sid]}/ChannelEndpointAssignments"
+                        
+                    end
+                    ##
+                    # Create the CustomerProfilesChannelEndpointAssignmentInstance
+                    # @param [String] channel_endpoint_type The type of channel endpoint. eg: phone-number
+                    # @param [String] channel_endpoint_sid The SID of an channel endpoint
+                    # @return [CustomerProfilesChannelEndpointAssignmentInstance] Created CustomerProfilesChannelEndpointAssignmentInstance
+                    def create(
+                        channel_endpoint_type: nil, 
+                        channel_endpoint_sid: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'ChannelEndpointType' => channel_endpoint_type,
+                            'ChannelEndpointSid' => channel_endpoint_sid,
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        CustomerProfilesChannelEndpointAssignmentInstance.new(
+                            @version,
+                            payload,
+                            customer_profile_sid: @solution[:customer_profile_sid],
+                        )
+                    end
+
+                
+                    ##
+                    # Lists CustomerProfilesChannelEndpointAssignmentInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [String] channel_endpoint_sid The SID of an channel endpoint
+                    # @param [String] channel_endpoint_sids comma separated list of channel endpoint sids
+                    # @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(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil)
+                        self.stream(
+                            channel_endpoint_sid: channel_endpoint_sid,
+                            channel_endpoint_sids: channel_endpoint_sids,
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [String] channel_endpoint_sid The SID of an channel endpoint
+                    # @param [String] channel_endpoint_sids comma separated list of channel endpoint sids
+                    # @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(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            channel_endpoint_sid: channel_endpoint_sid,
+                            channel_endpoint_sids: channel_endpoint_sids,
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields CustomerProfilesChannelEndpointAssignmentInstance 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 CustomerProfilesChannelEndpointAssignmentInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] channel_endpoint_sid The SID of an channel endpoint
+                    # @param [String] channel_endpoint_sids comma separated list of channel endpoint sids
+                    # @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 CustomerProfilesChannelEndpointAssignmentInstance
+                    def page(channel_endpoint_sid: :unset, channel_endpoint_sids: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'ChannelEndpointSid' => channel_endpoint_sid,
+                            'ChannelEndpointSids' => channel_endpoint_sids,
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+
+                        response = @version.page('GET', @uri, params: params)
+
+                        CustomerProfilesChannelEndpointAssignmentPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of CustomerProfilesChannelEndpointAssignmentInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of CustomerProfilesChannelEndpointAssignmentInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    CustomerProfilesChannelEndpointAssignmentPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentList>'
+                    end
+                end
+
+
+                class CustomerProfilesChannelEndpointAssignmentContext < InstanceContext
+                    ##
+                    # Initialize the CustomerProfilesChannelEndpointAssignmentContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] customer_profile_sid The unique string that we created to identify the CustomerProfile resource.
+                    # @param [String] sid The unique string that we created to identify the resource.
+                    # @return [CustomerProfilesChannelEndpointAssignmentContext] CustomerProfilesChannelEndpointAssignmentContext
+                    def initialize(version, customer_profile_sid, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { customer_profile_sid: customer_profile_sid, sid: sid,  }
+                        @uri = "/CustomerProfiles/#{@solution[:customer_profile_sid]}/ChannelEndpointAssignments/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Delete the CustomerProfilesChannelEndpointAssignmentInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        @version.delete('DELETE', @uri)
+                    end
+
+                    ##
+                    # Fetch the CustomerProfilesChannelEndpointAssignmentInstance
+                    # @return [CustomerProfilesChannelEndpointAssignmentInstance] Fetched CustomerProfilesChannelEndpointAssignmentInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        CustomerProfilesChannelEndpointAssignmentInstance.new(
+                            @version,
+                            payload,
+                            customer_profile_sid: @solution[:customer_profile_sid],
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentContext #{context}>"
+                    end
+                end
+
+                class CustomerProfilesChannelEndpointAssignmentPage < Page
+                    ##
+                    # Initialize the CustomerProfilesChannelEndpointAssignmentPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [CustomerProfilesChannelEndpointAssignmentPage] CustomerProfilesChannelEndpointAssignmentPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of CustomerProfilesChannelEndpointAssignmentInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [CustomerProfilesChannelEndpointAssignmentInstance] CustomerProfilesChannelEndpointAssignmentInstance
+                    def get_instance(payload)
+                        CustomerProfilesChannelEndpointAssignmentInstance.new(@version, payload, customer_profile_sid: @solution[:customer_profile_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentPage>'
+                    end
+                end
+                class CustomerProfilesChannelEndpointAssignmentInstance < InstanceResource
+                    ##
+                    # Initialize the CustomerProfilesChannelEndpointAssignmentInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this CustomerProfilesChannelEndpointAssignment
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [CustomerProfilesChannelEndpointAssignmentInstance] CustomerProfilesChannelEndpointAssignmentInstance
+                    def initialize(version, payload , customer_profile_sid: nil, sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'customer_profile_sid' => payload['customer_profile_sid'],
+                            'account_sid' => payload['account_sid'],
+                            'channel_endpoint_type' => payload['channel_endpoint_type'],
+                            'channel_endpoint_sid' => payload['channel_endpoint_sid'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'customer_profile_sid' => customer_profile_sid  || @properties['customer_profile_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 [CustomerProfilesChannelEndpointAssignmentContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = CustomerProfilesChannelEndpointAssignmentContext.new(@version , @params['customer_profile_sid'], @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the Item Assignment resource.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [String] The unique string that we created to identify the CustomerProfile resource.
+                    def customer_profile_sid
+                        @properties['customer_profile_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Item Assignment resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The type of channel endpoint. eg: phone-number
+                    def channel_endpoint_type
+                        @properties['channel_endpoint_type']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of an channel endpoint
+                    def channel_endpoint_sid
+                        @properties['channel_endpoint_sid']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Identity resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Delete the CustomerProfilesChannelEndpointAssignmentInstance
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete
+
+                        context.delete
+                    end
+
+                    ##
+                    # Fetch the CustomerProfilesChannelEndpointAssignmentInstance
+                    # @return [CustomerProfilesChannelEndpointAssignmentInstance] Fetched CustomerProfilesChannelEndpointAssignmentInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Trusthub.V1.CustomerProfilesChannelEndpointAssignmentInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+