twilio-ruby 4.6.1 → 6.9.0

data/lib/twilio-ruby/rest/notify/v1.rb

@@ -0,0 +1,64 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Notify
+#    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 Notify
+            class V1 < Version
+                ##
+                # Initialize the V1 version of Notify
+                def initialize(domain)
+                    super
+                    @version = 'v1'
+                    @credentials = nil
+                    @services = nil
+                end
+
+                ##
+                # @param [String] sid The Twilio-provided string that uniquely identifies the Credential resource to fetch.
+                # @return [Twilio::REST::Notify::V1::CredentialContext] if sid was passed.
+                # @return [Twilio::REST::Notify::V1::CredentialList]
+                def credentials(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @credentials ||= CredentialList.new self
+                    else
+                        CredentialContext.new(self, sid)
+                    end
+                end
+                ##
+                # @param [String] sid The Twilio-provided string that uniquely identifies the Service resource to fetch.
+                # @return [Twilio::REST::Notify::V1::ServiceContext] if sid was passed.
+                # @return [Twilio::REST::Notify::V1::ServiceList]
+                def services(sid=:unset)
+                    if sid.nil?
+                        raise ArgumentError, 'sid cannot be nil'
+                    end
+                    if sid == :unset
+                        @services ||= ServiceList.new self
+                    else
+                        ServiceContext.new(self, sid)
+                    end
+                end
+                ##
+                # Provide a user friendly representation
+                def to_s
+                    '<Twilio::REST::Notify::V1>';
+                end
+            end
+        end
+    end
+end

data/lib/twilio-ruby/rest/notify.rb

@@ -0,0 +1,25 @@
+module Twilio
+  module REST
+    class Notify < NotifyBase
+      ##
+      # @param [String] sid The unique string that we created to identify the Credential
+      #   resource.
+      # @return [Twilio::REST::Notify::V1::CredentialInstance] if sid was passed.
+      # @return [Twilio::REST::Notify::V1::CredentialList]
+      def credentials(sid=:unset)
+        warn "credentials is deprecated. Use v1.credentials instead."
+        self.v1.credentials(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Service
+      #   resource.
+      # @return [Twilio::REST::Notify::V1::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Notify::V1::ServiceList]
+      def services(sid=:unset)
+        warn "services is deprecated. Use v1.services instead."
+        self.v1.services(sid)
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/notify_base.rb

@@ -0,0 +1,38 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class NotifyBase < Domain
+      ##
+      # Initialize notify domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://notify.twilio.com"
+        @host = "notify.twilio.com"
+        @port = 443
+        @v1 = nil
+      end
+
+      def v1
+        @v1 ||= Notify::V1.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Notify::V1>';
+      end
+    end
+  end
+end

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

@@ -0,0 +1,224 @@
+##
+#    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 BulkEligibilityList < ListResource
+                    ##
+                    # Initialize the BulkEligibilityList
+                    # @param [Version] version Version that contains the resource
+                    # @return [BulkEligibilityList] BulkEligibilityList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        
+                        
+                    end
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.BulkEligibilityList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class BulkEligibilityContext < InstanceContext
+                    ##
+                    # Initialize the BulkEligibilityContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] request_id The SID of the bulk eligibility check that you want to know about.
+                    # @return [BulkEligibilityContext] BulkEligibilityContext
+                    def initialize(version, request_id)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { request_id: request_id,  }
+                        @uri = "/HostedNumber/Eligibility/Bulk/#{@solution[:request_id]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the BulkEligibilityInstance
+                    # @return [BulkEligibilityInstance] Fetched BulkEligibilityInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        BulkEligibilityInstance.new(
+                            @version,
+                            payload,
+                            request_id: @solution[:request_id],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.BulkEligibilityContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.BulkEligibilityContext #{context}>"
+                    end
+                end
+
+                class BulkEligibilityPage < Page
+                    ##
+                    # Initialize the BulkEligibilityPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [BulkEligibilityPage] BulkEligibilityPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of BulkEligibilityInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [BulkEligibilityInstance] BulkEligibilityInstance
+                    def get_instance(payload)
+                        BulkEligibilityInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.BulkEligibilityPage>'
+                    end
+                end
+                class BulkEligibilityInstance < InstanceResource
+                    ##
+                    # Initialize the BulkEligibilityInstance
+                    # @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 BulkEligibility
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [BulkEligibilityInstance] BulkEligibilityInstance
+                    def initialize(version, payload , request_id: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'request_id' => payload['request_id'],
+                            'url' => payload['url'],
+                            'results' => payload['results'],
+                            'friendly_name' => payload['friendly_name'],
+                            'status' => payload['status'],
+                            'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
+                            'date_completed' => Twilio.deserialize_iso8601_datetime(payload['date_completed']),
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'request_id' => request_id  || @properties['request_id']  , }
+                    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 [BulkEligibilityContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = BulkEligibilityContext.new(@version , @params['request_id'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the bulk eligibility check that you want to know about.
+                    def request_id
+                        @properties['request_id']
+                    end
+                    
+                    ##
+                    # @return [String] This is the url of the request that you're trying to reach out to locate the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] The result set that contains the eligibility check response for each requested number, each result has at least the following attributes:  phone_number: The requested phone number ,hosting_account_sid: The account sid where the phone number will be hosted, country: Phone number’s country, eligibility_status: Indicates the eligibility status of the PN (Eligible/Ineligible), eligibility_sub_status: Indicates the sub status of the eligibility , ineligibility_reason: Reason for number's ineligibility (if applicable), next_step: Suggested next step in the hosting process based on the eligibility status.
+                    def results
+                        @properties['results']
+                    end
+                    
+                    ##
+                    # @return [String] This is the string that you assigned as a friendly name for describing the eligibility check request.
+                    def friendly_name
+                        @properties['friendly_name']
+                    end
+                    
+                    ##
+                    # @return [String] This is the status of the bulk eligibility check request. (Example: COMPLETE, IN_PROGRESS)
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def date_created
+                        @properties['date_created']
+                    end
+                    
+                    ##
+                    # @return [Time] 
+                    def date_completed
+                        @properties['date_completed']
+                    end
+                    
+                    ##
+                    # Fetch the BulkEligibilityInstance
+                    # @return [BulkEligibilityInstance] Fetched BulkEligibilityInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.BulkEligibilityInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.BulkEligibilityInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end

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

@@ -0,0 +1,229 @@
+##
+#    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 PortingBulkPortabilityList < ListResource
+                    ##
+                    # Initialize the PortingBulkPortabilityList
+                    # @param [Version] version Version that contains the resource
+                    # @return [PortingBulkPortabilityList] PortingBulkPortabilityList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Porting/Portability"
+                        
+                    end
+                    ##
+                    # Create the PortingBulkPortabilityInstance
+                    # @param [Array[String]] phone_numbers The phone numbers which portability is to be checked. This should be a list of strings. Phone numbers are in E.164 format (e.g. +16175551212). .
+                    # @return [PortingBulkPortabilityInstance] Created PortingBulkPortabilityInstance
+                    def create(
+                        phone_numbers: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumbers' => Twilio.serialize_list(phone_numbers) { |e| e },
+                        })
+
+                        payload = @version.create('POST', @uri, data: data)
+                        PortingBulkPortabilityInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.PortingBulkPortabilityList>'
+                    end
+                end
+
+
+                ##
+                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
+                class PortingBulkPortabilityContext < InstanceContext
+                    ##
+                    # Initialize the PortingBulkPortabilityContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] sid A 34 character string that uniquely identifies the Portability check.
+                    # @return [PortingBulkPortabilityContext] PortingBulkPortabilityContext
+                    def initialize(version, sid)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { sid: sid,  }
+                        @uri = "/Porting/Portability/#{@solution[:sid]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the PortingBulkPortabilityInstance
+                    # @return [PortingBulkPortabilityInstance] Fetched PortingBulkPortabilityInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        PortingBulkPortabilityInstance.new(
+                            @version,
+                            payload,
+                            sid: @solution[:sid],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingBulkPortabilityContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Numbers.V1.PortingBulkPortabilityContext #{context}>"
+                    end
+                end
+
+                class PortingBulkPortabilityPage < Page
+                    ##
+                    # Initialize the PortingBulkPortabilityPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [PortingBulkPortabilityPage] PortingBulkPortabilityPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of PortingBulkPortabilityInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [PortingBulkPortabilityInstance] PortingBulkPortabilityInstance
+                    def get_instance(payload)
+                        PortingBulkPortabilityInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Numbers.V1.PortingBulkPortabilityPage>'
+                    end
+                end
+                class PortingBulkPortabilityInstance < InstanceResource
+                    ##
+                    # Initialize the PortingBulkPortabilityInstance
+                    # @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 PortingBulkPortability
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [PortingBulkPortabilityInstance] PortingBulkPortabilityInstance
+                    def initialize(version, payload , sid: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'sid' => payload['sid'],
+                            'status' => payload['status'],
+                            'datetime_created' => Twilio.deserialize_iso8601_datetime(payload['datetime_created']),
+                            'phone_numbers' => payload['phone_numbers'],
+                            'url' => payload['url'],
+                        }
+
+                        # 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 [PortingBulkPortabilityContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = PortingBulkPortabilityContext.new(@version , @params['sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] A 34 character string that uniquely identifies this Portability check.
+                    def sid
+                        @properties['sid']
+                    end
+                    
+                    ##
+                    # @return [Status] 
+                    def status
+                        @properties['status']
+                    end
+                    
+                    ##
+                    # @return [Time] The date that the Portability check was created, given in ISO 8601 format.
+                    def datetime_created
+                        @properties['datetime_created']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] Contains a list with all the information of the requested phone numbers. Each phone number contains the following properties: `phone_number`: The phone number which portability is to be checked. `portable`: Boolean flag specifying if phone number is portable or not. `not_portable_reason`: Reason why the phone number cannot be ported into Twilio, `null` otherwise. `not_portable_reason_code`: The Portability Reason Code for the phone number if it cannot be ported in Twilio, `null` otherwise. `pin_and_account_number_required`: Boolean flag specifying if PIN and account number is required for the phone number. `number_type`: The type of the requested phone number. `country` Country the phone number belongs to. `messaging_carrier` Current messaging carrier of the phone number. `voice_carrier` Current voice carrier of the phone number.
+                    def phone_numbers
+                        @properties['phone_numbers']
+                    end
+                    
+                    ##
+                    # @return [String] This is the url of the request that you're trying to reach out to locate the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the PortingBulkPortabilityInstance
+                    # @return [PortingBulkPortabilityInstance] Fetched PortingBulkPortabilityInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingBulkPortabilityInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Numbers.V1.PortingBulkPortabilityInstance #{values}>"
+                    end
+                end
+
+            end
+        end
+    end
+end