pingram 1.0.12 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b67eb1c9e6d9d53ac5a1ba389352dc19a141198312988c47c6144538bdab045
-  data.tar.gz: 3157d9e00b1c13f115e4da189ffb296b2805808dcf50798d9e6b7867802c7795
+  metadata.gz: 8b0da74b04be34652ce4772d960f635a00fd4de9282f579a2b4f2b5fff340e22
+  data.tar.gz: a830cb772656fc43455340ef6f7bc447c3a4ad8ecb096ffd6ceded61aa2e8dce
 SHA512:
-  metadata.gz: 3a928be5ebc9529874f755bf61c149a8918c01c0b9517b8da5c111854e2df475524c1c247a0f4eacaf2e0a69f39bd5c5fb9deb9047aaa3513b20719b2b37ae95
-  data.tar.gz: dbfec3c3a37b080a54a95b11adae6af8ca838d6a2d12dd438d6fbcad78d47178c2730a5e342265dc077f9c3fe3dd0c6f164ee2501dd2d8f3918b1c5f1d1b3fd3
+  metadata.gz: 91ee7f634122374ab81a9cea5187eef7ca4ee3b207f9fc1b5f1eb993cf16049bd39a8b429d932be7e99a5bc4ffac9247324987e8bb03702016981c9591aaf24d
+  data.tar.gz: a0cbcb303e77a518f768df2fa83f4f96c81a423db53e5ac41bc0b1221911be75f3b0b31f04a6a48e28d4c32f40ed33e2609c693f9e230d7342fbc3f4d8e0a3e5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.12)
+    pingram (1.0.14)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/pingram/api/numbers_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # List all phone numbers registered for the account
+    # List active phone numbers registered for the account
     # @param [Hash] opts the optional parameters
     # @return [ListPhoneNumbersResponse]
     def numbers_list(opts = {})
@@ -27,7 +27,7 @@ module Pingram
       data
     end
 
-    # List all phone numbers registered for the account
+    # List active phone numbers registered for the account
     # @param [Hash] opts the optional parameters
     # @return [Array<(ListPhoneNumbersResponse, Integer, Hash)>] ListPhoneNumbersResponse data, response status code and response headers
     def numbers_list_with_http_info(opts = {})
@@ -74,7 +74,62 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Purchase a phone number for the authenticated account
+    # List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
+    # @param [Hash] opts the optional parameters
+    # @return [ListReleasedPhoneNumbersResponse]
+    def numbers_list_released(opts = {})
+      data, _status_code, _headers = numbers_list_released_with_http_info(opts)
+      data
+    end
+
+    # List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ListReleasedPhoneNumbersResponse, Integer, Hash)>] ListReleasedPhoneNumbersResponse data, response status code and response headers
+    def numbers_list_released_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_list_released ...'
+      end
+      # resource path
+      local_var_path = '/numbers/released'
+
+      # 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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListReleasedPhoneNumbersResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"NumbersApi.numbers_list_released",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NumbersApi#numbers_list_released\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OrderPhoneNumberResponse]
@@ -83,7 +138,7 @@ module Pingram
       data
     end
 
-    # Purchase a phone number for the authenticated account
+    # Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt).
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderPhoneNumberResponse, Integer, Hash)>] OrderPhoneNumberResponse data, response status code and response headers
@@ -140,6 +195,67 @@ module Pingram
       return data, status_code, headers
     end
 
