orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/affected_block.rb

@@ -0,0 +1,155 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AffectedBlock Model.
+  class AffectedBlock < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :expiry_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :per_unit_cost_basis
+
+    # TODO: Write general description for this method
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['expiry_date'] = 'expiry_date'
+      @_hash['per_unit_cost_basis'] = 'per_unit_cost_basis'
+      @_hash['filters'] = 'filters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        expiry_date
+        per_unit_cost_basis
+      ]
+    end
+
+    def initialize(id:, expiry_date:, per_unit_cost_basis:, filters:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @expiry_date = expiry_date
+      @per_unit_cost_basis = per_unit_cost_basis
+      @filters = filters
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      expiry_date = if hash.key?('expiry_date')
+                      (DateTimeHelper.from_rfc3339(hash['expiry_date']) if hash['expiry_date'])
+                    end
+      per_unit_cost_basis =
+        hash.key?('per_unit_cost_basis') ? hash['per_unit_cost_basis'] : 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')
+
+      # 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.
+      AffectedBlock.new(id: id,
+                        expiry_date: expiry_date,
+                        per_unit_cost_basis: per_unit_cost_basis,
+                        filters: filters,
+                        additional_properties: additional_properties)
+    end
+
+    def to_custom_expiry_date
+      DateTimeHelper.to_rfc3339(expiry_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AffectedBlock | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.expiry_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.per_unit_cost_basis,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.filters,
+                                  ->(val) { PriceFilter.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['expiry_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['per_unit_cost_basis'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['filters'],
+                                ->(val) { PriceFilter.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} id: #{@id}, expiry_date: #{@expiry_date}, per_unit_cost_basis:"\
+      " #{@per_unit_cost_basis}, filters: #{@filters}, 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} id: #{@id.inspect}, expiry_date: #{@expiry_date.inspect},"\
+      " per_unit_cost_basis: #{@per_unit_cost_basis.inspect}, filters: #{@filters.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/aggregated_cost.rb

@@ -0,0 +1,131 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AggregatedCost Model.
+  class AggregatedCost < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Total costs for the timeframe, excluding any minimums and discounts.
+    # @return [String]
+    attr_accessor :subtotal
+
+    # Total costs for the timeframe, including any minimums and discounts.
+    # @return [String]
+    attr_accessor :total
+
+    # Total costs for the timeframe, including any minimums and discounts.
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # Total costs for the timeframe, including any minimums and discounts.
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # Total costs for the timeframe, including any minimums and discounts.
+    # @return [Array[PerPriceCost]]
+    attr_accessor :per_price_costs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['total'] = 'total'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['per_price_costs'] = 'per_price_costs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(subtotal:, total:, timeframe_start:, timeframe_end:,
+                   per_price_costs:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @subtotal = subtotal
+      @total = total
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @per_price_costs = per_price_costs
+      @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.
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      timeframe_start = if hash.key?('timeframe_start')
+                          (DateTimeHelper.from_rfc3339(hash['timeframe_start']) if hash['timeframe_start'])
+                        end
+      timeframe_end = if hash.key?('timeframe_end')
+                        (DateTimeHelper.from_rfc3339(hash['timeframe_end']) if hash['timeframe_end'])
+                      end
+      # Parameter is an array, so we need to iterate through it
+      per_price_costs = nil
+      unless hash['per_price_costs'].nil?
+        per_price_costs = []
+        hash['per_price_costs'].each do |structure|
+          per_price_costs << (PerPriceCost.from_hash(structure) if structure)
+        end
+      end
+
+      per_price_costs = nil unless hash.key?('per_price_costs')
+
+      # 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.
+      AggregatedCost.new(subtotal: subtotal,
+                         total: total,
+                         timeframe_start: timeframe_start,
+                         timeframe_end: timeframe_end,
+                         per_price_costs: per_price_costs,
+                         additional_properties: additional_properties)
+    end
+
+    def to_custom_timeframe_start
+      DateTimeHelper.to_rfc3339(timeframe_start)
+    end
+
+    def to_custom_timeframe_end
+      DateTimeHelper.to_rfc3339(timeframe_end)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} subtotal: #{@subtotal}, total: #{@total}, timeframe_start:"\
+      " #{@timeframe_start}, timeframe_end: #{@timeframe_end}, per_price_costs:"\
+      " #{@per_price_costs}, 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} subtotal: #{@subtotal.inspect}, total: #{@total.inspect}, timeframe_start:"\
+      " #{@timeframe_start.inspect}, timeframe_end: #{@timeframe_end.inspect}, per_price_costs:"\
+      " #{@per_price_costs.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/alert.rb

@@ -0,0 +1,339 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+  # usage, or credit balance and trigger webhooks when a threshold is exceeded.
+  # Alerts created through the API can be scoped to either customers or
+  # subscriptions.
+  class Alert < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Also referred to as alert_id in this documentation.
+    # @return [String]
+    attr_accessor :id
+
+    # The type of alert. This must be a valid alert type.
+    # @return [Object]
+    attr_accessor :type
+
+    # The creation time of the resource in Orb.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Whether the alert is enabled or disabled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enabled
+
+    # The thresholds that define the conditions under which the alert will be
+    # triggered.
+    # @return [Array[Threshold]]
+    attr_accessor :thresholds
+
+    # The customer the alert applies to.
+    # @return [CustomerMinified]
+    attr_accessor :customer
+
+    # The plan the alert applies to.
+    # @return [PlanMinifiedWithVersion]
+    attr_accessor :plan
+
+    # The subscription the alert applies to.
+    # @return [SubscriptionMinified]
+    attr_accessor :subscription
+
+    # The metric the alert applies to.
+    # @return [BillableMetricMinified]
+    attr_accessor :metric
+
+    # The license type the alert applies to. Only present for license alerts.
+    # @return [LicenseTypeMinified]
+    attr_accessor :license_type
+
+    # The name of the currency the credit balance or invoice cost is denominated
+    # in.
+    # @return [String]
+    attr_accessor :currency
+
+    # The property keys to group cost alerts by. Only present for cost alerts
+    # with grouping enabled.
+    # @return [Array[String]]
+    attr_accessor :grouping_keys
+
+    # Filters scoping which prices are included in grouped cost alert
+    # evaluation.
+    # @return [Array[PriceFilter]]
+    attr_accessor :price_filters
+
+    # Per-group threshold overrides. Each override maps a specific combination
+    # of grouping_keys values to a replacement threshold list. Only present for
+    # grouped cost alerts that have at least one override.
+    # @return [Array[ThresholdOverride]]
+    attr_accessor :threshold_overrides
+
+    # The current status of the alert. This field is only present for credit
+    # balance alerts.
+    # @return [Array[BalanceAlertStatus]]
+    attr_accessor :balance_alert_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['created_at'] = 'created_at'
+      @_hash['enabled'] = 'enabled'
+      @_hash['thresholds'] = 'thresholds'
+      @_hash['customer'] = 'customer'
+      @_hash['plan'] = 'plan'
+      @_hash['subscription'] = 'subscription'
+      @_hash['metric'] = 'metric'
+      @_hash['license_type'] = 'license_type'
+      @_hash['currency'] = 'currency'
+      @_hash['grouping_keys'] = 'grouping_keys'
+      @_hash['price_filters'] = 'price_filters'
+      @_hash['threshold_overrides'] = 'threshold_overrides'
+      @_hash['balance_alert_status'] = 'balance_alert_status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        license_type
+        grouping_keys
+        price_filters
+        threshold_overrides
+        balance_alert_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        thresholds
+        customer
+        plan
+        subscription
+        metric
+        license_type
+        currency
+        grouping_keys
+        price_filters
+        threshold_overrides
+        balance_alert_status
+      ]
+    end
+
+    def initialize(id:, type:, created_at:, enabled:, thresholds:, customer:,
+                   plan:, subscription:, metric:, currency:, license_type: SKIP,
+                   grouping_keys: SKIP, price_filters: SKIP,
+                   threshold_overrides: SKIP, balance_alert_status: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @type = type
+      @created_at = created_at
+      @enabled = enabled
+      @thresholds = thresholds
+      @customer = customer
+      @plan = plan
+      @subscription = subscription
+      @metric = metric
+      @license_type = license_type unless license_type == SKIP
+      @currency = currency
+      @grouping_keys = grouping_keys unless grouping_keys == SKIP
+      @price_filters = price_filters unless price_filters == SKIP
+      @threshold_overrides = threshold_overrides unless threshold_overrides == SKIP
+      @balance_alert_status = balance_alert_status unless balance_alert_status == SKIP
+      @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.
+      id = hash.key?('id') ? hash['id'] : nil
+      type = hash.key?('type') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AlertType), hash['type']
+      ) : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      enabled = hash.key?('enabled') ? hash['enabled'] : 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')
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      plan = PlanMinifiedWithVersion.from_hash(hash['plan']) if hash['plan']
+      subscription = SubscriptionMinified.from_hash(hash['subscription']) if hash['subscription']
+      metric = BillableMetricMinified.from_hash(hash['metric']) if hash['metric']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      license_type = LicenseTypeMinified.from_hash(hash['license_type']) if hash['license_type']
+      grouping_keys = hash.key?('grouping_keys') ? hash['grouping_keys'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      price_filters = nil
+      unless hash['price_filters'].nil?
+        price_filters = []
+        hash['price_filters'].each do |structure|
+          price_filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      price_filters = SKIP unless hash.key?('price_filters')
+      # Parameter is an array, so we need to iterate through it
+      threshold_overrides = nil
+      unless hash['threshold_overrides'].nil?
+        threshold_overrides = []
+        hash['threshold_overrides'].each do |structure|
+          threshold_overrides << (ThresholdOverride.from_hash(structure) if structure)
+        end
+      end
+
+      threshold_overrides = SKIP unless hash.key?('threshold_overrides')
+      # Parameter is an array, so we need to iterate through it
+      balance_alert_status = nil
+      unless hash['balance_alert_status'].nil?
+        balance_alert_status = []
+        hash['balance_alert_status'].each do |structure|
+          balance_alert_status << (BalanceAlertStatus.from_hash(structure) if structure)
+        end
+      end
+
+      balance_alert_status = SKIP unless hash.key?('balance_alert_status')
+
+      # 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.
+      Alert.new(id: id,
+                type: type,
+                created_at: created_at,
+                enabled: enabled,
+                thresholds: thresholds,
+                customer: customer,
+                plan: plan,
+                subscription: subscription,
+                metric: metric,
+                currency: currency,
+                license_type: license_type,
+                grouping_keys: grouping_keys,
+                price_filters: price_filters,
+                threshold_overrides: threshold_overrides,
+                balance_alert_status: balance_alert_status,
+                additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Alert | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            UnionTypeLookUp.get(:AlertType)
+                           .validate(value.type) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.enabled,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.thresholds,
+                                  ->(val) { Threshold.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { CustomerMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.plan,
+                                  ->(val) { PlanMinifiedWithVersion.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.subscription,
+                                  ->(val) { SubscriptionMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.metric,
+                                  ->(val) { BillableMetricMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          UnionTypeLookUp.get(:AlertType)
+                         .validate(value['type']) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['enabled'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['thresholds'],
+                                ->(val) { Threshold.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { CustomerMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['plan'],
+                                ->(val) { PlanMinifiedWithVersion.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['subscription'],
+                                ->(val) { SubscriptionMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['metric'],
+                                ->(val) { BillableMetricMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(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} id: #{@id}, type: #{@type}, created_at: #{@created_at}, enabled:"\
+      " #{@enabled}, thresholds: #{@thresholds}, customer: #{@customer}, plan: #{@plan},"\
+      " subscription: #{@subscription}, metric: #{@metric}, license_type: #{@license_type},"\
+      " currency: #{@currency}, grouping_keys: #{@grouping_keys}, price_filters:"\
+      " #{@price_filters}, threshold_overrides: #{@threshold_overrides}, balance_alert_status:"\
+      " #{@balance_alert_status}, 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} id: #{@id.inspect}, type: #{@type.inspect}, created_at:"\
+      " #{@created_at.inspect}, enabled: #{@enabled.inspect}, thresholds: #{@thresholds.inspect},"\
+      " customer: #{@customer.inspect}, plan: #{@plan.inspect}, subscription:"\
+      " #{@subscription.inspect}, metric: #{@metric.inspect}, license_type:"\
+      " #{@license_type.inspect}, currency: #{@currency.inspect}, grouping_keys:"\
+      " #{@grouping_keys.inspect}, price_filters: #{@price_filters.inspect}, threshold_overrides:"\
+      " #{@threshold_overrides.inspect}, balance_alert_status: #{@balance_alert_status.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end