orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/evaluate_multiple_prices_with_preview_events_body.rb

@@ -0,0 +1,148 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # EvaluateMultiplePricesWithPreviewEventsBody Model.
+  class EvaluateMultiplePricesWithPreviewEventsBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the customer to which this evaluation is scoped.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # The external customer ID of the customer to which this evaluation is
+    # scoped.
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # The inclusive lower bound for event timestamps
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # The exclusive upper bound for event timestamps
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # List of preview events to use instead of actual usage data
+    # @return [Array[PreviewEvent]]
+    attr_accessor :events
+
+    # List of prices to evaluate (max 100)
+    # @return [Array[PriceEvaluationRequest]]
+    attr_accessor :price_evaluations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['events'] = 'events'
+      @_hash['price_evaluations'] = 'price_evaluations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        external_customer_id
+        events
+        price_evaluations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_id
+        external_customer_id
+      ]
+    end
+
+    def initialize(timeframe_start:, timeframe_end:, customer_id: SKIP,
+                   external_customer_id: SKIP, events: SKIP,
+                   price_evaluations: SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @events = events unless events == SKIP
+      @price_evaluations = price_evaluations unless price_evaluations == 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.
+      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
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      events = nil
+      unless hash['events'].nil?
+        events = []
+        hash['events'].each do |structure|
+          events << (PreviewEvent.from_hash(structure) if structure)
+        end
+      end
+
+      events = SKIP unless hash.key?('events')
+      # Parameter is an array, so we need to iterate through it
+      price_evaluations = nil
+      unless hash['price_evaluations'].nil?
+        price_evaluations = []
+        hash['price_evaluations'].each do |structure|
+          price_evaluations << (PriceEvaluationRequest.from_hash(structure) if structure)
+        end
+      end
+
+      price_evaluations = SKIP unless hash.key?('price_evaluations')
+
+      # Create object from extracted values.
+      EvaluateMultiplePricesWithPreviewEventsBody.new(timeframe_start: timeframe_start,
+                                                      timeframe_end: timeframe_end,
+                                                      customer_id: customer_id,
+                                                      external_customer_id: external_customer_id,
+                                                      events: events,
+                                                      price_evaluations: price_evaluations)
+    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} customer_id: #{@customer_id}, external_customer_id:"\
+      " #{@external_customer_id}, timeframe_start: #{@timeframe_start}, timeframe_end:"\
+      " #{@timeframe_end}, events: #{@events}, price_evaluations: #{@price_evaluations}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id.inspect}, external_customer_id:"\
+      " #{@external_customer_id.inspect}, timeframe_start: #{@timeframe_start.inspect},"\
+      " timeframe_end: #{@timeframe_end.inspect}, events: #{@events.inspect}, price_evaluations:"\
+      " #{@price_evaluations.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/evaluate_price_body.rb

@@ -0,0 +1,153 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # EvaluatePriceBody Model.
+  class EvaluatePriceBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the customer to which this evaluation is scoped.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # The external customer ID of the customer to which this evaluation is
+    # scoped.
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # The inclusive lower bound for event timestamps
+    # @return [DateTime]
+    attr_accessor :timeframe_start
+
+    # The exclusive upper bound for event timestamps
+    # @return [DateTime]
+    attr_accessor :timeframe_end
+
+    # A boolean [computed
+    # property](/extensibility/advanced-metrics#computed-properties) used to
+    # filter the underlying billable metric
+    # @return [String]
+    attr_accessor :filter
+
+    # Properties (or [computed
+    # properties](/extensibility/advanced-metrics#computed-properties)) used to
+    # group the underlying billable metric
+    # @return [Array[String]]
+    attr_accessor :grouping_keys
+
+    # Optional overrides for parameterized billable metric parameters. If the
+    # metric has parameter definitions and no overrides are provided, defaults
+    # will be used.
+    # @return [Object]
+    attr_accessor :metric_parameter_overrides
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['external_customer_id'] = 'external_customer_id'
+      @_hash['timeframe_start'] = 'timeframe_start'
+      @_hash['timeframe_end'] = 'timeframe_end'
+      @_hash['filter'] = 'filter'
+      @_hash['grouping_keys'] = 'grouping_keys'
+      @_hash['metric_parameter_overrides'] = 'metric_parameter_overrides'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        external_customer_id
+        filter
+        grouping_keys
+        metric_parameter_overrides
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_id
+        external_customer_id
+        filter
+        metric_parameter_overrides
+      ]
+    end
+
+    def initialize(timeframe_start:, timeframe_end:, customer_id: SKIP,
+                   external_customer_id: SKIP, filter: SKIP, grouping_keys:,
+                   metric_parameter_overrides: SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @timeframe_start = timeframe_start
+      @timeframe_end = timeframe_end
+      @filter = filter unless filter == SKIP
+      @grouping_keys = grouping_keys unless grouping_keys == SKIP
+      unless metric_parameter_overrides == SKIP
+        @metric_parameter_overrides =
+          metric_parameter_overrides
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      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
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+      filter = hash.key?('filter') ? hash['filter'] : SKIP
+      grouping_keys = hash['grouping_keys'] ||= 
+      metric_parameter_overrides =
+        hash.key?('metric_parameter_overrides') ? hash['metric_parameter_overrides'] : SKIP
+
+      # Create object from extracted values.
+      EvaluatePriceBody.new(timeframe_start: timeframe_start,
+                            timeframe_end: timeframe_end,
+                            customer_id: customer_id,
+                            external_customer_id: external_customer_id,
+                            filter: filter,
+                            grouping_keys: grouping_keys,
+                            metric_parameter_overrides: metric_parameter_overrides)
+    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} customer_id: #{@customer_id}, external_customer_id:"\
+      " #{@external_customer_id}, timeframe_start: #{@timeframe_start}, timeframe_end:"\
+      " #{@timeframe_end}, filter: #{@filter}, grouping_keys: #{@grouping_keys},"\
+      " metric_parameter_overrides: #{@metric_parameter_overrides}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id.inspect}, external_customer_id:"\
+      " #{@external_customer_id.inspect}, timeframe_start: #{@timeframe_start.inspect},"\
+      " timeframe_end: #{@timeframe_end.inspect}, filter: #{@filter.inspect}, grouping_keys:"\
+      " #{@grouping_keys.inspect}, metric_parameter_overrides:"\
+      " #{@metric_parameter_overrides.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/evaluate_price_group.rb

