orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/tax_amount.rb

@@ -0,0 +1,123 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TaxAmount Model.
+  class TaxAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The human-readable description of the applied tax rate.
+    # @return [String]
+    attr_accessor :tax_rate_description
+
+    # The tax rate percentage, out of 100.
+    # @return [String]
+    attr_accessor :tax_rate_percentage
+
+    # The amount of additional tax incurred by this tax rate.
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_rate_description'] = 'tax_rate_description'
+      @_hash['tax_rate_percentage'] = 'tax_rate_percentage'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tax_rate_percentage
+      ]
+    end
+
+    def initialize(tax_rate_description:, tax_rate_percentage:, amount:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_rate_description = tax_rate_description
+      @tax_rate_percentage = tax_rate_percentage
+      @amount = 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.
+      tax_rate_description =
+        hash.key?('tax_rate_description') ? hash['tax_rate_description'] : nil
+      tax_rate_percentage =
+        hash.key?('tax_rate_percentage') ? hash['tax_rate_percentage'] : nil
+      amount = hash.key?('amount') ? hash['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.
+      TaxAmount.new(tax_rate_description: tax_rate_description,
+                    tax_rate_percentage: tax_rate_percentage,
+                    amount: amount,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TaxAmount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.tax_rate_description,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.tax_rate_percentage,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['tax_rate_description'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['tax_rate_percentage'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['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} tax_rate_description: #{@tax_rate_description}, tax_rate_percentage:"\
+      " #{@tax_rate_percentage}, amount: #{@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} tax_rate_description: #{@tax_rate_description.inspect},"\
+      " tax_rate_percentage: #{@tax_rate_percentage.inspect}, amount: #{@amount.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/threshold.rb

@@ -0,0 +1,90 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Thresholds are used to define the conditions under which an alert will be
+  # triggered.
+  class Threshold < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value at which an alert will fire. For credit balance alerts, the
+    # alert will fire at or below this value. For usage and cost alerts, the
+    # alert will fire at or above this value.
+    # @return [Float]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(value:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @value = value
+      @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.
+      value = hash.key?('value') ? hash['value'] : 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.
+      Threshold.new(value: value,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Threshold | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.value,
+                                     ->(val) { val.instance_of? Float })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['value'],
+                            ->(val) { val.instance_of? Float })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} value: #{@value}, 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} value: #{@value.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/threshold_discount_group.rb

@@ -0,0 +1,147 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ThresholdDiscountGroup Model.
+  class ThresholdDiscountGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # Semicolon-separated list of matrix cell coordinates targeted by this
+    # group. Each coordinate is `first,second` when the matrix has two
+    # dimensions, or just `first` for a single-dimension matrix. Example:
+    # `blue,circle;green,triangle`.
+    # @return [String]
+    attr_accessor :cell_coordinates
+
+    # Semicolon-separated list of matrix cell coordinates targeted by this
+    # group. Each coordinate is `first,second` when the matrix has two
+    # dimensions, or just `first` for a single-dimension matrix. Example:
+    # `blue,circle;green,triangle`.
+    # @return [String]
+    attr_accessor :threshold_amount
+
+    # Discount rate applied to spend at or below the threshold. Set to 0 for no
+    # baseline discount.
+    # @return [String]
+    attr_accessor :below_threshold_discount_percentage
+
+    # Discount rate applied to spend above the threshold.
+    # @return [String]
+    attr_accessor :above_threshold_discount_percentage
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['description'] = 'description'
+      @_hash['cell_coordinates'] = 'cell_coordinates'
+      @_hash['threshold_amount'] = 'threshold_amount'
+      @_hash['below_threshold_discount_percentage'] =
+        'below_threshold_discount_percentage'
+      @_hash['above_threshold_discount_percentage'] =
+        'above_threshold_discount_percentage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(cell_coordinates:, threshold_amount:,
+                   below_threshold_discount_percentage:,
+                   above_threshold_discount_percentage:, description: SKIP)
+      @description = description unless description == SKIP
+      @cell_coordinates = cell_coordinates
+      @threshold_amount = threshold_amount
+      @below_threshold_discount_percentage = below_threshold_discount_percentage
+      @above_threshold_discount_percentage = above_threshold_discount_percentage
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cell_coordinates =
+        hash.key?('cell_coordinates') ? hash['cell_coordinates'] : nil
+      threshold_amount =
+        hash.key?('threshold_amount') ? hash['threshold_amount'] : nil
+      below_threshold_discount_percentage =
+        hash.key?('below_threshold_discount_percentage') ? hash['below_threshold_discount_percentage'] : nil
+      above_threshold_discount_percentage =
+        hash.key?('above_threshold_discount_percentage') ? hash['above_threshold_discount_percentage'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      ThresholdDiscountGroup.new(cell_coordinates: cell_coordinates,
+                                 threshold_amount: threshold_amount,
+                                 below_threshold_discount_percentage: below_threshold_discount_percentage,
+                                 above_threshold_discount_percentage: above_threshold_discount_percentage,
+                                 description: description)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ThresholdDiscountGroup | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.cell_coordinates,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.threshold_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.below_threshold_discount_percentage,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.above_threshold_discount_percentage,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['cell_coordinates'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['threshold_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['below_threshold_discount_percentage'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['above_threshold_discount_percentage'],
+                                ->(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} description: #{@description}, cell_coordinates: #{@cell_coordinates},"\
+      " threshold_amount: #{@threshold_amount}, below_threshold_discount_percentage:"\
+      " #{@below_threshold_discount_percentage}, above_threshold_discount_percentage:"\
+      " #{@above_threshold_discount_percentage}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} description: #{@description.inspect}, cell_coordinates:"\
+      " #{@cell_coordinates.inspect}, threshold_amount: #{@threshold_amount.inspect},"\
+      " below_threshold_discount_percentage: #{@below_threshold_discount_percentage.inspect},"\
+      " above_threshold_discount_percentage: #{@above_threshold_discount_percentage.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/threshold_override.rb

@@ -0,0 +1,121 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # A per-group threshold override on a grouped cost alert. An empty
+  # `thresholds` list means the group is silenced (never fires). A non-empty
+  # list fully replaces the default thresholds for that group.
+  class ThresholdOverride < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The values of the grouping keys that identify this group. The list length
+    # matches the alert's grouping_keys.
+    # @return [Array[String]]
+    attr_accessor :group_values
+
+    # The thresholds applied to this group. An empty list means the group is
+    # silenced.
+    # @return [Array[Threshold]]
+    attr_accessor :thresholds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['group_values'] = 'group_values'
+      @_hash['thresholds'] = 'thresholds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(group_values:, thresholds:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @group_values = group_values
+      @thresholds = thresholds
+      @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.
+      group_values = hash.key?('group_values') ? hash['group_values'] : nil
+      # Parameter is an array, so we need to iterate through it
+      thresholds = nil
+      unless hash['thresholds'].nil?
+        thresholds = []
+        hash['thresholds'].each do |structure|
+          thresholds << (Threshold.from_hash(structure) if structure)
+        end
+      end
+
+      thresholds = nil unless hash.key?('thresholds')
+
+      # 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.
+      ThresholdOverride.new(group_values: group_values,
+                            thresholds: thresholds,
+                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ThresholdOverride | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.group_values,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.thresholds,
+                                  ->(val) { Threshold.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['group_values'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['thresholds'],
+                                ->(val) { Threshold.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} group_values: #{@group_values}, thresholds: #{@thresholds},"\
+      " 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} group_values: #{@group_values.inspect}, thresholds: #{@thresholds.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/threshold_override_params.rb

@@ -0,0 +1,97 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Per-group threshold override on a grouped cost alert. - An empty
+  # `thresholds` list silences alerts for this group (never fires). - A
+  # non-empty list fully replaces the default thresholds for this group.
+  class ThresholdOverrideParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The values of the grouping keys that identify this group. The list length
+    # must match the alert's grouping_keys, and values appear in the same order
+    # as grouping_keys.
+    # @return [Array[String]]
+    attr_accessor :group_values
+
+    # The thresholds to apply to this group. An empty list silences alerts for
+    # this group. A non-empty list fully replaces the default thresholds for
+    # this group.
+    # @return [Array[Threshold]]
+    attr_accessor :thresholds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['group_values'] = 'group_values'
+      @_hash['thresholds'] = 'thresholds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(group_values:, thresholds:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @group_values = group_values
+      @thresholds = thresholds
+      @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.
+      group_values = hash.key?('group_values') ? hash['group_values'] : nil
+      # Parameter is an array, so we need to iterate through it
+      thresholds = nil
+      unless hash['thresholds'].nil?
+        thresholds = []
+        hash['thresholds'].each do |structure|
+          thresholds << (Threshold.from_hash(structure) if structure)
+        end
+      end
+
+      thresholds = nil unless hash.key?('thresholds')
+
+      # 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.
+      ThresholdOverrideParams.new(group_values: group_values,
+                                  thresholds: thresholds,
+                                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} group_values: #{@group_values}, thresholds: #{@thresholds},"\
+      " 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} group_values: #{@group_values.inspect}, thresholds: #{@thresholds.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/threshold_total_amount_config.rb

@@ -0,0 +1,83 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for tiered total pricing
+  class ThresholdTotalAmountConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # When the quantity consumed passes a provided threshold, the configured
+    # total will be charged
+    # @return [Array[TieredTotalThreshold]]
+    attr_accessor :consumption_table
+
+    # If true, the unit price will be prorated to the billing period
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prorate
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['consumption_table'] = 'consumption_table'
+      @_hash['prorate'] = 'prorate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        prorate
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        prorate
+      ]
+    end
+
+    def initialize(consumption_table:, prorate: false)
+      @consumption_table = consumption_table
+      @prorate = prorate unless prorate == 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.
+      # Parameter is an array, so we need to iterate through it
+      consumption_table = nil
+      unless hash['consumption_table'].nil?
+        consumption_table = []
+        hash['consumption_table'].each do |structure|
+          consumption_table << (TieredTotalThreshold.from_hash(structure) if structure)
+        end
+      end
+
+      consumption_table = nil unless hash.key?('consumption_table')
+      prorate = hash['prorate'] ||= false
+
+      # Create object from extracted values.
+      ThresholdTotalAmountConfig.new(consumption_table: consumption_table,
+                                     prorate: prorate)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumption_table: #{@consumption_table}, prorate: #{@prorate}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} consumption_table: #{@consumption_table.inspect}, prorate:"\
+      " #{@prorate.inspect}>"
+    end
+  end
+end