pingram 1.0.16 → 1.0.17

data/lib/pingram/models/mcp.rb

@@ -0,0 +1,223 @@
+=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 Mcp < ApiModelBase
+    attr_accessor :type
+
+    attr_accessor :url
+
+    attr_accessor :label
+
+    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
+      {
+        :'type' => :'type',
+        :'url' => :'url',
+        :'label' => :'label'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'url' => :'String',
+        :'label' => :'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::Mcp` 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::Mcp`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      else
+        self.url = nil
+      end
+
+      if attributes.key?(:'label')
+        self.label = attributes[:'label']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["mcp"])
+      return false unless type_validator.valid?(@type)
+      return false if @url.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["mcp"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
+      end
+
+      @url = url
+    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 &&
+          type == o.type &&
+          url == o.url &&
+          label == o.label
+    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
+      [type, url, label].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/organization.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
 
@@ -74,6 +76,7 @@ module Pingram
         :'cost_cap' => :'costCap',
         :'sms_cap' => :'smsCap',
         :'call_cap' => :'callCap',
+        :'billing_version' => :'billingVersion',
         :'anniversary_date' => :'anniversaryDate',
         :'allow_overage' => :'allowOverage',
         :'created_at' => :'createdAt',
@@ -102,6 +105,7 @@ module Pingram
         :'cost_cap' => :'Float',
         :'sms_cap' => :'Float',
         :'call_cap' => :'Float',
+        :'billing_version' => :'Float',
         :'anniversary_date' => :'String',
         :'allow_overage' => :'Boolean',
         :'created_at' => :'String',
@@ -175,6 +179,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
@@ -260,6 +268,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?
@@ -327,6 +337,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)
@@ -380,6 +400,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 &&
@@ -395,7 +416,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].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].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/organization_usage.rb

@@ -16,23 +16,9 @@ require 'time'
 module Pingram
   # Response for GET /account/organization/usage
   class OrganizationUsage < ApiModelBase
-    # Total message usage (EMAIL + INAPP_WEB + WEB_PUSH + PUSH + SLACK)
-    attr_accessor :message_usage
+    attr_accessor :costs
 
-    # Total budget usage in USD (cost_SMS + cost_CALL + cost_NUMBER)
-    attr_accessor :budget_usage
-
-    # SMS cost in USD
-    attr_accessor :cost_sms
-
-    # 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
+    attr_accessor :counts
 
     # Billing cycle start date (ISO string)
     attr_accessor :billing_cycle_start
@@ -43,12 +29,8 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'message_usage' => :'messageUsage',
-        :'budget_usage' => :'budgetUsage',
-        :'cost_sms' => :'costSms',
-        :'cost_call' => :'costCall',
-        :'cost_number' => :'costNumber',
-        :'channel_usages' => :'channelUsages',
+        :'costs' => :'costs',
+        :'counts' => :'counts',
         :'billing_cycle_start' => :'billingCycleStart',
         :'billing_cycle_end' => :'billingCycleEnd'
       }
@@ -67,12 +49,8 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'message_usage' => :'Float',
-        :'budget_usage' => :'Float',
-        :'cost_sms' => :'Float',
-        :'cost_call' => :'Float',
-        :'cost_number' => :'Float',
-        :'channel_usages' => :'Hash<String, Float>',
+        :'costs' => :'OrganizationUsageCosts',
+        :'counts' => :'OrganizationUsageCounts',
         :'billing_cycle_start' => :'String',
         :'billing_cycle_end' => :'String'
       }
@@ -100,42 +78,12 @@ module Pingram
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'message_usage')
-        self.message_usage = attributes[:'message_usage']
-      else
-        self.message_usage = nil
-      end
-
-      if attributes.key?(:'budget_usage')
-        self.budget_usage = attributes[:'budget_usage']
-      else
-        self.budget_usage = nil
-      end
-
-      if attributes.key?(:'cost_sms')
-        self.cost_sms = attributes[:'cost_sms']
-      else
-        self.cost_sms = nil
-      end
-
-      if attributes.key?(:'cost_call')
-        self.cost_call = attributes[:'cost_call']
-      else
-        self.cost_call = nil
+      if attributes.key?(:'costs')
+        self.costs = attributes[:'costs']
       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
-        end
-      else
-        self.channel_usages = nil
+      if attributes.key?(:'counts')
+        self.counts = attributes[:'counts']
       end
 
       if attributes.key?(:'billing_cycle_start')
@@ -156,30 +104,6 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @message_usage.nil?
-        invalid_properties.push('invalid value for "message_usage", message_usage cannot be nil.')
-      end
-
-      if @budget_usage.nil?
-        invalid_properties.push('invalid value for "budget_usage", budget_usage cannot be nil.')
-      end
-
-      if @cost_sms.nil?
-        invalid_properties.push('invalid value for "cost_sms", cost_sms cannot be nil.')
-      end
-
-      if @cost_call.nil?
-        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
-
       if @billing_cycle_start.nil?
         invalid_properties.push('invalid value for "billing_cycle_start", billing_cycle_start cannot be nil.')
       end
@@ -195,77 +119,11 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @message_usage.nil?
-      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?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] message_usage Value to be assigned
-    def message_usage=(message_usage)
-      if message_usage.nil?
-        fail ArgumentError, 'message_usage cannot be nil'
-      end
-
-      @message_usage = message_usage
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] budget_usage Value to be assigned
-    def budget_usage=(budget_usage)
-      if budget_usage.nil?
-        fail ArgumentError, 'budget_usage cannot be nil'
-      end
-
-      @budget_usage = budget_usage
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] cost_sms Value to be assigned
-    def cost_sms=(cost_sms)
-      if cost_sms.nil?
-        fail ArgumentError, 'cost_sms cannot be nil'
-      end
-
-      @cost_sms = cost_sms
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] cost_call Value to be assigned
-    def cost_call=(cost_call)
-      if cost_call.nil?
-        fail ArgumentError, 'cost_call cannot be nil'
-      end
-
-      @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)
-      if channel_usages.nil?
-        fail ArgumentError, 'channel_usages cannot be nil'
-      end
-
-      @channel_usages = channel_usages
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] billing_cycle_start Value to be assigned
     def billing_cycle_start=(billing_cycle_start)
@@ -291,12 +149,8 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          message_usage == o.message_usage &&
-          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 &&
+          costs == o.costs &&
+          counts == o.counts &&
           billing_cycle_start == o.billing_cycle_start &&
           billing_cycle_end == o.billing_cycle_end
     end
@@ -310,7 +164,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [message_usage, budget_usage, cost_sms, cost_call, cost_number, channel_usages, billing_cycle_start, billing_cycle_end].hash
+      [costs, counts, billing_cycle_start, billing_cycle_end].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/organization_usage_costs.rb

@@ -0,0 +1,148 @@
+=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
+  # Total costs for the billing cycle (all channel costs + number rent)
+  class OrganizationUsageCosts < ApiModelBase
+    attr_accessor :number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'number' => :'NUMBER'
+      }
+    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
+      {
+        :'number' => :'Float'
+      }
+    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::OrganizationUsageCosts` 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::OrganizationUsageCosts`. 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?(:'number')
+        self.number = attributes[:'number']
+      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
+      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'
+      true
+    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 &&
+          number == o.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
+      [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