pingram 1.0.0 → 1.0.2

data/lib/pingram/models/organization.rb

@@ -0,0 +1,590 @@
+=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
+  # Organization document in organizations table. Holds usage caps; one org can have multiple accounts.
+  class Organization < ApiModelBase
+    attr_accessor :organization_id
+
+    attr_accessor :organization_type
+
+    attr_accessor :creator
+
+    attr_accessor :messages_cap
+
+    attr_accessor :cost_cap
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    # ISO date (YYYY-MM-DD) when the billing cycle resets.
+    attr_accessor :anniversary_date
+
+    attr_accessor :allow_overage
+
+    attr_accessor :name
+
+    attr_accessor :sms_cap
+
+    attr_accessor :call_cap
+
+    # Stripe subscription ID.
+    attr_accessor :stripe_customer_id
+
+    attr_accessor :stripe_subscription_id
+
+    attr_accessor :subscription_status
+
+    # Verification status; internalCap applies when not 'verified'.
+    attr_accessor :status
+
+    # Unverified account cap (per-channel message limit).
+    attr_accessor :internal_cap
+
+    attr_accessor :pending_downgrade_cost_cap
+
+    attr_accessor :pending_downgrade_messages_cap
+
+    attr_accessor :pending_downgrade_sms_cap
+
+    attr_accessor :pending_downgrade_call_cap
+
+    attr_accessor :pending_downgrade_internal_cap
+
+    attr_accessor :pending_downgrade_effective_date
+
+    attr_accessor :pending_downgrade_account_type
+
+    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
+      {
+        :'organization_id' => :'organizationId',
+        :'organization_type' => :'organizationType',
+        :'creator' => :'creator',
+        :'messages_cap' => :'messagesCap',
+        :'cost_cap' => :'costCap',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt',
+        :'anniversary_date' => :'anniversaryDate',
+        :'allow_overage' => :'allowOverage',
+        :'name' => :'name',
+        :'sms_cap' => :'smsCap',
+        :'call_cap' => :'callCap',
+        :'stripe_customer_id' => :'stripeCustomerId',
+        :'stripe_subscription_id' => :'stripeSubscriptionId',
+        :'subscription_status' => :'subscriptionStatus',
+        :'status' => :'status',
+        :'internal_cap' => :'internalCap',
+        :'pending_downgrade_cost_cap' => :'pendingDowngradeCostCap',
+        :'pending_downgrade_messages_cap' => :'pendingDowngradeMessagesCap',
+        :'pending_downgrade_sms_cap' => :'pendingDowngradeSmsCap',
+        :'pending_downgrade_call_cap' => :'pendingDowngradeCallCap',
+        :'pending_downgrade_internal_cap' => :'pendingDowngradeInternalCap',
+        :'pending_downgrade_effective_date' => :'pendingDowngradeEffectiveDate',
+        :'pending_downgrade_account_type' => :'pendingDowngradeAccountType'
+      }
+    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
+      {
+        :'organization_id' => :'String',
+        :'organization_type' => :'String',
+        :'creator' => :'String',
+        :'messages_cap' => :'Float',
+        :'cost_cap' => :'Float',
+        :'created_at' => :'String',
+        :'updated_at' => :'String',
+        :'anniversary_date' => :'String',
+        :'allow_overage' => :'Boolean',
+        :'name' => :'String',
+        :'sms_cap' => :'Float',
+        :'call_cap' => :'Float',
+        :'stripe_customer_id' => :'String',
+        :'stripe_subscription_id' => :'String',
+        :'subscription_status' => :'String',
+        :'status' => :'String',
+        :'internal_cap' => :'Float',
+        :'pending_downgrade_cost_cap' => :'Float',
+        :'pending_downgrade_messages_cap' => :'Float',
+        :'pending_downgrade_sms_cap' => :'Float',
+        :'pending_downgrade_call_cap' => :'Float',
+        :'pending_downgrade_internal_cap' => :'Float',
+        :'pending_downgrade_effective_date' => :'String',
+        :'pending_downgrade_account_type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'subscription_status',
+      ])
+    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::Organization` 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::Organization`. 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?(:'organization_id')
+        self.organization_id = attributes[:'organization_id']
+      else
+        self.organization_id = nil
+      end
+
+      if attributes.key?(:'organization_type')
+        self.organization_type = attributes[:'organization_type']
+      else
+        self.organization_type = nil
+      end
+
+      if attributes.key?(:'creator')
+        self.creator = attributes[:'creator']
+      else
+        self.creator = nil
+      end
+
+      if attributes.key?(:'messages_cap')
+        self.messages_cap = attributes[:'messages_cap']
+      else
+        self.messages_cap = nil
+      end
+
+      if attributes.key?(:'cost_cap')
+        self.cost_cap = attributes[:'cost_cap']
+      else
+        self.cost_cap = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'anniversary_date')
+        self.anniversary_date = attributes[:'anniversary_date']
+      else
+        self.anniversary_date = nil
+      end
+
+      if attributes.key?(:'allow_overage')
+        self.allow_overage = attributes[:'allow_overage']
+      else
+        self.allow_overage = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'sms_cap')
+        self.sms_cap = attributes[:'sms_cap']
+      end
+
+      if attributes.key?(:'call_cap')
+        self.call_cap = attributes[:'call_cap']
+      end
+
+      if attributes.key?(:'stripe_customer_id')
+        self.stripe_customer_id = attributes[:'stripe_customer_id']
+      end
+
+      if attributes.key?(:'stripe_subscription_id')
+        self.stripe_subscription_id = attributes[:'stripe_subscription_id']
+      end
+
+      if attributes.key?(:'subscription_status')
+        self.subscription_status = attributes[:'subscription_status']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'internal_cap')
+        self.internal_cap = attributes[:'internal_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_cost_cap')
+        self.pending_downgrade_cost_cap = attributes[:'pending_downgrade_cost_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_messages_cap')
+        self.pending_downgrade_messages_cap = attributes[:'pending_downgrade_messages_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_sms_cap')
+        self.pending_downgrade_sms_cap = attributes[:'pending_downgrade_sms_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_call_cap')
+        self.pending_downgrade_call_cap = attributes[:'pending_downgrade_call_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_internal_cap')
+        self.pending_downgrade_internal_cap = attributes[:'pending_downgrade_internal_cap']
+      end
+
+      if attributes.key?(:'pending_downgrade_effective_date')
+        self.pending_downgrade_effective_date = attributes[:'pending_downgrade_effective_date']
+      end
+
+      if attributes.key?(:'pending_downgrade_account_type')
+        self.pending_downgrade_account_type = attributes[:'pending_downgrade_account_type']
+      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 @organization_id.nil?
+        invalid_properties.push('invalid value for "organization_id", organization_id cannot be nil.')
+      end
+
+      if @organization_type.nil?
+        invalid_properties.push('invalid value for "organization_type", organization_type cannot be nil.')
+      end
+
+      if @creator.nil?
+        invalid_properties.push('invalid value for "creator", creator cannot be nil.')
+      end
+
+      if @messages_cap.nil?
+        invalid_properties.push('invalid value for "messages_cap", messages_cap cannot be nil.')
+      end
+
+      if @cost_cap.nil?
+        invalid_properties.push('invalid value for "cost_cap", cost_cap cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @anniversary_date.nil?
+        invalid_properties.push('invalid value for "anniversary_date", anniversary_date cannot be nil.')
+      end
+
+      if @allow_overage.nil?
+        invalid_properties.push('invalid value for "allow_overage", allow_overage cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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 @organization_id.nil?
+      return false if @organization_type.nil?
+      organization_type_validator = EnumAttributeValidator.new('String', ["free", "paid"])
+      return false unless organization_type_validator.valid?(@organization_type)
+      return false if @creator.nil?
+      return false if @messages_cap.nil?
+      return false if @cost_cap.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      return false if @anniversary_date.nil?
+      return false if @allow_overage.nil?
+      return false if @name.nil?
+      subscription_status_validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
+      return false unless subscription_status_validator.valid?(@subscription_status)
+      status_validator = EnumAttributeValidator.new('String', ["verified", "unverified", "blocked"])
+      return false unless status_validator.valid?(@status)
+      pending_downgrade_account_type_validator = EnumAttributeValidator.new('String', ["free"])
+      return false unless pending_downgrade_account_type_validator.valid?(@pending_downgrade_account_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] organization_id Value to be assigned
+    def organization_id=(organization_id)
+      if organization_id.nil?
+        fail ArgumentError, 'organization_id cannot be nil'
+      end
+
+      @organization_id = organization_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] organization_type Object to be assigned
+    def organization_type=(organization_type)
+      validator = EnumAttributeValidator.new('String', ["free", "paid"])
+      unless validator.valid?(organization_type)
+        fail ArgumentError, "invalid value for \"organization_type\", must be one of #{validator.allowable_values}."
+      end
+      @organization_type = organization_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] creator Value to be assigned
+    def creator=(creator)
+      if creator.nil?
+        fail ArgumentError, 'creator cannot be nil'
+      end
+
+      @creator = creator
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] messages_cap Value to be assigned
+    def messages_cap=(messages_cap)
+      if messages_cap.nil?
+        fail ArgumentError, 'messages_cap cannot be nil'
+      end
+
+      @messages_cap = messages_cap
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cost_cap Value to be assigned
+    def cost_cap=(cost_cap)
+      if cost_cap.nil?
+        fail ArgumentError, 'cost_cap cannot be nil'
+      end
+
+      @cost_cap = cost_cap
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] anniversary_date Value to be assigned
+    def anniversary_date=(anniversary_date)
+      if anniversary_date.nil?
+        fail ArgumentError, 'anniversary_date cannot be nil'
+      end
+
+      @anniversary_date = anniversary_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] allow_overage Value to be assigned
+    def allow_overage=(allow_overage)
+      if allow_overage.nil?
+        fail ArgumentError, 'allow_overage cannot be nil'
+      end
+
+      @allow_overage = allow_overage
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] subscription_status Object to be assigned
+    def subscription_status=(subscription_status)
+      validator = EnumAttributeValidator.new('String', ["active", "canceled", "past_due", "paused"])
+      unless validator.valid?(subscription_status)
+        fail ArgumentError, "invalid value for \"subscription_status\", must be one of #{validator.allowable_values}."
+      end
+      @subscription_status = subscription_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["verified", "unverified", "blocked"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pending_downgrade_account_type Object to be assigned
+    def pending_downgrade_account_type=(pending_downgrade_account_type)
+      validator = EnumAttributeValidator.new('String', ["free"])
+      unless validator.valid?(pending_downgrade_account_type)
+        fail ArgumentError, "invalid value for \"pending_downgrade_account_type\", must be one of #{validator.allowable_values}."
+      end
+      @pending_downgrade_account_type = pending_downgrade_account_type
+    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 &&
+          organization_id == o.organization_id &&
+          organization_type == o.organization_type &&
+          creator == o.creator &&
+          messages_cap == o.messages_cap &&
+          cost_cap == o.cost_cap &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at &&
+          anniversary_date == o.anniversary_date &&
+          allow_overage == o.allow_overage &&
+          name == o.name &&
+          sms_cap == o.sms_cap &&
+          call_cap == o.call_cap &&
+          stripe_customer_id == o.stripe_customer_id &&
+          stripe_subscription_id == o.stripe_subscription_id &&
+          subscription_status == o.subscription_status &&
+          status == o.status &&
+          internal_cap == o.internal_cap &&
+          pending_downgrade_cost_cap == o.pending_downgrade_cost_cap &&
+          pending_downgrade_messages_cap == o.pending_downgrade_messages_cap &&
+          pending_downgrade_sms_cap == o.pending_downgrade_sms_cap &&
+          pending_downgrade_call_cap == o.pending_downgrade_call_cap &&
+          pending_downgrade_internal_cap == o.pending_downgrade_internal_cap &&
+          pending_downgrade_effective_date == o.pending_downgrade_effective_date &&
+          pending_downgrade_account_type == o.pending_downgrade_account_type
+    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
+      [organization_id, organization_type, creator, messages_cap, cost_cap, created_at, updated_at, anniversary_date, allow_overage, name, sms_cap, call_cap, stripe_customer_id, stripe_subscription_id, subscription_status, status, internal_cap, pending_downgrade_cost_cap, pending_downgrade_messages_cap, pending_downgrade_sms_cap, pending_downgrade_call_cap, pending_downgrade_internal_cap, pending_downgrade_effective_date, pending_downgrade_account_type].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