orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/preview_event.rb

@@ -0,0 +1,115 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # PreviewEvent Model.
+  class PreviewEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Orb Customer identifier
+    # @return [String]
+    attr_accessor :customer_id
+
+    # An alias for the Orb customer, whose mapping is specified when creating
+    # the customer
+    # @return [String]
+    attr_accessor :external_customer_id
+
+    # A name to meaningfully identify the action or event type.
+    # @return [String]
+    attr_accessor :event_name
+
+    # An ISO 8601 format date with no timezone offset (i.e. UTC). This should
+    # represent the time that usage was recorded, and is particularly important
+    # to attribute usage to a given billing period.
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # A dictionary of custom properties. Values in this dictionary must be
+    # numeric, boolean, or strings. Nested dictionaries are disallowed.
+    # @return [Object]
+    attr_accessor :properties
+
+    # 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['event_name'] = 'event_name'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['properties'] = 'properties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        external_customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        customer_id
+        external_customer_id
+      ]
+    end
+
+    def initialize(event_name:, timestamp:, properties:, customer_id: SKIP,
+                   external_customer_id: SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @external_customer_id = external_customer_id unless external_customer_id == SKIP
+      @event_name = event_name
+      @timestamp = timestamp
+      @properties = 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.
+      event_name = hash.key?('event_name') ? hash['event_name'] : nil
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  end
+      properties = hash.key?('properties') ? hash['properties'] : nil
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      external_customer_id =
+        hash.key?('external_customer_id') ? hash['external_customer_id'] : SKIP
+
+      # Create object from extracted values.
+      PreviewEvent.new(event_name: event_name,
+                       timestamp: timestamp,
+                       properties: properties,
+                       customer_id: customer_id,
+                       external_customer_id: external_customer_id)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    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}, event_name: #{@event_name}, timestamp: #{@timestamp},"\
+      " properties: #{@properties}>"
+    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}, event_name: #{@event_name.inspect}, timestamp:"\
+      " #{@timestamp.inspect}, properties: #{@properties.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/price_evaluation_request.rb

