twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,715 @@
+##
+#    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 V2 < Version
+                class ApplicationList < ListResource
+                
+                    class CreateShortCodeApplicationRequest
+                            # @param [friendly_name]: [String] The friendly name for the short code application.
+                            # @param [iso_country]: [String] The ISO country code.
+                            # @param [business_information]: [ApplicationList.CreateShortCodeApplicationRequestBusinessInformation] 
+                            # @param [setup]: [ApplicationList.CreateShortCodeApplicationRequestSetup] 
+                        attr_accessor :friendly_name, :iso_country, :business_information, :setup
+                        def initialize(payload)
+                                @friendly_name = payload["friendly_name"]
+                                @iso_country = payload["iso_country"]
+                                @business_information = payload["business_information"]
+                                @setup = payload["setup"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "friendly_name": @friendly_name,
+                                "iso_country": @iso_country,
+                                "business_information": @business_information,
+                                "setup": @setup,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateShortCodeApplicationRequestBusinessInformation
+                            # @param [customer_facing_profile]: [String] The Compliance Profile SID for the customer-facing business profile.
+                        attr_accessor :customer_facing_profile
+                        def initialize(payload)
+                                @customer_facing_profile = payload["customer_facing_profile"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "customer_facing_profile": @customer_facing_profile,
+                        }.to_json(options)
+                        end
+                    end
+
+                    class CreateShortCodeApplicationRequestSetup
+                            # @param [charges_apply]: [Boolean] 
+                        attr_accessor :charges_apply
+                        def initialize(payload)
+                                @charges_apply = payload["charges_apply"]
+                        end
+                        def to_json(options = {})
+                        {
+                                "charges_apply": @charges_apply,
+                        }.to_json(options)
+                        end
+                    end
+
+
+                    ##
+                    # Initialize the ApplicationList
+                    # @param [Version] version Version that contains the resource
+                    # @return [ApplicationList] ApplicationList
+                    def initialize(version)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/ShortCodes/Applications"
+                        
+                    end
+                    ##
+                    # Create the ApplicationInstance
+                    # @param [CreateShortCodeApplicationRequest] create_short_code_application_request 
+                    # @return [ApplicationInstance] Created ApplicationInstance
+                    def create(create_short_code_application_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: create_short_code_application_request.to_json)
+                        ApplicationInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the ApplicationInstanceMetadata
+                    # @param [CreateShortCodeApplicationRequest] create_short_code_application_request 
+                    # @return [ApplicationInstance] Created ApplicationInstance
+                    def create_with_metadata(create_short_code_application_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: create_short_code_application_request.to_json)
+                        application_instance = ApplicationInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        ApplicationInstanceMetadata.new(
+                            @version,
+                            application_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+                    ##
+                    # 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
+                    #    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(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
+                    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] 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
+                    #    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(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], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # 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
+                    #    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(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],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ApplicationPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
+                    ##
+                    # When passed a block, yields ApplicationInstance 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], )
+
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
+                    end
+
+                    ##
+                    # 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(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,
+                        })
+                        headers = Twilio::Values.of({})
+                        
+                        
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ApplicationPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of ApplicationInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of ApplicationInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    ApplicationPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V2.ApplicationList>'
+                    end
+                end
+
+
+                class ApplicationContext < InstanceContext
+                    ##
+                    # Initialize the ApplicationContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid The unique string that identifies the Short Code Application resource.
+                    # @return [ApplicationContext] ApplicationContext
+                    def initialize(version, sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/ShortCodes/Applications/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the ApplicationInstance
+                    # @return [ApplicationInstance] Fetched ApplicationInstance
+                    def fetch
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        ApplicationInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+                    ##
+                    # Fetch the ApplicationInstanceMetadata
+                    # @return [ApplicationInstance] Fetched ApplicationInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        application_instance = ApplicationInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        ApplicationInstanceMetadata.new(
+                            @version,
+                            application_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V2.ApplicationContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V2.ApplicationContext #{context}>"
+                    end
+                end
+
+                class ApplicationInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ApplicationInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ApplicationInstance] application_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [ApplicationInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, application_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @application_instance = application_instance
+                    end
+
+                    def application
+                        @application_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ApplicationInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ApplicationListResponse < InstanceListResource
+                    # @param [Array<ApplicationInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @application_instance = payload.body[key].map do |data|
+                        ApplicationInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def application_instance
+                          @instance
+                      end
+                  end
+
+                class ApplicationPage < Page
+                    ##
+                    # Initialize the ApplicationPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [ApplicationPage] ApplicationPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of ApplicationInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [ApplicationInstance] ApplicationInstance
+                    def get_instance(payload)
+                        ApplicationInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V2.ApplicationPage>'
+                    end
+                end
+
+                class ApplicationPageMetadata < PageMetadata
+                    attr_reader :application_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @application_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @application_page << ApplicationListResponse.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
+                        @application_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V2PageMetadata>';
+                    end
+                end
+                class ApplicationListResponse < InstanceListResource
+
+                    # @param [Array<ApplicationInstance>] 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
+                      @application = data_list.map do |data|
+                        ApplicationInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def application
+                        @application
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class ApplicationInstance < InstanceResource
+                    ##
+                    # Initialize the ApplicationInstance
+                    # @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 Application
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [ApplicationInstance] ApplicationInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['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
+                        @instance_context = nil
+                        @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 [ApplicationContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = ApplicationContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The unique identifier of the Short Code Application.
+                    def sid
+                        @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
+                        @properties['bundle_sid']
+                    end
+                    
+                    ##
+                    # @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
+                    
+                    ##
+                    # @return [String] The friendly name of the application.
+                    def friendly_name
+                        @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
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [String] The state of the application.
+                    def state
+                        @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
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V2.ApplicationInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V2.ApplicationInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end