pingram 1.0.16 → 1.0.17

data/lib/pingram/models/organization_usage_counts.rb

@@ -0,0 +1,347 @@
+=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
+  # Per-channel usage breakdown
+  class OrganizationUsageCounts < ApiModelBase
+    attr_accessor :email
+
+    attr_accessor :inapp_web
+
+    attr_accessor :sms
+
+    attr_accessor :call
+
+    attr_accessor :voice
+
+    attr_accessor :push
+
+    attr_accessor :web_push
+
+    attr_accessor :slack
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'EMAIL',
+        :'inapp_web' => :'INAPP_WEB',
+        :'sms' => :'SMS',
+        :'call' => :'CALL',
+        :'voice' => :'VOICE',
+        :'push' => :'PUSH',
+        :'web_push' => :'WEB_PUSH',
+        :'slack' => :'SLACK'
+      }
+    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
+      {
+        :'email' => :'Float',
+        :'inapp_web' => :'Float',
+        :'sms' => :'Float',
+        :'call' => :'Float',
+        :'voice' => :'Float',
+        :'push' => :'Float',
+        :'web_push' => :'Float',
+        :'slack' => :'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::OrganizationUsageCounts` 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::OrganizationUsageCounts`. 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?(:'email')
+        self.email = attributes[:'email']
+      else
+        self.email = nil
+      end
+
+      if attributes.key?(:'inapp_web')
+        self.inapp_web = attributes[:'inapp_web']
+      else
+        self.inapp_web = nil
+      end
+
+      if attributes.key?(:'sms')
+        self.sms = attributes[:'sms']
+      else
+        self.sms = nil
+      end
+
+      if attributes.key?(:'call')
+        self.call = attributes[:'call']
+      else
+        self.call = nil
+      end
+
+      if attributes.key?(:'voice')
+        self.voice = attributes[:'voice']
+      else
+        self.voice = nil
+      end
+
+      if attributes.key?(:'push')
+        self.push = attributes[:'push']
+      else
+        self.push = nil
+      end
+
+      if attributes.key?(:'web_push')
+        self.web_push = attributes[:'web_push']
+      else
+        self.web_push = nil
+      end
+
+      if attributes.key?(:'slack')
+        self.slack = attributes[:'slack']
+      else
+        self.slack = 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 @email.nil?
+        invalid_properties.push('invalid value for "email", email cannot be nil.')
+      end
+
+      if @inapp_web.nil?
+        invalid_properties.push('invalid value for "inapp_web", inapp_web cannot be nil.')
+      end
+
+      if @sms.nil?
+        invalid_properties.push('invalid value for "sms", sms cannot be nil.')
+      end
+
+      if @call.nil?
+        invalid_properties.push('invalid value for "call", call cannot be nil.')
+      end
+
+      if @voice.nil?
+        invalid_properties.push('invalid value for "voice", voice cannot be nil.')
+      end
+
+      if @push.nil?
+        invalid_properties.push('invalid value for "push", push cannot be nil.')
+      end
+
+      if @web_push.nil?
+        invalid_properties.push('invalid value for "web_push", web_push cannot be nil.')
+      end
+
+      if @slack.nil?
+        invalid_properties.push('invalid value for "slack", slack 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 @email.nil?
+      return false if @inapp_web.nil?
+      return false if @sms.nil?
+      return false if @call.nil?
+      return false if @voice.nil?
+      return false if @push.nil?
+      return false if @web_push.nil?
+      return false if @slack.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      if email.nil?
+        fail ArgumentError, 'email cannot be nil'
+      end
+
+      @email = email
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] inapp_web Value to be assigned
+    def inapp_web=(inapp_web)
+      if inapp_web.nil?
+        fail ArgumentError, 'inapp_web cannot be nil'
+      end
+
+      @inapp_web = inapp_web
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sms Value to be assigned
+    def sms=(sms)
+      if sms.nil?
+        fail ArgumentError, 'sms cannot be nil'
+      end
+
+      @sms = sms
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] call Value to be assigned
+    def call=(call)
+      if call.nil?
+        fail ArgumentError, 'call cannot be nil'
+      end
+
+      @call = call
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] voice Value to be assigned
+    def voice=(voice)
+      if voice.nil?
+        fail ArgumentError, 'voice cannot be nil'
+      end
+
+      @voice = voice
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] push Value to be assigned
+    def push=(push)
+      if push.nil?
+        fail ArgumentError, 'push cannot be nil'
+      end
+
+      @push = push
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] web_push Value to be assigned
+    def web_push=(web_push)
+      if web_push.nil?
+        fail ArgumentError, 'web_push cannot be nil'
+      end
+
+      @web_push = web_push
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] slack Value to be assigned
+    def slack=(slack)
+      if slack.nil?
+        fail ArgumentError, 'slack cannot be nil'
+      end
+
+      @slack = slack
+    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 &&
+          email == o.email &&
+          inapp_web == o.inapp_web &&
+          sms == o.sms &&
+          call == o.call &&
+          voice == o.voice &&
+          push == o.push &&
+          web_push == o.web_push &&
+          slack == o.slack
+    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
+      [email, inapp_web, sms, call, voice, push, web_push, slack].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_usage_history_items_inner.rb