+    # Release a phone number from the account. No refund for the current billing month.
+    # @param phone_number [String] E.164 phone number to release
+    # @param [Hash] opts the optional parameters
+    # @return [ReleasePhoneNumberResponse]
+    def numbers_release_number(phone_number, opts = {})
+      data, _status_code, _headers = numbers_release_number_with_http_info(phone_number, opts)
+      data
+    end
+
+    # Release a phone number from the account. No refund for the current billing month.
+    # @param phone_number [String] E.164 phone number to release
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReleasePhoneNumberResponse, Integer, Hash)>] ReleasePhoneNumberResponse data, response status code and response headers
+    def numbers_release_number_with_http_info(phone_number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: NumbersApi.numbers_release_number ...'
+      end
+      # verify the required parameter 'phone_number' is set
+      if @api_client.config.client_side_validation && phone_number.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number' when calling NumbersApi.numbers_release_number"
+      end
+      # resource path
+      local_var_path = '/numbers/{phoneNumber}'.sub('{' + 'phoneNumber' + '}', CGI.escape(phone_number.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ReleasePhoneNumberResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"NumbersApi.numbers_release_number",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NumbersApi#numbers_release_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search for available phone numbers
     # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
     # @param [Hash] opts the optional parameters

data/lib/pingram/api/sms_api.rb

@@ -19,7 +19,7 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Send an SMS notification directly without templates
+    # Send an SMS or MMS notification directly without templates
     # @param send_sms_request [SendSmsRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SendSmsResponse]
@@ -28,7 +28,7 @@ module Pingram
       data
     end
 
-    # Send an SMS notification directly without templates
+    # Send an SMS or MMS notification directly without templates
     # @param send_sms_request [SendSmsRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SendSmsResponse, Integer, Hash)>] SendSmsResponse data, response status code and response headers

data/lib/pingram/api_client.rb

@@ -32,7 +32,7 @@ module Pingram
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "pingram-ruby/1.0.12"
+      @user_agent = "pingram-ruby/1.0.14"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/a2p_registration.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Public response type for A2P registration - excludes internal Telnyx IDs
+  # Public response type for A2P registration
   class A2pRegistration < ApiModelBase
     attr_accessor :account_id
 

data/lib/pingram/models/list_phone_numbers_response.rb

@@ -14,7 +14,6 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Response for GET /numbers/list
   class ListPhoneNumbersResponse < ApiModelBase
     attr_accessor :numbers
 

data/lib/pingram/models/list_phone_numbers_response_numbers_inner.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
-  # One phone number owned by the account
+  # Represents a phone number in the account
   class ListPhoneNumbersResponseNumbersInner < ApiModelBase
     # E.164
     attr_accessor :phone_number
@@ -24,12 +24,62 @@ module Pingram
     # ISO timestamp when the number was registered
     attr_accessor :created_at
 
+    # ISO 3166-1 alpha-2 country code
+    attr_accessor :country_code
+
+    # e.g. local, toll_free
+    attr_accessor :number_type
+
+    # active or released
+    attr_accessor :billing_status
+
+    # YYYY-MM-DD next monthly rent charge
+    attr_accessor :next_billing_date
+
+    # Monthly cost in USD
+    attr_accessor :monthly_price
+
+    # US 10DLC readiness derived from stored campaign assignment
+    attr_accessor :a2p_status
+
+    # ISO timestamp when the number was released (released numbers only)
+    attr_accessor :released_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'phone_number' => :'phoneNumber',
         :'label' => :'label',
-        :'created_at' => :'createdAt'
+        :'created_at' => :'createdAt',
+        :'country_code' => :'countryCode',
+        :'number_type' => :'numberType',
+        :'billing_status' => :'billingStatus',
+        :'next_billing_date' => :'nextBillingDate',
+        :'monthly_price' => :'monthlyPrice',
+        :'a2p_status' => :'a2pStatus',
+        :'released_at' => :'releasedAt'
       }
     end
 
@@ -48,7 +98,14 @@ module Pingram
       {
         :'phone_number' => :'String',
         :'label' => :'String',
-        :'created_at' => :'String'
+        :'created_at' => :'String',
+        :'country_code' => :'String',
+        :'number_type' => :'String',
+        :'billing_status' => :'String',
+        :'next_billing_date' => :'String',
+        :'monthly_price' => :'Float',
+        :'a2p_status' => :'String',
+        :'released_at' => :'String'
       }
     end
 
@@ -89,6 +146,44 @@ module Pingram
       else
         self.created_at = nil
       end
+
+      if attributes.key?(:'country_code')
+        self.country_code = attributes[:'country_code']
+      else
+        self.country_code = nil
+      end
+
+      if attributes.key?(:'number_type')
+        self.number_type = attributes[:'number_type']
+      else
+        self.number_type = nil
+      end
+
+      if attributes.key?(:'billing_status')
+        self.billing_status = attributes[:'billing_status']
+      else
+        self.billing_status = nil
+      end
+
+      if attributes.key?(:'next_billing_date')
+        self.next_billing_date = attributes[:'next_billing_date']
+      else
+        self.next_billing_date = nil
+      end
+
+      if attributes.key?(:'monthly_price')
+        self.monthly_price = attributes[:'monthly_price']
+      else
+        self.monthly_price = nil
+      end
+
+      if attributes.key?(:'a2p_status')
+        self.a2p_status = attributes[:'a2p_status']
+      end
+
+      if attributes.key?(:'released_at')
+        self.released_at = attributes[:'released_at']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -104,6 +199,26 @@ module Pingram
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
 
+      if @country_code.nil?
+        invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
+      end
+
+      if @number_type.nil?
+        invalid_properties.push('invalid value for "number_type", number_type cannot be nil.')
+      end
+
+      if @billing_status.nil?
+        invalid_properties.push('invalid value for "billing_status", billing_status cannot be nil.')
+      end
+
+      if @next_billing_date.nil?
+        invalid_properties.push('invalid value for "next_billing_date", next_billing_date cannot be nil.')
+      end
+
+      if @monthly_price.nil?
+        invalid_properties.push('invalid value for "monthly_price", monthly_price cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -113,6 +228,15 @@ module Pingram
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @phone_number.nil?
       return false if @created_at.nil?
+      return false if @country_code.nil?
+      return false if @number_type.nil?
+      return false if @billing_status.nil?
+      billing_status_validator = EnumAttributeValidator.new('String', ["active", "released"])
+      return false unless billing_status_validator.valid?(@billing_status)
+      return false if @next_billing_date.nil?
+      return false if @monthly_price.nil?
+      a2p_status_validator = EnumAttributeValidator.new('String', ["pending", "testing", "approved"])
+      return false unless a2p_status_validator.valid?(@a2p_status)
       true
     end
 
@@ -136,6 +260,66 @@ module Pingram
       @created_at = created_at
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] country_code Value to be assigned
+    def country_code=(country_code)
+      if country_code.nil?
+        fail ArgumentError, 'country_code cannot be nil'
+      end
+
+      @country_code = country_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number_type Value to be assigned
+    def number_type=(number_type)
+      if number_type.nil?
+        fail ArgumentError, 'number_type cannot be nil'
+      end
+
+      @number_type = number_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] billing_status Object to be assigned
+    def billing_status=(billing_status)
+      validator = EnumAttributeValidator.new('String', ["active", "released"])
+      unless validator.valid?(billing_status)
+        fail ArgumentError, "invalid value for \"billing_status\", must be one of #{validator.allowable_values}."
+      end
+      @billing_status = billing_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] next_billing_date Value to be assigned
+    def next_billing_date=(next_billing_date)
+      if next_billing_date.nil?
+        fail ArgumentError, 'next_billing_date cannot be nil'
+      end
+
+      @next_billing_date = next_billing_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] monthly_price Value to be assigned
+    def monthly_price=(monthly_price)
+      if monthly_price.nil?
+        fail ArgumentError, 'monthly_price cannot be nil'
+      end
+
+      @monthly_price = monthly_price
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] a2p_status Object to be assigned
+    def a2p_status=(a2p_status)
+      validator = EnumAttributeValidator.new('String', ["pending", "testing", "approved"])
+      unless validator.valid?(a2p_status)
+        fail ArgumentError, "invalid value for \"a2p_status\", must be one of #{validator.allowable_values}."
+      end
+      @a2p_status = a2p_status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -143,7 +327,14 @@ module Pingram
       self.class == o.class &&
           phone_number == o.phone_number &&
           label == o.label &&