@@ -0,0 +1,157 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PriceEvaluationRequest Model.
+  class PriceEvaluationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of a price to evaluate that exists in your Orb account.
+    # @return [String]
+    attr_accessor :price_id
+
+    # An inline price definition to evaluate, allowing you to test price
+    # configurations before adding them to Orb.
+    # @return [Object]
+    attr_accessor :price
+
+    # The external ID of a price to evaluate that exists in your Orb account.
+    # @return [String]
+    attr_accessor :external_price_id
+
+    # 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['price_id'] = 'price_id'
+      @_hash['price'] = 'price'
+      @_hash['external_price_id'] = 'external_price_id'
+      @_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[
+        price_id
+        price
+        external_price_id
+        filter
+        grouping_keys
+        metric_parameter_overrides
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        price_id
+        price
+        external_price_id
+        filter
+        metric_parameter_overrides
+      ]
+    end
+
+    def initialize(price_id: SKIP, price: SKIP, external_price_id: SKIP,
+                   filter: SKIP, grouping_keys:,
+                   metric_parameter_overrides: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @price_id = price_id unless price_id == SKIP
+      @price = price unless price == SKIP
+      @external_price_id = external_price_id unless external_price_id == SKIP
+      @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
+      @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.
+      price_id = hash.key?('price_id') ? hash['price_id'] : SKIP
+      price = hash.key?('price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:NewFloatingPrice), hash['price']
+      ) : SKIP
+      external_price_id =
+        hash.key?('external_price_id') ? hash['external_price_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 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.
+      PriceEvaluationRequest.new(price_id: price_id,
+                                 price: price,
+                                 external_price_id: external_price_id,
+                                 filter: filter,
+                                 grouping_keys: grouping_keys,
+                                 metric_parameter_overrides: metric_parameter_overrides,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PriceEvaluationRequest | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} price_id: #{@price_id}, price: #{@price}, external_price_id:"\
+      " #{@external_price_id}, filter: #{@filter}, grouping_keys: #{@grouping_keys},"\
+      " metric_parameter_overrides: #{@metric_parameter_overrides}, 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_id: #{@price_id.inspect}, price: #{@price.inspect},"\
+      " external_price_id: #{@external_price_id.inspect}, filter: #{@filter.inspect},"\
+      " grouping_keys: #{@grouping_keys.inspect}, metric_parameter_overrides:"\
+      " #{@metric_parameter_overrides.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/price_filter.rb

@@ -0,0 +1,116 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PriceFilter Model.
+  class PriceFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The property of the price to filter on.
+    # @return [Field]
+    attr_accessor :field
+
+    # Should prices that match the filter be included or excluded.
+    # @return [Operator]
+    attr_accessor :operator
+
+    # The IDs or values that match this filter.
+    # @return [Array[String]]
+    attr_accessor :values
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['field'] = 'field'
+      @_hash['operator'] = 'operator'
+      @_hash['values'] = 'values'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(field:, operator:, values:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @field = field
+      @operator = operator
+      @values = values
+      @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.
+      field = hash.key?('field') ? hash['field'] : nil
+      operator = hash.key?('operator') ? hash['operator'] : nil
+      values = hash.key?('values') ? hash['values'] : 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.
+      PriceFilter.new(field: field,
+                      operator: operator,
+                      values: values,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PriceFilter | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.field,
+                                ->(val) { Field.validate(val) }) and
+            APIHelper.valid_type?(value.operator,
+                                  ->(val) { Operator.validate(val) }) and
+            APIHelper.valid_type?(value.values,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['field'],
+                              ->(val) { Field.validate(val) }) and
+          APIHelper.valid_type?(value['operator'],
+                                ->(val) { Operator.validate(val) }) and
+          APIHelper.valid_type?(value['values'],
+                                ->(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} field: #{@field}, operator: #{@operator}, values: #{@values},"\
+      " 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} field: #{@field.inspect}, operator: #{@operator.inspect}, values:"\
+      " #{@values.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/price_group.rb

@@ -0,0 +1,132 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PriceGroup Model.
+  class PriceGroup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Grouping key to break down a single price's costs
+    # @return [String]
+    attr_accessor :grouping_key
+
+    # Grouping key to break down a single price's costs
+    # @return [String]
+    attr_accessor :grouping_value
+
+    # If the price is a matrix price, this is the second dimension key
+    # @return [String]
+    attr_accessor :secondary_grouping_key
+
+    # If the price is a matrix price, this is the second dimension key
+    # @return [String]
+    attr_accessor :secondary_grouping_value
+
+    # The price's quantity for the group
+    # @return [Float]
+    attr_accessor :quantity
+
+    # Total costs for this group for the timeframe. Note that this does not
+    # account for any minimums or discounts.
+    # @return [String]
+    attr_accessor :total
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_key'] = 'grouping_key'
+      @_hash['grouping_value'] = 'grouping_value'
+      @_hash['secondary_grouping_key'] = 'secondary_grouping_key'
+      @_hash['secondary_grouping_value'] = 'secondary_grouping_value'
+      @_hash['quantity'] = 'quantity'
+      @_hash['total'] = 'total'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        grouping_value
+        secondary_grouping_key
+        secondary_grouping_value
+        quantity
+      ]
+    end
+
+    def initialize(grouping_key:, grouping_value:, secondary_grouping_key:,
+                   secondary_grouping_value:, total:, quantity: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @grouping_key = grouping_key
+      @grouping_value = grouping_value
+      @secondary_grouping_key = secondary_grouping_key
+      @secondary_grouping_value = secondary_grouping_value
+      @quantity = quantity unless quantity == SKIP
+      @total = total
+      @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_key = hash.key?('grouping_key') ? hash['grouping_key'] : nil
+      grouping_value =
+        hash.key?('grouping_value') ? hash['grouping_value'] : nil
+      secondary_grouping_key =
+        hash.key?('secondary_grouping_key') ? hash['secondary_grouping_key'] : nil
+      secondary_grouping_value =
+        hash.key?('secondary_grouping_value') ? hash['secondary_grouping_value'] : nil
+      total = hash.key?('total') ? hash['total'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : 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.
+      PriceGroup.new(grouping_key: grouping_key,
+                     grouping_value: grouping_value,
+                     secondary_grouping_key: secondary_grouping_key,
+                     secondary_grouping_value: secondary_grouping_value,
+                     total: total,
+                     quantity: quantity,
+                     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} grouping_key: #{@grouping_key}, grouping_value: #{@grouping_value},"\
+      " secondary_grouping_key: #{@secondary_grouping_key}, secondary_grouping_value:"\
+      " #{@secondary_grouping_value}, quantity: #{@quantity}, total: #{@total},"\
+      " 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_key: #{@grouping_key.inspect}, grouping_value:"\
+      " #{@grouping_value.inspect}, secondary_grouping_key: #{@secondary_grouping_key.inspect},"\
+      " secondary_grouping_value: #{@secondary_grouping_value.inspect}, quantity:"\
+      " #{@quantity.inspect}, total: #{@total.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end