pingram 1.0.16 → 1.0.17

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.16"
+      @user_agent = "pingram-ruby/1.0.17"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/client_wrapper.rb

@@ -54,6 +54,8 @@ require_relative 'api/user_api'
 
 require_relative 'api/users_api'
 
+require_relative 'api/voice_api'
+
 require_relative 'api/webhooks_api'
 
 
@@ -130,6 +132,8 @@ module Pingram
 
       @users = Pingram::UsersApi.new(@api_client)
 
+      @voice = Pingram::VoiceApi.new(@api_client)
+
       @webhooks = Pingram::WebhooksApi.new(@api_client)
 
     end
@@ -273,6 +277,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::VoiceApi]
+    def voice
+      @voice
+    end
+
+
     # @return [Pingram::WebhooksApi]
     def webhooks
       @webhooks

data/lib/pingram/models/api_error_body.rb

@@ -25,20 +25,12 @@ module Pingram
     # Actionable hint for fixing the error.
     attr_accessor :fix
 
-    # Provider that caused the error (e.g. telnyx, ses).
-    attr_accessor :provider
-
-    # Provider-specific error code.
-    attr_accessor :provider_code
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'code' => :'code',
         :'message' => :'message',
-        :'fix' => :'fix',
-        :'provider' => :'provider',
-        :'provider_code' => :'providerCode'
+        :'fix' => :'fix'
       }
     end
 
@@ -57,9 +49,7 @@ module Pingram
       {
         :'code' => :'String',
         :'message' => :'String',
-        :'fix' => :'String',
-        :'provider' => :'String',
-        :'provider_code' => :'String'
+        :'fix' => :'String'
       }
     end
 
@@ -100,14 +90,6 @@ module Pingram
       if attributes.key?(:'fix')
         self.fix = attributes[:'fix']
       end
-
-      if attributes.key?(:'provider')
-        self.provider = attributes[:'provider']
-      end
-
-      if attributes.key?(:'provider_code')
-        self.provider_code = attributes[:'provider_code']
-      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -162,9 +144,7 @@ module Pingram
       self.class == o.class &&
           code == o.code &&
           message == o.message &&
-          fix == o.fix &&
-          provider == o.provider &&
-          provider_code == o.provider_code
+          fix == o.fix
     end
 
     # @see the `==` method
@@ -176,7 +156,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, message, fix, provider, provider_code].hash
+      [code, message, fix].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/billing_post_request_body.rb

@@ -15,10 +15,7 @@ require 'time'
 
 module Pingram
   class BillingPostRequestBody < ApiModelBase
-    # Price ID for the message tier (EMAIL, INAPP_WEB, WEB_PUSH, PUSH, SLACK)
-    attr_accessor :message_price_id
-
-    # Price ID for the budget tier (SMS, CALL)
+    # Price ID for a monthly budget tier (all channels).
     attr_accessor :budget_price_id
 
     attr_accessor :success_url
@@ -28,7 +25,6 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'message_price_id' => :'messagePriceId',
         :'budget_price_id' => :'budgetPriceId',
         :'success_url' => :'successUrl',
         :'cancel_url' => :'cancelUrl'
@@ -48,7 +44,6 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'message_price_id' => :'String',
         :'budget_price_id' => :'String',
         :'success_url' => :'String',
         :'cancel_url' => :'String'
@@ -77,10 +72,6 @@ module Pingram
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'message_price_id')
-        self.message_price_id = attributes[:'message_price_id']
-      end
-
       if attributes.key?(:'budget_price_id')
         self.budget_price_id = attributes[:'budget_price_id']
       end
@@ -148,7 +139,6 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          message_price_id == o.message_price_id &&
           budget_price_id == o.budget_price_id &&
           success_url == o.success_url &&
           cancel_url == o.cancel_url
@@ -163,7 +153,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [message_price_id, budget_price_id, success_url, cancel_url].hash
+      [budget_price_id, success_url, cancel_url].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/billing_post_response_body.rb

@@ -32,6 +32,8 @@ module Pingram
 
     attr_accessor :call_cap
 
+    attr_accessor :billing_version
+
     # ISO date (YYYY-MM-DD) when the billing cycle resets.
     attr_accessor :anniversary_date
 
