twilio-ruby 7.10.3 → 7.10.5

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.rb

@@ -23,12 +23,14 @@ module Twilio
                     @version = 'v1'
                     @bulk_eligibilities = nil
                     @eligibilities = nil
+                    @embedded_sessions = nil
                     @porting_all_port_ins = nil
                     @porting_port_ins = nil
                     @porting_port_in_phone_number = nil
                     @porting_portabilities = nil
                     @porting_webhook_configurations = nil
                     @porting_webhook_configurations_delete = nil
+                    @sender_id_registrations = nil
                     @signing_request_configurations = nil
                     @webhook = nil
                 end
@@ -53,6 +55,11 @@ module Twilio
                     @eligibilities ||= EligibilityList.new self
                 end
                 ##
+                # @return [Twilio::REST::Numbers::V1::EmbeddedSessionList]
+                def embedded_sessions
+                    @embedded_sessions ||= EmbeddedSessionList.new self
+                end
+                ##
                 # @return [Twilio::REST::Numbers::V1::PortingAllPortInList]
                 def porting_all_port_ins
                     @porting_all_port_ins ||= PortingAllPortInList.new self
@@ -141,6 +148,11 @@ module Twilio
                     end
                 end
                 ##
+                # @return [Twilio::REST::Numbers::V1::SenderIdRegistrationList]
+                def sender_id_registrations
+                    @sender_id_registrations ||= SenderIdRegistrationList.new self
+                end
+                ##
                 # @return [Twilio::REST::Numbers::V1::SigningRequestConfigurationList]
                 def signing_request_configurations
                     @signing_request_configurations ||= SigningRequestConfigurationList.new self

data/lib/twilio-ruby/rest/numbers/v2/application.rb

@@ -131,6 +131,11 @@ module Twilio
                     # Lists ApplicationInstance records from the API as a list.
                     # Unlike stream(), this operation is eager and will load `limit` records into
                     # memory before returning.
+                    # @param [String] account_sid The Account SID to filter by.
+                    # @param [String] iso_country The ISO country to filter by.
+                    # @param [String] status The application status to filter by.
+                    # @param [String] friendly_name The friendly name to filter by.
+                    # @param [String] sid The application SID to filter by.
                     # @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
@@ -138,8 +143,13 @@ module Twilio
                     #    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(limit: nil, page_size: nil)
+                    def list(account_sid: :unset, iso_country: :unset, status: :unset, friendly_name: :unset, sid: :unset, limit: nil, page_size: nil)
                         self.stream(
+                            account_sid: account_sid,
+                            iso_country: iso_country,
+                            status: status,
+                            friendly_name: friendly_name,
+                            sid: sid,
                             limit: limit,
                             page_size: page_size
                         ).entries
@@ -149,6 +159,11 @@ module Twilio
                     # 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] account_sid The Account SID to filter by.
+                    # @param [String] iso_country The ISO country to filter by.
+                    # @param [String] status The application status to filter by.
+                    # @param [String] friendly_name The friendly name to filter by.
+                    # @param [String] sid The application SID to filter by.
                     # @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
@@ -156,10 +171,15 @@ module Twilio
                     #    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(limit: nil, page_size: nil)
