twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/{preview/proxy/service/phone_number.rb → numbers/v2/regulatory_compliance/end_user.rb}

@@ -3,47 +3,50 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Proxy < Version
-        class ServiceContext < InstanceContext
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class PhoneNumberList < ListResource
-            ##
-            # Initialize the PhoneNumberList
+    class Numbers < Domain
+      class V2 < Version
+        class RegulatoryComplianceList < ListResource
+          class EndUserList < ListResource
+            ##
+            # Initialize the EndUserList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service.
-            # @return [PhoneNumberList] PhoneNumberList
-            def initialize(version, service_sid: nil)
+            # @return [EndUserList] EndUserList
+            def initialize(version)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers"
+              @solution = {}
+              @uri = "/RegulatoryCompliance/EndUsers"
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] sid The phone-number Sid that uniquely identifies this resource
-            # @return [PhoneNumberInstance] Newly created PhoneNumberInstance
-            def create(sid: nil)
-              data = Twilio::Values.of({'Sid' => sid})
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+            # Create the EndUserInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   resource.
+            # @param [end_user.Type] type The type of end user of the Bundle resource - can be
+            #   `individual` or `business`.
+            # @param [Hash] attributes The set of parameters that are the attributes of the
+            #   End User resource which are derived End User Types.
+            # @return [EndUserInstance] Created EndUserInstance
+            def create(friendly_name: nil, type: nil, attributes: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'Type' => type,
+                  'Attributes' => Twilio.serialize_object(attributes),
+              })
+
+              payload = @version.create('POST', @uri, data: data)
 
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              EndUserInstance.new(@version, payload, )
             end
 
             ##
-            # Lists PhoneNumberInstance records from the API as a list.
+            # Lists EndUserInstance 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()
@@ -58,7 +61,7 @@ module Twilio
             end
 
             ##
-            # Streams PhoneNumberInstance records from the API as an Enumerable.
+            # Streams EndUserInstance 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()
@@ -71,19 +74,19 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[: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 PhoneNumberInstance records from the API.
+            # When passed a block, yields EndUserInstance 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])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -91,55 +94,51 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
+            # Retrieve a single page of EndUserInstance 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 PhoneNumberInstance
+            # @return [Page] Page of EndUserInstance
             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
-              )
-              PhoneNumberPage.new(@version, response, @solution)
+
+              response = @version.page('GET', @uri, params: params)
+
+              EndUserPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of PhoneNumberInstance records from the API.
+            # Retrieve a single page of EndUserInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of PhoneNumberInstance
+            # @return [Page] Page of EndUserInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              PhoneNumberPage.new(@version, response, @solution)
+              EndUserPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Preview.Proxy.PhoneNumberList>'
+              '#<Twilio.Numbers.V2.EndUserList>'
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class PhoneNumberPage < Page
+          class EndUserPage < Page
             ##
-            # Initialize the PhoneNumberPage
+            # Initialize the EndUserPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [PhoneNumberPage] PhoneNumberPage
+            # @return [EndUserPage] EndUserPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -148,189 +147,208 @@ module Twilio
             end
 
             ##
-            # Build an instance of PhoneNumberInstance
+            # Build an instance of EndUserInstance
             # @param [Hash] payload Payload response from the API
-            # @return [PhoneNumberInstance] PhoneNumberInstance
+            # @return [EndUserInstance] EndUserInstance
             def get_instance(payload)
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              EndUserInstance.new(@version, payload, )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Preview.Proxy.PhoneNumberPage>'
+              '<Twilio.Numbers.V2.EndUserPage>'
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class PhoneNumberContext < InstanceContext
+          class EndUserContext < InstanceContext
             ##
