twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,62 +1,64 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    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.
 #
-# frozen_string_literal: true
 
 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
+    module REST
+        class Notify
+            class V1 < Version
+                ##
+                # Initialize the V1 version of Notify
+                def initialize(domain)
+                    super
+                    @version = 'v1'
+                    @credentials = nil
+                    @services = nil
+                end
 
-        ##
-        # Provide a user friendly representation
-        def to_s
-          '<Twilio::REST::Notify::V1>'
+                ##
+                # @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
-  end
-end
+end

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

@@ -1,39 +1,13 @@
-##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
-#
-# frozen_string_literal: true
-
 module Twilio
   module REST
-    class Notify < Domain
-      ##
-      # Initialize the Notify Domain
-      def initialize(twilio)
-        super
-
-        @base_url = 'https://notify.twilio.com'
-        @host = 'notify.twilio.com'
-        @port = 443
-
-        # Versions
-        @v1 = nil
-      end
-
-      ##
-      # Version v1 of notify
-      def v1
-        @v1 ||= V1.new self
-      end
-
+    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
 
@@ -43,14 +17,9 @@ module Twilio
       # @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
-
-      ##
-      # Provide a user friendly representation
-      def to_s
-        '#<Twilio::REST::Notify>'
-      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,411 @@
+##
+#    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 = {  }
+                        @uri = "/HostedNumber/Eligibility/Bulk"
+                        
+                    end
+                    ##
+                    # Create the BulkEligibilityInstance
+                    # @param [Object] body 
+                    # @return [BulkEligibilityInstance] Created BulkEligibilityInstance
+                    def create(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: body.to_json)
+                        BulkEligibilityInstance.new(
+                            @version,
+                            payload,
+                        )
+                    end
+
+                    ##
+                    # Create the BulkEligibilityInstanceMetadata
+                    # @param [Object] body 
+                    # @return [BulkEligibilityInstance] Created BulkEligibilityInstance
+                    def create_with_metadata(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: body.to_json)
+                        bulk_eligibility_instance = BulkEligibilityInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        BulkEligibilityInstanceMetadata.new(
+                            @version,
+                            bulk_eligibility_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Numbers.V1.BulkEligibilityList>'
+                    end
+                end
+
+
+                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
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
+                        BulkEligibilityInstance.new(
+                            @version,
+                            payload,
+                            request_id: @solution[:request_id],
+                        )
+                    end
+
+                    ##
+                    # Fetch the BulkEligibilityInstanceMetadata
+                    # @return [BulkEligibilityInstance] Fetched BulkEligibilityInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        bulk_eligibility_instance = BulkEligibilityInstance.new(
+                            @version,
+                            response.body,
+                            request_id: @solution[:request_id],
+                        )
+                        BulkEligibilityInstanceMetadata.new(
+                            @version,
+                            bulk_eligibility_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.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 BulkEligibilityInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new BulkEligibilityInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}BulkEligibilityInstance] bulk_eligibility_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 [BulkEligibilityInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, bulk_eligibility_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @bulk_eligibility_instance = bulk_eligibility_instance
+                    end
+
+                    def bulk_eligibility
+                        @bulk_eligibility_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.BulkEligibilityInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class BulkEligibilityListResponse < InstanceListResource
+                    # @param [Array<BulkEligibilityInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @bulk_eligibility_instance = payload.body[key].map do |data|
+                        BulkEligibilityInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def bulk_eligibility_instance
+                          @instance
+                      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 BulkEligibilityPageMetadata < PageMetadata
+                    attr_reader :bulk_eligibility_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @bulk_eligibility_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @bulk_eligibility_page << BulkEligibilityListResponse.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
+                        @bulk_eligibility_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Numbers::V1PageMetadata>';
+                    end
+                end
+                class BulkEligibilityListResponse < InstanceListResource
+
+                    # @param [Array<BulkEligibilityInstance>] 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
+                      @bulk_eligibility = data_list.map do |data|
+                        BulkEligibilityInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def bulk_eligibility
+                        @bulk_eligibility
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    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