orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/maximum.rb

@@ -0,0 +1,135 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Maximum Model.
+  class Maximum < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum amount applied
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # The filters that determine which prices to apply this maximum to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # List of price_ids that this maximum amount applies to. For plan/plan phase
+    # maximums, this can be a subset of prices.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash['filters'] = 'filters'
+      @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(maximum_amount:, filters:, applies_to_price_ids:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @maximum_amount = maximum_amount
+      @filters = filters
+      @applies_to_price_ids = applies_to_price_ids
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : nil
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = nil unless hash.key?('filters')
+      applies_to_price_ids =
+        hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Maximum.new(maximum_amount: maximum_amount,
+                  filters: filters,
+                  applies_to_price_ids: applies_to_price_ids,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Maximum | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.maximum_amount,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.filters,
+                                  ->(val) { PriceFilter.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.applies_to_price_ids,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['maximum_amount'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['filters'],
+                                ->(val) { PriceFilter.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['applies_to_price_ids'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} maximum_amount: #{@maximum_amount}, filters: #{@filters},"\
+      " applies_to_price_ids: #{@applies_to_price_ids}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} maximum_amount: #{@maximum_amount.inspect}, filters: #{@filters.inspect},"\
+      " applies_to_price_ids: #{@applies_to_price_ids.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/maximum_interval.rb

@@ -0,0 +1,177 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # MaximumInterval Model.
+  class MaximumInterval < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The start date of the maximum interval.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the maximum interval.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The filters that determine which prices this maximum interval applies to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # The price interval ids that this maximum interval applies to.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_interval_ids
+
+    # The maximum amount to charge in a given billing period for the price
+    # intervals this transform applies to.
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['filters'] = 'filters'
+      @_hash['applies_to_price_interval_ids'] =
+        'applies_to_price_interval_ids'
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+      ]
+    end
+
+    def initialize(start_date:, end_date:, filters:,
+                   applies_to_price_interval_ids:, maximum_amount:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date
+      @end_date = end_date
+      @filters = filters
+      @applies_to_price_interval_ids = applies_to_price_interval_ids
+      @maximum_amount = maximum_amount
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start_date = if hash.key?('start_date')
+                     (DateTimeHelper.from_rfc3339(hash['start_date']) if hash['start_date'])
+                   end
+      end_date = if hash.key?('end_date')
+                   (DateTimeHelper.from_rfc3339(hash['end_date']) if hash['end_date'])
+                 end
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = nil unless hash.key?('filters')
+      applies_to_price_interval_ids =
+        hash.key?('applies_to_price_interval_ids') ? hash['applies_to_price_interval_ids'] : nil
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      MaximumInterval.new(start_date: start_date,
+                          end_date: end_date,
+                          filters: filters,
+                          applies_to_price_interval_ids: applies_to_price_interval_ids,
+                          maximum_amount: maximum_amount,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_start_date
+      DateTimeHelper.to_rfc3339(start_date)
+    end
+
+    def to_custom_end_date
+      DateTimeHelper.to_rfc3339(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MaximumInterval | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.start_date,
+                                ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.filters,
+                                  ->(val) { PriceFilter.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.applies_to_price_interval_ids,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.maximum_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['start_date'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['filters'],
+                                ->(val) { PriceFilter.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['applies_to_price_interval_ids'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['maximum_amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, filters: #{@filters},"\
+      " applies_to_price_interval_ids: #{@applies_to_price_interval_ids}, maximum_amount:"\
+      " #{@maximum_amount}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " filters: #{@filters.inspect}, applies_to_price_interval_ids:"\
+      " #{@applies_to_price_interval_ids.inspect}, maximum_amount: #{@maximum_amount.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/metered_allowance_config.rb

@@ -0,0 +1,130 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Charges a per-unit rate on consumption above an allowance whose size is
+  # itself metered from usage in the same period. Both quantities come from a
+  # single billable metric, partitioned by `grouping_key`. The line item shows
+  # two sub-lines under one parent: the gross consumption row and a (negative)
+  # allowance credit row. The parent line equals the net charge, never negative
+  # — so adjustments, tax, prepaid credits, and rev rec all behave like any
+  # other usage line. Use cases: free egress proportional to bytes stored; free
+  # outbound bandwidth proportional to compute hours; free messages proportional
+  # to seat count; free output tokens proportional to input tokens.
+  class MeteredAllowanceConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Event property used to partition the metric into consumption and allowance
+    # quantities (e.g. 'event_name'). The metric is queried with this key and
+    # the two values below select which partition is which.
+    # @return [String]
+    attr_accessor :grouping_key
+
+    # The grouping_key value whose summed quantity represents consumption (e.g.
+    # 'download'). Charged at unit_amount.
+    # @return [String]
+    attr_accessor :consumption_grouping_value
+
+    # The grouping_key value whose summed quantity represents the allowance for
+    # this period (e.g. 'storage_snapshot' emitting 3 × avg storage). Capped at
+    # consumption — credit can never exceed actual usage.
+    # @return [String]
+    attr_accessor :allowance_grouping_value
+
+    # Per-unit price applied to gross consumption and to the allowance credit.
+    # @return [String]
+    attr_accessor :unit_amount
+
+    # Sub-line label for the gross consumption row (e.g. 'bytes gotten').
+    # @return [String]
+    attr_accessor :consumption_display_name
+
+    # Sub-line label for the credit row (e.g. 'Up to 3x free egress').
+    # @return [String]
+    attr_accessor :allowance_display_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_key'] = 'grouping_key'
+      @_hash['consumption_grouping_value'] = 'consumption_grouping_value'
+      @_hash['allowance_grouping_value'] = 'allowance_grouping_value'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['consumption_display_name'] = 'consumption_display_name'
+      @_hash['allowance_display_name'] = 'allowance_display_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consumption_display_name
+        allowance_display_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grouping_key:, consumption_grouping_value:,
+                   allowance_grouping_value:, unit_amount:,
+                   consumption_display_name: 'Consumption',
+                   allowance_display_name: 'Allowance credit')
+      @grouping_key = grouping_key
+      @consumption_grouping_value = consumption_grouping_value
+      @allowance_grouping_value = allowance_grouping_value
+      @unit_amount = unit_amount
+      @consumption_display_name = consumption_display_name unless consumption_display_name == SKIP
+      @allowance_display_name = allowance_display_name unless allowance_display_name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grouping_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil
+      consumption_grouping_value =
+        hash.key?('consumption_grouping_value') ? hash['consumption_grouping_value'] : nil
+      allowance_grouping_value =
+        hash.key?('allowance_grouping_value') ? hash['allowance_grouping_value'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+      consumption_display_name =
+        hash['consumption_display_name'] ||= 'Consumption'
+      allowance_display_name =
+        hash['allowance_display_name'] ||= 'Allowance credit'
+
+      # Create object from extracted values.
+      MeteredAllowanceConfig.new(grouping_key: grouping_key,
+                                 consumption_grouping_value: consumption_grouping_value,
+                                 allowance_grouping_value: allowance_grouping_value,
+                                 unit_amount: unit_amount,
+                                 consumption_display_name: consumption_display_name,
+                                 allowance_display_name: allowance_display_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key}, consumption_grouping_value:"\
+      " #{@consumption_grouping_value}, allowance_grouping_value: #{@allowance_grouping_value},"\
+      " unit_amount: #{@unit_amount}, consumption_display_name: #{@consumption_display_name},"\
+      " allowance_display_name: #{@allowance_display_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key.inspect}, consumption_grouping_value:"\
+      " #{@consumption_grouping_value.inspect}, allowance_grouping_value:"\
+      " #{@allowance_grouping_value.inspect}, unit_amount: #{@unit_amount.inspect},"\
+      " consumption_display_name: #{@consumption_display_name.inspect}, allowance_display_name:"\
+      " #{@allowance_display_name.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/metered_allowance_config1.rb

@@ -0,0 +1,152 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for metered_allowance pricing
+  class MeteredAllowanceConfig1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Event property used to partition the metric into consumption and allowance
+    # quantities (e.g. 'event_name'). The metric is queried with this key and
+    # the two values below select which partition is which.
+    # @return [String]
+    attr_accessor :grouping_key
+
+    # The grouping_key value whose summed quantity represents consumption (e.g.
+    # 'download'). Charged at unit_amount.
+    # @return [String]
+    attr_accessor :consumption_grouping_value
+
+    # The grouping_key value whose summed quantity represents the allowance for
+    # this period (e.g. 'storage_snapshot' emitting 3 × avg storage). Capped at
+    # consumption — credit can never exceed actual usage.
+    # @return [String]
+    attr_accessor :allowance_grouping_value
+
+    # Per-unit price applied to gross consumption and to the allowance credit.
+    # @return [String]
+    attr_accessor :unit_amount
+
+    # Sub-line label for the gross consumption row (e.g. 'bytes gotten').
+    # @return [String]
+    attr_accessor :consumption_display_name
+
+    # Sub-line label for the credit row (e.g. 'Up to 3x free egress').
+    # @return [String]
+    attr_accessor :allowance_display_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_key'] = 'grouping_key'
+      @_hash['consumption_grouping_value'] = 'consumption_grouping_value'
+      @_hash['allowance_grouping_value'] = 'allowance_grouping_value'
+      @_hash['unit_amount'] = 'unit_amount'
+      @_hash['consumption_display_name'] = 'consumption_display_name'
+      @_hash['allowance_display_name'] = 'allowance_display_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        consumption_display_name
+        allowance_display_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grouping_key:, consumption_grouping_value:,
+                   allowance_grouping_value:, unit_amount:,
+                   consumption_display_name: 'Consumption',
+                   allowance_display_name: 'Allowance credit')
+      @grouping_key = grouping_key
+      @consumption_grouping_value = consumption_grouping_value
+      @allowance_grouping_value = allowance_grouping_value
+      @unit_amount = unit_amount
+      @consumption_display_name = consumption_display_name unless consumption_display_name == SKIP
+      @allowance_display_name = allowance_display_name unless allowance_display_name == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      grouping_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil
+      consumption_grouping_value =
+        hash.key?('consumption_grouping_value') ? hash['consumption_grouping_value'] : nil
+      allowance_grouping_value =
+        hash.key?('allowance_grouping_value') ? hash['allowance_grouping_value'] : nil
+      unit_amount = hash.key?('unit_amount') ? hash['unit_amount'] : nil
+      consumption_display_name =
+        hash['consumption_display_name'] ||= 'Consumption'
+      allowance_display_name =
+        hash['allowance_display_name'] ||= 'Allowance credit'
+
+      # Create object from extracted values.
+      MeteredAllowanceConfig1.new(grouping_key: grouping_key,
+                                  consumption_grouping_value: consumption_grouping_value,
+                                  allowance_grouping_value: allowance_grouping_value,
+                                  unit_amount: unit_amount,
+                                  consumption_display_name: consumption_display_name,
+                                  allowance_display_name: allowance_display_name)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [MeteredAllowanceConfig1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.grouping_key,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.consumption_grouping_value,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.allowance_grouping_value,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.unit_amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['grouping_key'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['consumption_grouping_value'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['allowance_grouping_value'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['unit_amount'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key}, consumption_grouping_value:"\
+      " #{@consumption_grouping_value}, allowance_grouping_value: #{@allowance_grouping_value},"\
+      " unit_amount: #{@unit_amount}, consumption_display_name: #{@consumption_display_name},"\
+      " allowance_display_name: #{@allowance_display_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} grouping_key: #{@grouping_key.inspect}, consumption_grouping_value:"\
+      " #{@consumption_grouping_value.inspect}, allowance_grouping_value:"\
+      " #{@allowance_grouping_value.inspect}, unit_amount: #{@unit_amount.inspect},"\
+      " consumption_display_name: #{@consumption_display_name.inspect}, allowance_display_name:"\
+      " #{@allowance_display_name.inspect}>"
+    end
+  end
+end