@@ -19,34 +19,13 @@ module Pingram
     # Year-month (YYYY-MM) for this usage period
     attr_accessor :year_month
 
-    # Total message usage (EMAIL + INAPP_WEB + WEB_PUSH + PUSH + SLACK)
-    attr_accessor :message_usage
-
-    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'year_month' => :'yearMonth',
-        :'message_usage' => :'messageUsage',
-        :'budget_usage' => :'budgetUsage',
-        :'cost_sms' => :'costSms',
-        :'cost_call' => :'costCall',
-        :'cost_number' => :'costNumber',
-        :'channel_usages' => :'channelUsages'
+        :'counts' => :'counts'
       }
     end
 
@@ -64,12 +43,7 @@ module Pingram
     def self.openapi_types
       {
         :'year_month' => :'String',
-        :'message_usage' => :'Float',
-        :'budget_usage' => :'Float',
-        :'cost_sms' => :'Float',
-        :'cost_call' => :'Float',
-        :'cost_number' => :'Float',
-        :'channel_usages' => :'Hash<String, Float>'
+        :'counts' => :'OrganizationUsageHistoryItemsInnerCounts'
       }
     end
 
@@ -101,42 +75,10 @@ module Pingram
         self.year_month = nil
       end
 
-      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']
+      if attributes.key?(:'counts')
+        self.counts = attributes[:'counts']
       else
-        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
-        end
-      else
-        self.channel_usages = nil
+        self.counts = nil
       end
     end
 
@@ -149,28 +91,8 @@ module Pingram
         invalid_properties.push('invalid value for "year_month", year_month cannot be nil.')
       end
 
-      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.')
+      if @counts.nil?
+        invalid_properties.push('invalid value for "counts", counts cannot be nil.')
       end
 
       invalid_properties
@@ -181,12 +103,7 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @year_month.nil?
-      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 @counts.nil?
       true
     end
 
@@ -201,63 +118,13 @@ module Pingram
     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'
+    # @param [Object] counts Value to be assigned
+    def counts=(counts)
+      if counts.nil?
+        fail ArgumentError, 'counts cannot be nil'
       end
 
-      @channel_usages = channel_usages
+      @counts = counts
     end
 
     # Checks equality by comparing each attribute.
@@ -266,12 +133,7 @@ module Pingram
       return true if self.equal?(o)
       self.class == o.class &&
           year_month == o.year_month &&
-          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
+          counts == o.counts
     end
 
     # @see the `==` method
@@ -283,7 +145,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, cost_number, channel_usages].hash
+      [year_month, counts].hash
     end
 
     # Builds the object from hash