bandwidth-sdk 16.2.2 → 17.0.0

data/docs/SyncLookupRequest.md

@@ -0,0 +1,18 @@
+# Bandwidth::SyncLookupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_numbers** | **Array<String>** | Telephone numbers in E.164 format. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::SyncLookupRequest.new(
+  phone_numbers: null
+)
+```
+

data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb

@@ -19,39 +19,37 @@ module Bandwidth
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create Lookup
-    # Create a Phone Number Lookup Request.
-    # @param account_id [String] Your Bandwidth Account ID.
-    # @param lookup_request [LookupRequest] Phone number lookup request.
+    # Create Asynchronous Bulk Number Lookup
+    # Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
+    # @param account_id [String] 
+    # @param async_lookup_request [AsyncLookupRequest] Asynchronous bulk phone number lookup request.
     # @param [Hash] opts the optional parameters
-    # @return [CreateLookupResponse]
-    def create_lookup(account_id, lookup_request, opts = {})
-      warn '[DEPRECATION NOTICE] `create_lookup` is deprecated.'
-      data, _status_code, _headers = create_lookup_with_http_info(account_id, lookup_request, opts)
+    # @return [CreateAsyncBulkLookupResponse]
+    def create_async_bulk_lookup(account_id, async_lookup_request, opts = {})
+      data, _status_code, _headers = create_async_bulk_lookup_with_http_info(account_id, async_lookup_request, opts)
       data
     end
 
-    # Create Lookup
-    # Create a Phone Number Lookup Request.
-    # @param account_id [String] Your Bandwidth Account ID.
-    # @param lookup_request [LookupRequest] Phone number lookup request.
+    # Create Asynchronous Bulk Number Lookup
+    # Creates an asynchronous bulk phone number lookup request. Maximum of 15,000 telephone numbers per request. Use the [Get Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/getAsyncBulkLookup) endpoint to check the status of the request and view the results.
+    # @param account_id [String] 
+    # @param async_lookup_request [AsyncLookupRequest] Asynchronous bulk phone number lookup request.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(CreateLookupResponse, Integer, Hash)>] CreateLookupResponse data, response status code and response headers
-    def create_lookup_with_http_info(account_id, lookup_request, opts = {})
-      warn '[DEPRECATION NOTICE] `create_lookup_with_http_info` is deprecated.'
+    # @return [Array<(CreateAsyncBulkLookupResponse, Integer, Hash)>] CreateAsyncBulkLookupResponse data, response status code and response headers
+    def create_async_bulk_lookup_with_http_info(account_id, async_lookup_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_lookup ...'
+        @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_async_bulk_lookup ...'
       end
       # verify the required parameter 'account_id' is set
       if @api_client.config.client_side_validation && account_id.nil?
-        fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumberLookupApi.create_lookup"
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumberLookupApi.create_async_bulk_lookup"
       end
-      # verify the required parameter 'lookup_request' is set
-      if @api_client.config.client_side_validation && lookup_request.nil?
-        fail ArgumentError, "Missing the required parameter 'lookup_request' when calling PhoneNumberLookupApi.create_lookup"
+      # verify the required parameter 'async_lookup_request' is set
+      if @api_client.config.client_side_validation && async_lookup_request.nil?
+        fail ArgumentError, "Missing the required parameter 'async_lookup_request' when calling PhoneNumberLookupApi.create_async_bulk_lookup"
       end
       # resource path
-      local_var_path = '/accounts/{accountId}/tnlookup'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+      local_var_path = '/accounts/{accountId}/phoneNumberLookup/bulk'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -70,16 +68,16 @@ module Bandwidth
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(lookup_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(async_lookup_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'CreateLookupResponse'
+      return_type = opts[:debug_return_type] || 'CreateAsyncBulkLookupResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['Basic']
 
       new_options = opts.merge(
-        :operation => :"PhoneNumberLookupApi.create_lookup",
+        :operation => :"PhoneNumberLookupApi.create_async_bulk_lookup",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -90,44 +88,116 @@ module Bandwidth
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PhoneNumberLookupApi#create_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PhoneNumberLookupApi#create_async_bulk_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Get Lookup Request Status
-    # Get an existing Phone Number Lookup Request.
-    # @param account_id [String] Your Bandwidth Account ID.
-    # @param request_id [String] The phone number lookup request ID from Bandwidth.
+    # Create Synchronous Number Lookup
+    # Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
+    # @param account_id [String] 
+    # @param sync_lookup_request [SyncLookupRequest] Synchronous phone number lookup request.
     # @param [Hash] opts the optional parameters
-    # @return [LookupStatus]
-    def get_lookup_status(account_id, request_id, opts = {})
-      warn '[DEPRECATION NOTICE] `get_lookup_status` is deprecated.'
-      data, _status_code, _headers = get_lookup_status_with_http_info(account_id, request_id, opts)
+    # @return [CreateSyncLookupResponse]
+    def create_sync_lookup(account_id, sync_lookup_request, opts = {})
+      data, _status_code, _headers = create_sync_lookup_with_http_info(account_id, sync_lookup_request, opts)
       data
     end
 
-    # Get Lookup Request Status
-    # Get an existing Phone Number Lookup Request.
-    # @param account_id [String] Your Bandwidth Account ID.
-    # @param request_id [String] The phone number lookup request ID from Bandwidth.
+    # Create Synchronous Number Lookup
+    # Creates a synchronous phone number lookup request. Maximum of 100 telephone numbers per request.
+    # @param account_id [String] 
+    # @param sync_lookup_request [SyncLookupRequest] Synchronous phone number lookup request.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(LookupStatus, Integer, Hash)>] LookupStatus data, response status code and response headers
-    def get_lookup_status_with_http_info(account_id, request_id, opts = {})
-      warn '[DEPRECATION NOTICE] `get_lookup_status_with_http_info` is deprecated.'
+    # @return [Array<(CreateSyncLookupResponse, Integer, Hash)>] CreateSyncLookupResponse data, response status code and response headers
+    def create_sync_lookup_with_http_info(account_id, sync_lookup_request, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.get_lookup_status ...'
+        @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.create_sync_lookup ...'
       end
       # verify the required parameter 'account_id' is set
       if @api_client.config.client_side_validation && account_id.nil?
-        fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumberLookupApi.get_lookup_status"
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumberLookupApi.create_sync_lookup"
+      end
+      # verify the required parameter 'sync_lookup_request' is set
+      if @api_client.config.client_side_validation && sync_lookup_request.nil?
+        fail ArgumentError, "Missing the required parameter 'sync_lookup_request' when calling PhoneNumberLookupApi.create_sync_lookup"
+      end
+      # resource path
+      local_var_path = '/accounts/{accountId}/phoneNumberLookup'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(sync_lookup_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSyncLookupResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"PhoneNumberLookupApi.create_sync_lookup",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PhoneNumberLookupApi#create_sync_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Asynchronous Bulk Number Lookup
+    # Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
+    # @param account_id [String] 
+    # @param request_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetAsyncBulkLookupResponse]
+    def get_async_bulk_lookup(account_id, request_id, opts = {})
+      data, _status_code, _headers = get_async_bulk_lookup_with_http_info(account_id, request_id, opts)
+      data
+    end
+
+    # Get Asynchronous Bulk Number Lookup
+    # Get an existing [Asynchronous Bulk Number Lookup](#tag/Phone-Number-Lookup/operation/createAsyncBulkLookup). Use this endpoint to check the status of the request and view the results.
+    # @param account_id [String] 
+    # @param request_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetAsyncBulkLookupResponse, Integer, Hash)>] GetAsyncBulkLookupResponse data, response status code and response headers
+    def get_async_bulk_lookup_with_http_info(account_id, request_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PhoneNumberLookupApi.get_async_bulk_lookup ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling PhoneNumberLookupApi.get_async_bulk_lookup"
       end
       # verify the required parameter 'request_id' is set
       if @api_client.config.client_side_validation && request_id.nil?
-        fail ArgumentError, "Missing the required parameter 'request_id' when calling PhoneNumberLookupApi.get_lookup_status"
+        fail ArgumentError, "Missing the required parameter 'request_id' when calling PhoneNumberLookupApi.get_async_bulk_lookup"
       end
       # resource path
-      local_var_path = '/accounts/{accountId}/tnlookup/{requestId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'requestId' + '}', CGI.escape(request_id.to_s))
+      local_var_path = '/accounts/{accountId}/phoneNumberLookup/bulk/{requestId}'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'requestId' + '}', CGI.escape(request_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -144,13 +214,13 @@ module Bandwidth
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'LookupStatus'
+      return_type = opts[:debug_return_type] || 'GetAsyncBulkLookupResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['Basic']
 
       new_options = opts.merge(
-        :operation => :"PhoneNumberLookupApi.get_lookup_status",
+        :operation => :"PhoneNumberLookupApi.get_async_bulk_lookup",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -161,7 +231,7 @@ module Bandwidth
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PhoneNumberLookupApi#get_lookup_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: PhoneNumberLookupApi#get_async_bulk_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

data/lib/bandwidth-sdk/configuration.rb

@@ -414,15 +414,21 @@ module Bandwidth
           description: "Production",
           }
         ],
-        "PhoneNumberLookupApi.create_lookup": [
+        "PhoneNumberLookupApi.create_async_bulk_lookup": [
           {
-          url: "https://numbers.bandwidth.com/api/v1",
+          url: "https://api.bandwidth.com/v2",
           description: "Production",
           }
         ],
-        "PhoneNumberLookupApi.get_lookup_status": [
+        "PhoneNumberLookupApi.create_sync_lookup": [
           {
-          url: "https://numbers.bandwidth.com/api/v1",
+          url: "https://api.bandwidth.com/v2",
+          description: "Production",
+          }
+        ],
+        "PhoneNumberLookupApi.get_async_bulk_lookup": [
+          {
+          url: "https://api.bandwidth.com/v2",
           description: "Production",
           }
         ],

data/lib/bandwidth-sdk/models/async_lookup_request.rb

@@ -0,0 +1,232 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class AsyncLookupRequest
+    # Telephone numbers in E.164 format.
+    attr_accessor :phone_numbers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'phone_numbers' => :'phoneNumbers'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'phone_numbers' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::AsyncLookupRequest` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::AsyncLookupRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'phone_numbers')
+        if (value = attributes[:'phone_numbers']).is_a?(Array)
+          self.phone_numbers = value
+        end
+      else
+        self.phone_numbers = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @phone_numbers.nil?
+        invalid_properties.push('invalid value for "phone_numbers", phone_numbers cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @phone_numbers.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_numbers Value to be assigned
+    def phone_numbers=(phone_numbers)
+      if phone_numbers.nil?
+        fail ArgumentError, 'phone_numbers cannot be nil'
+      end
+
+      @phone_numbers = phone_numbers
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          phone_numbers == o.phone_numbers
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [phone_numbers].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Bandwidth.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/bandwidth-sdk/models/completed_lookup_status_enum.rb

@@ -0,0 +1,41 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class CompletedLookupStatusEnum
+    COMPLETE = 'COMPLETE'.freeze
+    PARTIAL_COMPLETE = 'PARTIAL_COMPLETE'.freeze
+    FAILED = 'FAILED'.freeze
+
+    def self.all_vars
+      @all_vars ||= [COMPLETE, PARTIAL_COMPLETE, FAILED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CompletedLookupStatusEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CompletedLookupStatusEnum"
+    end
+  end
+end