-            # Initialize the PhoneNumberContext
+            # Initialize the EndUserContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The phone-number Sid that uniquely identifies this resource
-            # @return [PhoneNumberContext] PhoneNumberContext
-            def initialize(version, service_sid, sid)
+            # @param [String] sid The unique string created by Twilio to identify the End User
+            #   resource.
+            # @return [EndUserContext] EndUserContext
+            def initialize(version, sid)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
-              @uri = "/Services/#{@solution[:service_sid]}/PhoneNumbers/#{@solution[:sid]}"
+              @solution = {sid: sid, }
+              @uri = "/RegulatoryCompliance/EndUsers/#{@solution[:sid]}"
             end
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
+            # Fetch the EndUserInstance
+            # @return [EndUserInstance] Fetched EndUserInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              EndUserInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
-            # Fetch a PhoneNumberInstance
-            # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
-            def fetch
-              params = Twilio::Values.of({})
+            # Update the EndUserInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   resource.
+            # @param [Hash] attributes The set of parameters that are the attributes of the
+            #   End User resource which are derived End User Types.
+            # @return [EndUserInstance] Updated EndUserInstance
+            def update(friendly_name: :unset, attributes: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'Attributes' => Twilio.serialize_object(attributes),
+              })
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              PhoneNumberInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              EndUserInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Delete the EndUserInstance
+            # @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.Preview.Proxy.PhoneNumberContext #{context}>"
+              "#<Twilio.Numbers.V2.EndUserContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Numbers.V2.EndUserContext #{context}>"
             end
           end
 
-          ##
-          # PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-          class PhoneNumberInstance < InstanceResource
+          class EndUserInstance < InstanceResource
             ##
-            # Initialize the PhoneNumberInstance
+            # Initialize the EndUserInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique SID identifier of the Service.
-            # @param [String] sid The phone-number Sid that uniquely identifies this resource
-            # @return [PhoneNumberInstance] PhoneNumberInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
+            # @param [String] sid The unique string created by Twilio to identify the End User
+            #   resource.
+            # @return [EndUserInstance] EndUserInstance
+            def initialize(version, payload, sid: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
-                  'service_sid' => payload['service_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'type' => payload['type'],
+                  'attributes' => payload['attributes'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'phone_number' => payload['phone_number'],
-                  'country_code' => payload['country_code'],
-                  'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @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 [PhoneNumberContext] PhoneNumberContext for this PhoneNumberInstance
+            # @return [EndUserContext] EndUserContext for this EndUserInstance
             def context
               unless @instance_context
-                @instance_context = PhoneNumberContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = EndUserContext.new(@version, @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this resource
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Account Sid.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Service Sid.
-            def service_sid
-              @properties['service_sid']
+            # @return [String] The string that you assigned to describe the resource
+            def friendly_name
+              @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date this resource was created
-            def date_created
-              @properties['date_created']
+            # @return [end_user.Type] The type of end user of the Bundle resource
+            def type
+              @properties['type']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
-            def date_updated
-              @properties['date_updated']
+            # @return [Hash] The set of parameters that compose the End Users resource
+            def attributes
+              @properties['attributes']
             end
 
             ##
-            # @return [String] The phone number
-            def phone_number
-              @properties['phone_number']
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
+            def date_created
+              @properties['date_created']
             end
 
             ##
-            # @return [String] The ISO 3166-1 alpha-2 country code
-            def country_code
-              @properties['country_code']
+            # @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] Indicate if a phone can receive calls or messages
-            def capabilities
-              @properties['capabilities']
+            # @return [String] The absolute URL of the End User resource
+            def url
+              @properties['url']
             end
 
             ##
-            # @return [String] The URL of this resource.
-            def url
-              @properties['url']
+            # Fetch the EndUserInstance
+            # @return [EndUserInstance] Fetched EndUserInstance
+            def fetch
+              context.fetch
             end
 
             ##
-            # Deletes the PhoneNumberInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # Update the EndUserInstance
+            # @param [String] friendly_name The string that you assigned to describe the
+            #   resource.
+            # @param [Hash] attributes The set of parameters that are the attributes of the
+            #   End User resource which are derived End User Types.
+            # @return [EndUserInstance] Updated EndUserInstance
+            def update(friendly_name: :unset, attributes: :unset)
+              context.update(friendly_name: friendly_name, attributes: attributes, )
             end
 
             ##
-            # Fetch a PhoneNumberInstance
-            # @return [PhoneNumberInstance] Fetched PhoneNumberInstance
-            def fetch
-              context.fetch
+            # Delete the EndUserInstance
+            # @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.Preview.Proxy.PhoneNumberInstance #{values}>"
+              "<Twilio.Numbers.V2.EndUserInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Proxy.PhoneNumberInstance #{values}>"
+              "<Twilio.Numbers.V2.EndUserInstance #{values}>"
             end
           end
         end