@@ -0,0 +1,120 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EvaluatePriceGroup Model.
+  class EvaluatePriceGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The values for the group in the order specified by `grouping_keys`
+    # @return [Array[Object]]
+    attr_accessor :grouping_values
+
+    # The price's usage quantity for the group
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The price's output for the group
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_values'] = 'grouping_values'
+      @_hash['quantity'] = 'quantity'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grouping_values:, quantity:, amount:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grouping_values = grouping_values
+      @quantity = quantity
+      @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.
+      grouping_values = hash.key?('grouping_values') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EvaluatePriceGroupGroupingValues), hash['grouping_values']
+      ) : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : 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.
+      EvaluatePriceGroup.new(grouping_values: grouping_values,
+                             quantity: quantity,
+                             amount: amount,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EvaluatePriceGroup | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:EvaluatePriceGroupGroupingValues)
+                         .validate(value.grouping_values) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:EvaluatePriceGroupGroupingValues)
+                       .validate(value['grouping_values']) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Float }) 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} grouping_values: #{@grouping_values}, quantity: #{@quantity}, 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} grouping_values: #{@grouping_values.inspect}, quantity:"\
+      " #{@quantity.inspect}, amount: #{@amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/evaluate_price_resource.rb

@@ -0,0 +1,81 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EvaluatePriceResource Model.
+  class EvaluatePriceResource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[EvaluatePriceGroup]]
+    attr_accessor :data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data'] = 'data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @data = data
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      data = nil
+      unless hash['data'].nil?
+        data = []
+        hash['data'].each do |structure|
+          data << (EvaluatePriceGroup.from_hash(structure) if structure)
+        end
+      end
+
+      data = nil unless hash.key?('data')
+
+      # 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.
+      EvaluatePriceResource.new(data: data,
+                                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} data: #{@data}, 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} data: #{@data.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/evaluate_price_resource_for_multiple_price.rb

@@ -0,0 +1,130 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EvaluatePriceResourceForMultiplePrice Model.
+  class EvaluatePriceResourceForMultiplePrice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The computed price groups associated with input price.
+    # @return [Array[EvaluatePriceGroup]]
+    attr_accessor :price_groups
+
+    # The currency of the price
+    # @return [String]
+    attr_accessor :currency
+
+    # The ID of the price
+    # @return [String]
+    attr_accessor :price_id
+
+    # The external ID of the price
+    # @return [String]
+    attr_accessor :external_price_id
+
+    # The index of the inline price
+    # @return [Integer]
+    attr_accessor :inline_price_index
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_groups'] = 'price_groups'
+      @_hash['currency'] = 'currency'
+      @_hash['price_id'] = 'price_id'
+      @_hash['external_price_id'] = 'external_price_id'
+      @_hash['inline_price_index'] = 'inline_price_index'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        price_id
+        external_price_id
+        inline_price_index
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        price_id
+        external_price_id
+        inline_price_index
+      ]
+    end
+
+    def initialize(price_groups:, currency:, price_id: SKIP,
+                   external_price_id: SKIP, inline_price_index: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @price_groups = price_groups
+      @currency = currency
+      @price_id = price_id unless price_id == SKIP
+      @external_price_id = external_price_id unless external_price_id == SKIP
+      @inline_price_index = inline_price_index unless inline_price_index == 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.
+      # Parameter is an array, so we need to iterate through it
+      price_groups = nil
+      unless hash['price_groups'].nil?
+        price_groups = []
+        hash['price_groups'].each do |structure|
+          price_groups << (EvaluatePriceGroup.from_hash(structure) if structure)
+        end
+      end
+
+      price_groups = nil unless hash.key?('price_groups')
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      price_id = hash.key?('price_id') ? hash['price_id'] : SKIP
+      external_price_id =
+        hash.key?('external_price_id') ? hash['external_price_id'] : SKIP
+      inline_price_index =
+        hash.key?('inline_price_index') ? hash['inline_price_index'] : SKIP
+
+      # 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.
+      EvaluatePriceResourceForMultiplePrice.new(price_groups: price_groups,
+                                                currency: currency,
+                                                price_id: price_id,
+                                                external_price_id: external_price_id,
+                                                inline_price_index: inline_price_index,
+                                                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} price_groups: #{@price_groups}, currency: #{@currency}, price_id:"\
+      " #{@price_id}, external_price_id: #{@external_price_id}, inline_price_index:"\
+      " #{@inline_price_index}, 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} price_groups: #{@price_groups.inspect}, currency: #{@currency.inspect},"\
+      " price_id: #{@price_id.inspect}, external_price_id: #{@external_price_id.inspect},"\
+      " inline_price_index: #{@inline_price_index.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end