pingram 1.0.11 → 1.0.13

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
 

data/lib/pingram/models/organization_usage.rb

@@ -19,7 +19,7 @@ module Pingram
     # Total message usage (EMAIL + INAPP_WEB + WEB_PUSH + PUSH + SLACK)
     attr_accessor :message_usage
 
-    # Total budget usage in USD (cost_SMS + cost_CALL)
+    # Total budget usage in USD (cost_SMS + cost_CALL + cost_NUMBER)
     attr_accessor :budget_usage
 
     # SMS cost in USD
@@ -28,6 +28,9 @@ module Pingram
     # Call cost in USD
     attr_accessor :cost_call
 
+    # Phone number rent in USD
+    attr_accessor :cost_number
+
     # Per-channel usage breakdown
     attr_accessor :channel_usages
 
@@ -44,6 +47,7 @@ module Pingram
         :'budget_usage' => :'budgetUsage',
         :'cost_sms' => :'costSms',
         :'cost_call' => :'costCall',
+        :'cost_number' => :'costNumber',
         :'channel_usages' => :'channelUsages',
         :'billing_cycle_start' => :'billingCycleStart',
         :'billing_cycle_end' => :'billingCycleEnd'
@@ -67,6 +71,7 @@ module Pingram
         :'budget_usage' => :'Float',
         :'cost_sms' => :'Float',
         :'cost_call' => :'Float',
+        :'cost_number' => :'Float',
         :'channel_usages' => :'Hash<String, Float>',
         :'billing_cycle_start' => :'String',
         :'billing_cycle_end' => :'String'
@@ -119,6 +124,12 @@ module Pingram
         self.cost_call = nil
       end
 
+      if attributes.key?(:'cost_number')
+        self.cost_number = attributes[:'cost_number']
+      else
+        self.cost_number = nil
+      end
+
       if attributes.key?(:'channel_usages')
         if (value = attributes[:'channel_usages']).is_a?(Hash)
           self.channel_usages = value
@@ -161,6 +172,10 @@ module Pingram
         invalid_properties.push('invalid value for "cost_call", cost_call cannot be nil.')
       end
 
+      if @cost_number.nil?
+        invalid_properties.push('invalid value for "cost_number", cost_number cannot be nil.')
+      end
+
       if @channel_usages.nil?
         invalid_properties.push('invalid value for "channel_usages", channel_usages cannot be nil.')
       end
@@ -184,6 +199,7 @@ module Pingram
       return false if @budget_usage.nil?
       return false if @cost_sms.nil?
       return false if @cost_call.nil?
+      return false if @cost_number.nil?
       return false if @channel_usages.nil?
       return false if @billing_cycle_start.nil?
       return false if @billing_cycle_end.nil?
@@ -230,6 +246,16 @@ module Pingram
       @cost_call = cost_call
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] cost_number Value to be assigned
+    def cost_number=(cost_number)
+      if cost_number.nil?
+        fail ArgumentError, 'cost_number cannot be nil'
+      end
+
+      @cost_number = cost_number
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] channel_usages Value to be assigned
     def channel_usages=(channel_usages)
@@ -269,6 +295,7 @@ module Pingram
           budget_usage == o.budget_usage &&
           cost_sms == o.cost_sms &&
           cost_call == o.cost_call &&
+          cost_number == o.cost_number &&
           channel_usages == o.channel_usages &&
           billing_cycle_start == o.billing_cycle_start &&
           billing_cycle_end == o.billing_cycle_end
@@ -283,7 +310,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [message_usage, budget_usage, cost_sms, cost_call, channel_usages, billing_cycle_start, billing_cycle_end].hash
+      [message_usage, budget_usage, cost_sms, cost_call, cost_number, channel_usages, billing_cycle_start, billing_cycle_end].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/organization_usage_history_items_inner.rb

@@ -22,7 +22,7 @@ module Pingram
     # Total message usage (EMAIL + INAPP_WEB + WEB_PUSH + PUSH + SLACK)
     attr_accessor :message_usage
 
-    # Total budget usage in USD (cost_SMS + cost_CALL)
+    # Total budget usage in USD (cost_SMS + cost_CALL + cost_NUMBER)
     attr_accessor :budget_usage
 
     # SMS cost in USD
@@ -31,6 +31,9 @@ module Pingram
     # Call cost in USD
     attr_accessor :cost_call
 
+    # Phone number rent in USD
+    attr_accessor :cost_number
+
     # Per-channel usage breakdown
     attr_accessor :channel_usages
 
@@ -42,6 +45,7 @@ module Pingram
         :'budget_usage' => :'budgetUsage',
         :'cost_sms' => :'costSms',
         :'cost_call' => :'costCall',
+        :'cost_number' => :'costNumber',
         :'channel_usages' => :'channelUsages'
       }
     end
@@ -64,6 +68,7 @@ module Pingram
         :'budget_usage' => :'Float',
         :'cost_sms' => :'Float',
         :'cost_call' => :'Float',
+        :'cost_number' => :'Float',
         :'channel_usages' => :'Hash<String, Float>'
       }
     end
@@ -120,6 +125,12 @@ module Pingram
         self.cost_call = nil
       end
 
+      if attributes.key?(:'cost_number')
+        self.cost_number = attributes[:'cost_number']
+      else
+        self.cost_number = nil
+      end
+
       if attributes.key?(:'channel_usages')
         if (value = attributes[:'channel_usages']).is_a?(Hash)
           self.channel_usages = value
@@ -154,6 +165,10 @@ module Pingram
         invalid_properties.push('invalid value for "cost_call", cost_call cannot be nil.')
       end
 
+      if @cost_number.nil?
+        invalid_properties.push('invalid value for "cost_number", cost_number cannot be nil.')
+      end
+
       if @channel_usages.nil?
         invalid_properties.push('invalid value for "channel_usages", channel_usages cannot be nil.')
       end
@@ -170,6 +185,7 @@ module Pingram
       return false if @budget_usage.nil?
       return false if @cost_sms.nil?
       return false if @cost_call.nil?
+      return false if @cost_number.nil?
       return false if @channel_usages.nil?
       true
     end
@@ -224,6 +240,16 @@ module Pingram
       @cost_call = cost_call
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] cost_number Value to be assigned
+    def cost_number=(cost_number)
+      if cost_number.nil?
+        fail ArgumentError, 'cost_number cannot be nil'
+      end
+
+      @cost_number = cost_number
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] channel_usages Value to be assigned
     def channel_usages=(channel_usages)
@@ -244,6 +270,7 @@ module Pingram
           budget_usage == o.budget_usage &&
           cost_sms == o.cost_sms &&
           cost_call == o.cost_call &&
+          cost_number == o.cost_number &&
           channel_usages == o.channel_usages
     end
 
@@ -256,7 +283,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [year_month, message_usage, budget_usage, cost_sms, cost_call, channel_usages].hash
+      [year_month, message_usage, budget_usage, cost_sms, cost_call, cost_number, channel_usages].hash
     end
 
     # Builds the object from hash