-          created_at == o.created_at
+          created_at == o.created_at &&
+          country_code == o.country_code &&
+          number_type == o.number_type &&
+          billing_status == o.billing_status &&
+          next_billing_date == o.next_billing_date &&
+          monthly_price == o.monthly_price &&
+          a2p_status == o.a2p_status &&
+          released_at == o.released_at
     end
 
     # @see the `==` method
@@ -155,7 +346,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [phone_number, label, created_at].hash
+      [phone_number, label, created_at, country_code, number_type, billing_status, next_billing_date, monthly_price, a2p_status, released_at].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/list_released_phone_numbers_response.rb

@@ -0,0 +1,166 @@
+=begin
+#Pingram
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  class ListReleasedPhoneNumbersResponse < ApiModelBase
+    attr_accessor :numbers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'numbers' => :'numbers'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'numbers' => :'Array<ListPhoneNumbersResponseNumbersInner>'
+      }
+    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 `Pingram::ListReleasedPhoneNumbersResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::ListReleasedPhoneNumbersResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'numbers')
+        if (value = attributes[:'numbers']).is_a?(Array)
+          self.numbers = value
+        end
+      else
+        self.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 @numbers.nil?
+        invalid_properties.push('invalid value for "numbers", 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 @numbers.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] numbers Value to be assigned
+    def numbers=(numbers)
+      if numbers.nil?
+        fail ArgumentError, 'numbers cannot be nil'
+      end
+
+      @numbers = 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 &&
+          numbers == o.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
+      [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
+
+    # 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
+
+  end
+
+end

data/lib/pingram/models/order_phone_number_request.rb

@@ -14,7 +14,6 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Request body for POST /numbers/order
   class OrderPhoneNumberRequest < ApiModelBase
     # E.164 from search results
     attr_accessor :phone_number

data/lib/pingram/models/order_phone_number_response.rb

@@ -14,7 +14,6 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Response for POST /numbers/order
   class OrderPhoneNumberResponse < ApiModelBase
     attr_accessor :order_id