twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/numbers/v1/sender_id_registration.rb

@@ -0,0 +1,333 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Numbers
+#    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 Numbers < NumbersBase
+            class V1 < Version
+                class SenderIdRegistrationList < ListResource
+                
+                    class NumbersV1CreateEmbeddedRegistrationRequest
+                            # @param [regulation_id]: [String] The regulation for this registration.
+                            # @param [regulation_version]: [String] The regulation version.
+                            # @param [friendly_name]: [String] Human-readable name for the registration.
+                            # @param [status_notification_email]: [String] Email address for registration status notifications.
+                            # @param [status_callback_url]: [String] The URL of this resource.
+                            # @param [comments]: [String] Additional comments about the registration.
+                            # @param [theme_set_id]: [String] Theme ID for the Compliance Embeddable UI.
+                            # @param [data]: [Hash<String, Object>] Registration data organized by section (alphanumericSender, business, useCase, authorizedRepresentative, officer, businessAddress).
+                        attr_accessor :regulation_id, :regulation_version, :friendly_name, :status_notification_email, :status_callback_url, :comments, :theme_set_id, :data
+                        def initialize(payload)
+                                @regulation_id = payload["regulation_id"]
+                                @regulation_version = payload["regulation_version"]
+                                @friendly_name = payload["friendly_name"]
+                                @status_notification_email = payload["status_notification_email"]
+                                @status_callback_url = payload["status_callback_url"]
+                                @comments = payload["comments"]
+                                @theme_set_id = payload["theme_set_id"]
+                                @data = payload["data"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "regulationId": @regulation_id,
+                                "regulationVersion": @regulation_version,
+                                "friendlyName": @friendly_name,
+                                "statusNotificationEmail": @status_notification_email,
+                                "statusCallbackUrl": @status_callback_url,
+                                "comments": @comments,
+                                "themeSetId": @theme_set_id,
+                                "data": @data,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the SenderIdRegistrationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [SenderIdRegistrationList] SenderIdRegistrationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/SenderIdRegistrations"
+                        
+                    end
+                    ##
+                    # Create the SenderIdRegistrationInstance
+                    # @param [NumbersV1CreateEmbeddedRegistrationRequest] numbers_v1_create_embedded_registration_request 
+                    # @return [SenderIdRegistrationInstance] Created SenderIdRegistrationInstance
+                    def create(numbers_v1_create_embedded_registration_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: numbers_v1_create_embedded_registration_request.to_json)
+                        SenderIdRegistrationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the SenderIdRegistrationInstanceMetadata
+                    # @param [NumbersV1CreateEmbeddedRegistrationRequest] numbers_v1_create_embedded_registration_request 
+                    # @return [SenderIdRegistrationInstance] Created SenderIdRegistrationInstance
+                    def create_with_metadata(numbers_v1_create_embedded_registration_request: nil
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: numbers_v1_create_embedded_registration_request.to_json)
+                        sender_id_registration_instance = SenderIdRegistrationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SenderIdRegistrationInstanceMetadata.new(
+                            @version,
+                            sender_id_registration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.SenderIdRegistrationList>'
+                    end
+                end
+
+                class SenderIdRegistrationPage < Page
+                    ##
+                    # Initialize the SenderIdRegistrationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [SenderIdRegistrationPage] SenderIdRegistrationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of SenderIdRegistrationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [SenderIdRegistrationInstance] SenderIdRegistrationInstance
+                    def get_instance(payload)
+                        SenderIdRegistrationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.SenderIdRegistrationPage>'
+                    end
+                end
+
+                class SenderIdRegistrationPageMetadata < PageMetadata
+                    attr_reader :sender_id_registration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @sender_id_registration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @sender_id_registration_page << SenderIdRegistrationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @sender_id_registration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class SenderIdRegistrationListResponse < InstanceListResource
+
+                    # @param [Array<SenderIdRegistrationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @sender_id_registration = data_list.map do |data|
+                        SenderIdRegistrationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def sender_id_registration
+                        @sender_id_registration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class SenderIdRegistrationInstance < InstanceResource
+                    ##
+                    # Initialize the SenderIdRegistrationInstance
+                    # @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 SenderIdRegistration
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [SenderIdRegistrationInstance] SenderIdRegistrationInstance
+                    def initialize(version, payload )
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'id' => payload['id'],
+                            'regulation_id' => payload['regulation_id'],
+                            'regulation_version' => payload['regulation_version'] == nil ? payload['regulation_version'] : payload['regulation_version'].to_i,
+                            'friendly_name' => payload['friendly_name'],
+                            'status' => payload['status'],
+                            'status_notification_email' => payload['status_notification_email'],
+                            'status_callback_url' => payload['status_callback_url'],
+                            'comments' => payload['comments'],
+                            'embedded_session' => payload['embedded_session'],
+                            'data' => payload['data'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] Registration identifier (BU-prefixed).
+                    def id
+                        @properties['id']
+                    end
+                    
+                    ##
+                    # @return [String] The regulation ID for this registration.
+                    def regulation_id
+                        @properties['regulation_id']
+                    end
+                    
+                    ##
+                    # @return [String] The regulation version.
+                    def regulation_version
+                        @properties['regulation_version']
+                    end
+                    
+                    ##
+                    # @return [String] The friendly name provided in the request.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] Registration status. Always DRAFT on creation.
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [String] Email address for status notifications.
+                    def status_notification_email
+                        @properties['status_notification_email']
+                    end
+                    
+                    ##
+                    # @return [String] Callback URL for status webhooks.
+                    def status_callback_url
+                        @properties['status_callback_url']
+                    end
+                    
+                    ##
+                    # @return [String] Additional comments.
+                    def comments
+                        @properties['comments']
+                    end
+                    
+                    ##
+                    # @return [NumbersV1EmbeddedSession] 
+                    def embedded_session
+                        @properties['embedded_session']
+                    end
+                    
+                    ##
+                    # @return [Hash<String, Object>] Registration data echoed from the request.
+                    def data
+                        @properties['data']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp of creation.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] Timestamp of last update.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Numbers.V1.SenderIdRegistrationInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Numbers.V1.SenderIdRegistrationInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/numbers/v1/signing_request_configuration.rb

@@ -25,6 +25,7 @@ module Twilio
                     # @return [SigningRequestConfigurationList] SigningRequestConfigurationList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/SigningRequest/Configuration"
@@ -50,6 +51,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the SigningRequestConfigurationInstanceMetadata
+                    # @param [Object] body 
+                    # @return [SigningRequestConfigurationInstance] Created SigningRequestConfigurationInstance
+                    def create_with_metadata(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: body.to_json)
+                        signing_request_configuration_instance = SigningRequestConfigurationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        SigningRequestConfigurationInstanceMetadata.new(
+                            @version,
+                            signing_request_configuration_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists SigningRequestConfigurationInstance records from the API as a list.
@@ -97,6 +124,32 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SigningRequestConfigurationPageMetadata records from the API as a list.
+                      # @param [String] country The country ISO code to apply this configuration, this is an optional field, Example: US, MX
+                      # @param [String] product The product or service for which is requesting the signature, this is an optional field, Example: Porting, Hosting
+                    # @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_with_metadata(country: :unset, product: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Country' => country,
+                            'Product' => product,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SigningRequestConfigurationPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SigningRequestConfigurationInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -120,7 +173,7 @@ module Twilio
                     # @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 SigningRequestConfigurationInstance
-                    def page(country: :unset, product: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(country: :unset, product: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Country' => country,
                             'Product' => product,
@@ -167,6 +220,7 @@ module Twilio
                     # @return [SigningRequestConfigurationPage] SigningRequestConfigurationPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -186,6 +240,66 @@ module Twilio
                         '<Twilio.Numbers.V1.SigningRequestConfigurationPage>'
                     end
                 end
+
+                class SigningRequestConfigurationPageMetadata < PageMetadata
+                    attr_reader :signing_request_configuration_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @signing_request_configuration_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @signing_request_configuration_page << SigningRequestConfigurationListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @signing_request_configuration_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class SigningRequestConfigurationListResponse < InstanceListResource
+
+                    # @param [Array<SigningRequestConfigurationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @signing_request_configuration = data_list.map do |data|
+                        SigningRequestConfigurationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def signing_request_configuration
+                        @signing_request_configuration
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SigningRequestConfigurationInstance < InstanceResource
                     ##
                     # Initialize the SigningRequestConfigurationInstance
@@ -199,6 +313,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'logo_sid' => payload['logo_sid'],