pingram 1.0.1 → 1.0.3

data/lib/pingram/models/organization_usage.rb

@@ -0,0 +1,330 @@
+=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
+  # Response for GET /account/organization/usage
+  class OrganizationUsage < ApiModelBase
+    # Total message usage (EMAIL + INAPP_WEB + WEB_PUSH + PUSH + SLACK)
+    attr_accessor :message_usage
+
+    # Total budget usage in USD (cost_SMS + cost_CALL)
+    attr_accessor :budget_usage
+
+    # SMS cost in USD
+    attr_accessor :cost_sms
+
+    # Call cost in USD
+    attr_accessor :cost_call
+
+    # Per-channel usage breakdown
+    attr_accessor :channel_usages
+
+    # Billing cycle start date (ISO string)
+    attr_accessor :billing_cycle_start
+
+    # Billing cycle end date (ISO string)
+    attr_accessor :billing_cycle_end
+
+    # 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',
+        :'channel_usages' => :'channelUsages',
+        :'billing_cycle_start' => :'billingCycleStart',
+        :'billing_cycle_end' => :'billingCycleEnd'
+      }
+    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
+      {
+        :'message_usage' => :'Float',
+        :'budget_usage' => :'Float',
+        :'cost_sms' => :'Float',
+        :'cost_call' => :'Float',
+        :'channel_usages' => :'Hash<String, Float>',
+        :'billing_cycle_start' => :'String',
+        :'billing_cycle_end' => :'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::OrganizationUsage` 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::OrganizationUsage`. 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?(:'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
+      end
+
+      if attributes.key?(:'channel_usages')
+        if (value = attributes[:'channel_usages']).is_a?(Hash)
+          self.channel_usages = value
+        end
+      else
+        self.channel_usages = nil
+      end
+
+      if attributes.key?(:'billing_cycle_start')
+        self.billing_cycle_start = attributes[:'billing_cycle_start']
+      else
+        self.billing_cycle_start = nil
+      end
+
+      if attributes.key?(:'billing_cycle_end')
+        self.billing_cycle_end = attributes[:'billing_cycle_end']
+      else
+        self.billing_cycle_end = 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 @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 @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
+
+      if @billing_cycle_end.nil?
+        invalid_properties.push('invalid value for "billing_cycle_end", billing_cycle_end 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 @message_usage.nil?
+      return false if @budget_usage.nil?
+      return false if @cost_sms.nil?
+      return false if @cost_call.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] 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)
+      if billing_cycle_start.nil?
+        fail ArgumentError, 'billing_cycle_start cannot be nil'
+      end
+
+      @billing_cycle_start = billing_cycle_start
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] billing_cycle_end Value to be assigned
+    def billing_cycle_end=(billing_cycle_end)
+      if billing_cycle_end.nil?
+        fail ArgumentError, 'billing_cycle_end cannot be nil'
+      end
+
+      @billing_cycle_end = billing_cycle_end
+    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 &&
+          message_usage == o.message_usage &&
+          budget_usage == o.budget_usage &&
+          cost_sms == o.cost_sms &&
+          cost_call == o.cost_call &&
+          channel_usages == o.channel_usages &&
+          billing_cycle_start == o.billing_cycle_start &&
+          billing_cycle_end == o.billing_cycle_end
+    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
+      [message_usage, budget_usage, cost_sms, cost_call, channel_usages, billing_cycle_start, billing_cycle_end].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/{billing_post_response_body_pending_downgrade_usage_limit.rb → organization_usage_history.rb}

@@ -14,32 +14,15 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Optional new usage limits to apply when downgrade takes effect
-  class BillingPostResponseBodyPendingDowngradeUsageLimit < ApiModelBase
-    attr_accessor :email
-
-    attr_accessor :inapp_web
-
-    attr_accessor :sms
-
-    attr_accessor :call
-
-    attr_accessor :push
-
-    attr_accessor :web_push
-
-    attr_accessor :slack
+  # Response for GET /organization/usage/history
+  class OrganizationUsageHistory < ApiModelBase
+    # Array of usage items, one per month in the requested range
+    attr_accessor :items
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'email' => :'EMAIL',
-        :'inapp_web' => :'INAPP_WEB',
-        :'sms' => :'SMS',
-        :'call' => :'CALL',
-        :'push' => :'PUSH',
-        :'web_push' => :'WEB_PUSH',
-        :'slack' => :'SLACK'
+        :'items' => :'items'
       }
     end
 
@@ -56,13 +39,7 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'email' => :'Float',
-        :'inapp_web' => :'Float',
-        :'sms' => :'Float',
-        :'call' => :'Float',
-        :'push' => :'Float',
-        :'web_push' => :'Float',
-        :'slack' => :'Float'
+        :'items' => :'Array<OrganizationUsageHistoryItemsInner>'
       }
     end
 
@@ -76,44 +53,24 @@ module Pingram
     # @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::BillingPostResponseBodyPendingDowngradeUsageLimit` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::OrganizationUsageHistory` 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::BillingPostResponseBodyPendingDowngradeUsageLimit`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::OrganizationUsageHistory`. 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']
-      end
-
-      if attributes.key?(:'inapp_web')
-        self.inapp_web = attributes[:'inapp_web']
-      end
-
-      if attributes.key?(:'sms')
-        self.sms = attributes[:'sms']
-      end
-
-      if attributes.key?(:'call')
-        self.call = attributes[:'call']
-      end
-
-      if attributes.key?(:'push')
-        self.push = attributes[:'push']
-      end
-
-      if attributes.key?(:'web_push')
-        self.web_push = attributes[:'web_push']
-      end
-
-      if attributes.key?(:'slack')
-        self.slack = attributes[:'slack']
+      if attributes.key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      else
+        self.items = nil
       end
     end
 
@@ -122,6 +79,10 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @items.nil?
+        invalid_properties.push('invalid value for "items", items cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -129,21 +90,26 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @items.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] items Value to be assigned
+    def items=(items)
+      if items.nil?
+        fail ArgumentError, 'items cannot be nil'
+      end
+
+      @items = items
+    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 &&
-          push == o.push &&
-          web_push == o.web_push &&
-          slack == o.slack
+          items == o.items
     end
 
     # @see the `==` method
@@ -155,7 +121,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [email, inapp_web, sms, call, push, web_push, slack].hash
+      [items].hash
     end
 
     # Builds the object from hash