+                    def stream(account_sid: :unset, iso_country: :unset, status: :unset, friendly_name: :unset, sid: :unset, limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
 
                         page = self.page(
+                            account_sid: account_sid,
+                            iso_country: iso_country,
+                            status: status,
+                            friendly_name: friendly_name,
+                            sid: sid,
                             page_size: limits[:page_size], )
 
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
@@ -167,6 +187,11 @@ module Twilio
 
                     ##
                     # Lists ApplicationPageMetadata records from the API as a list.
+                      # @param [String] account_sid The Account SID to filter by.
+                      # @param [String] iso_country The ISO country to filter by.
+                      # @param [String] status The application status to filter by.
+                      # @param [String] friendly_name The friendly name to filter by.
+                      # @param [String] sid The application SID to filter by.
                     # @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
@@ -174,9 +199,14 @@ module Twilio
                     #    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(limit: nil, page_size: nil)
+                    def list_with_metadata(account_sid: :unset, iso_country: :unset, status: :unset, friendly_name: :unset, sid: :unset, limit: nil, page_size: nil)
                         limits = @version.read_limits(limit, page_size)
                         params = Twilio::Values.of({
+                            'AccountSid' => account_sid,
+                            'IsoCountry' => iso_country,
+                            'Status' => status,
+                            'FriendlyName' => friendly_name,
+                            'Sid' => sid,
                             
                             'PageSize' => limits[:page_size],
                         });
@@ -204,12 +234,22 @@ module Twilio
                     ##
                     # Retrieve a single page of ApplicationInstance records from the API.
                     # Request is executed immediately.
+                    # @param [String] account_sid The Account SID to filter by.
+                    # @param [String] iso_country The ISO country to filter by.
+                    # @param [String] status The application status to filter by.
+                    # @param [String] friendly_name The friendly name to filter by.
+                    # @param [String] sid The application SID to filter by.
                     # @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 ApplicationInstance
-                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
+                    def page(account_sid: :unset, iso_country: :unset, status: :unset, friendly_name: :unset, sid: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
+                            'AccountSid' => account_sid,
+                            'IsoCountry' => iso_country,
+                            'Status' => status,
+                            'FriendlyName' => friendly_name,
+                            'Sid' => sid,
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
@@ -474,11 +514,26 @@ module Twilio
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
-                            'bundle_sid' => payload['bundle_sid'],
                             'application_requirements_sid' => payload['application_requirements_sid'],
+                            'application_requirements_version' => payload['application_requirements_version'] == nil ? payload['application_requirements_version'] : payload['application_requirements_version'].to_i,
+                            'account_sid' => payload['account_sid'],
+                            'bundle_sid' => payload['bundle_sid'],
+                            'reviewer' => payload['reviewer'],
+                            'zendesk_ticket_id' => payload['zendesk_ticket_id'],
                             'friendly_name' => payload['friendly_name'],
+                            'notification_emails' => payload['notification_emails'],
                             'iso_country' => payload['iso_country'],
                             'state' => payload['state'],
+                            'setup' => payload['setup'],
+                            'business_information' => payload['business_information'],
+                            'user_sign_up' => payload['user_sign_up'],
+                            'compliance_keywords' => payload['compliance_keywords'],
+                            'content_examples' => payload['content_examples'],
+                            'sms_campaign_details' => payload['sms_campaign_details'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                            'created_by' => payload['created_by'],
+                            'updated_by' => payload['updated_by'],
                         }
 
                         # Context
@@ -503,6 +558,24 @@ module Twilio
                         @properties['sid']
                     end
                     
+                    ##
+                    # @return [String] The Application Requirements SID.
+                    def application_requirements_sid
+                        @properties['application_requirements_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The version of the application requirements.
+                    def application_requirements_version
+                        @properties['application_requirements_version']
+                    end
+                    
+                    ##
+                    # @return [String] The Account SID associated with the application.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
                     ##
                     # @return [String] The Bundle SID for regulatory compliance.
                     def bundle_sid
@@ -510,9 +583,15 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The Application Requirements SID.
-                    def application_requirements_sid
-                        @properties['application_requirements_sid']
+                    # @return [String] The reviewer of the application.
+                    def reviewer
+                        @properties['reviewer']
+                    end
+                    
+                    ##
+                    # @return [String] The Zendesk ticket ID associated with the application.
+                    def zendesk_ticket_id
+                        @properties['zendesk_ticket_id']
                     end
                     
                     ##
@@ -521,6 +600,12 @@ module Twilio
                         @properties['friendly_name']
                     end
                     
+                    ##
+                    # @return [Array<String>] The notification emails for the application.
+                    def notification_emails
+                        @properties['notification_emails']
+                    end
+                    
                     ##
                     # @return [String] The ISO country code.
                     def iso_country
@@ -533,6 +618,66 @@ module Twilio
                         @properties['state']
                     end
                     
+                    ##
+                    # @return [CreateShortCodeApplicationResponseSetup] 
+                    def setup
+                        @properties['setup']
+                    end
+                    
+                    ##
+                    # @return [CreateShortCodeApplicationResponseBusinessInformation] 
+                    def business_information
+                        @properties['business_information']
+                    end
+                    
+                    ##
+                    # @return [CreateShortCodeApplicationResponseUserSignUp] 
+                    def user_sign_up
+                        @properties['user_sign_up']
+                    end
+                    
+                    ##
+                    # @return [CreateShortCodeApplicationResponseComplianceKeywords] 
+                    def compliance_keywords
+                        @properties['compliance_keywords']
+                    end
+                    
+                    ##
+                    # @return [CreateShortCodeApplicationResponseContentExamples] 
+                    def content_examples
+                        @properties['content_examples']
+                    end
+                    
+                    ##
+                    # @return [CreateShortCodeApplicationResponseSmsCampaignDetails] 
+                    def sms_campaign_details
+                        @properties['sms_campaign_details']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time the application was created.
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] The date and time the application was last updated.
+                    def date_updated
+                        @properties['date_updated']
+                    end
+                    
+                    ##
+                    # @return [String] The identity of the user who created the application.
+                    def created_by
+                        @properties['created_by']
+                    end
+                    
+                    ##
+                    # @return [String] The identity of the user who last updated the application.
+                    def updated_by
+                        @properties['updated_by']
+                    end
+                    
                     ##
                     # Fetch the ApplicationInstance
                     # @return [ApplicationInstance] Fetched ApplicationInstance