@@ -78,6 +80,7 @@ module Pingram
         :'cost_cap' => :'costCap',
         :'sms_cap' => :'smsCap',
         :'call_cap' => :'callCap',
+        :'billing_version' => :'billingVersion',
         :'anniversary_date' => :'anniversaryDate',
         :'allow_overage' => :'allowOverage',
         :'created_at' => :'createdAt',
@@ -108,6 +111,7 @@ module Pingram
         :'cost_cap' => :'Float',
         :'sms_cap' => :'Float',
         :'call_cap' => :'Float',
+        :'billing_version' => :'Float',
         :'anniversary_date' => :'String',
         :'allow_overage' => :'Boolean',
         :'created_at' => :'String',
@@ -183,6 +187,10 @@ module Pingram
         self.call_cap = attributes[:'call_cap']
       end
 
+      if attributes.key?(:'billing_version')
+        self.billing_version = attributes[:'billing_version']
+      end
+
       if attributes.key?(:'anniversary_date')
         self.anniversary_date = attributes[:'anniversary_date']
       else
@@ -276,6 +284,8 @@ module Pingram
       return false if @name.nil?
       return false if @messages_cap.nil?
       return false if @cost_cap.nil?
+      billing_version_validator = EnumAttributeValidator.new('Float', [1, 3])
+      return false unless billing_version_validator.valid?(@billing_version)
       return false if @anniversary_date.nil?
       return false if @allow_overage.nil?
       return false if @created_at.nil?
@@ -343,6 +353,16 @@ module Pingram
       @cost_cap = cost_cap
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] billing_version Object to be assigned
+    def billing_version=(billing_version)
+      validator = EnumAttributeValidator.new('Float', [1, 3])
+      unless validator.valid?(billing_version)
+        fail ArgumentError, "invalid value for \"billing_version\", must be one of #{validator.allowable_values}."
+      end
+      @billing_version = billing_version
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] anniversary_date Value to be assigned
     def anniversary_date=(anniversary_date)
@@ -396,6 +416,7 @@ module Pingram
           cost_cap == o.cost_cap &&
           sms_cap == o.sms_cap &&
           call_cap == o.call_cap &&
+          billing_version == o.billing_version &&
           anniversary_date == o.anniversary_date &&
           allow_overage == o.allow_overage &&
           created_at == o.created_at &&
@@ -413,7 +434,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [organization_id, organization_type, creator, name, messages_cap, cost_cap, sms_cap, call_cap, anniversary_date, allow_overage, created_at, updated_at, session_id, url].hash
+      [organization_id, organization_type, creator, name, messages_cap, cost_cap, sms_cap, call_cap, billing_version, anniversary_date, allow_overage, created_at, updated_at, session_id, url].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/bind_number_request.rb

@@ -0,0 +1,164 @@
+=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 BindNumberRequest < ApiModelBase
+    attr_accessor :phone_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'phone_number' => :'phoneNumber'
+      }
+    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
+      {
+        :'phone_number' => :'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 `Pingram::BindNumberRequest` 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::BindNumberRequest`. 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?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      else
+        self.phone_number = 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_number.nil?
+        invalid_properties.push('invalid value for "phone_number", phone_number 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_number.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if phone_number.nil?
+        fail ArgumentError, 'phone_number cannot be nil'
+      end
+
+      @phone_number = phone_number
+    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_number == o.phone_number
+    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_number].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/bind_number_response.rb

@@ -0,0 +1,164 @@
+=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 BindNumberResponse < ApiModelBase
+    attr_accessor :agent
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'agent' => :'agent'
+      }
+    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
+      {
+        :'agent' => :'BindNumberResponseAgent'
+      }
+    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::BindNumberResponse` 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::BindNumberResponse`. 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?(:'agent')
+        self.agent = attributes[:'agent']
+      else
+        self.agent = 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 @agent.nil?
+        invalid_properties.push('invalid value for "agent", agent 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 @agent.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] agent Value to be assigned
+    def agent=(agent)
+      if agent.nil?
+        fail ArgumentError, 'agent cannot be nil'
+      end
+
+      @agent = agent
+    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 &&
+          agent == o.agent
+    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
+      [agent].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