orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/field.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # The property of the price to filter on.
+  class Field
+    FIELD = [
+      # TODO: Write general description for PRICE_ID
+      PRICE_ID = 'price_id'.freeze,
+
+      # TODO: Write general description for ITEM_ID
+      ITEM_ID = 'item_id'.freeze,
+
+      # TODO: Write general description for PRICE_TYPE
+      PRICE_TYPE = 'price_type'.freeze,
+
+      # TODO: Write general description for CURRENCY
+      CURRENCY = 'currency'.freeze,
+
+      # TODO: Write general description for PRICING_UNIT_ID
+      PRICING_UNIT_ID = 'pricing_unit_id'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = PRICE_ID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'price_id' then PRICE_ID
+      when 'item_id' then ITEM_ID
+      when 'price_type' then PRICE_TYPE
+      when 'currency' then CURRENCY
+      when 'pricing_unit_id' then PRICING_UNIT_ID
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/filter_rule.rb

@@ -0,0 +1,92 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for a single property filter
+  class FilterRule < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Event property key to filter on
+    # @return [String]
+    attr_accessor :property_key
+
+    # Event property value to match
+    # @return [String]
+    attr_accessor :property_value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['property_key'] = 'property_key'
+      @_hash['property_value'] = 'property_value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(property_key:, property_value:)
+      @property_key = property_key
+      @property_value = property_value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      property_key = hash.key?('property_key') ? hash['property_key'] : nil
+      property_value =
+        hash.key?('property_value') ? hash['property_value'] : nil
+
+      # Create object from extracted values.
+      FilterRule.new(property_key: property_key,
+                     property_value: property_value)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FilterRule | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.property_key,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.property_value,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['property_key'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['property_value'],
+                                ->(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} property_key: #{@property_key}, property_value: #{@property_value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} property_key: #{@property_key.inspect}, property_value:"\
+      " #{@property_value.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/fixed_fee_quantity_change.rb

@@ -0,0 +1,116 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # FixedFeeQuantityChange Model.
+  class FixedFeeQuantityChange < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Price for which the quantity should be updated. Must be a fixed fee.
+    # @return [String]
+    attr_accessor :price_id
+
+    # Price for which the quantity should be updated. Must be a fixed fee.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # The date that the quantity change should take effect, localized to the
+    # customer's timezone. If this parameter is not passed in, the quantity
+    # change is effective according to `change_option`.
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # Determines when the change takes effect. Note that if `effective_date` is
+    # specified, this defaults to `effective_date`. Otherwise, this defaults to
+    # `immediate` unless it's explicitly set to `upcoming_invoice`.
+    # @return [ChangeOption]
+    attr_accessor :change_option
+
+    # If false, this request will fail if it would void an issued invoice or
+    # create a credit note. Consider using this as a safety mechanism if you do
+    # not expect existing invoices to be changed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :allow_invoice_credit_or_void
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_id'] = 'price_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['effective_date'] = 'effective_date'
+      @_hash['change_option'] = 'change_option'
+      @_hash['allow_invoice_credit_or_void'] = 'allow_invoice_credit_or_void'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        effective_date
+        change_option
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        effective_date
+        allow_invoice_credit_or_void
+      ]
+    end
+
+    def initialize(price_id:, quantity:, effective_date: SKIP,
+                   change_option: ChangeOption::IMMEDIATE,
+                   allow_invoice_credit_or_void: true)
+      @price_id = price_id
+      @quantity = quantity
+      @effective_date = effective_date unless effective_date == SKIP
+      @change_option = change_option unless change_option == SKIP
+      unless allow_invoice_credit_or_void == SKIP
+        @allow_invoice_credit_or_void =
+          allow_invoice_credit_or_void
+      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.
+      price_id = hash.key?('price_id') ? hash['price_id'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      effective_date =
+        hash.key?('effective_date') ? hash['effective_date'] : SKIP
+      change_option = hash['change_option'] ||= ChangeOption::IMMEDIATE
+      allow_invoice_credit_or_void =
+        hash['allow_invoice_credit_or_void'] ||= true
+
+      # Create object from extracted values.
+      FixedFeeQuantityChange.new(price_id: price_id,
+                                 quantity: quantity,
+                                 effective_date: effective_date,
+                                 change_option: change_option,
+                                 allow_invoice_credit_or_void: allow_invoice_credit_or_void)
+    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}, quantity: #{@quantity}, effective_date:"\
+      " #{@effective_date}, change_option: #{@change_option}, allow_invoice_credit_or_void:"\
+      " #{@allow_invoice_credit_or_void}>"
+    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}, quantity: #{@quantity.inspect},"\
+      " effective_date: #{@effective_date.inspect}, change_option: #{@change_option.inspect},"\
+      " allow_invoice_credit_or_void: #{@allow_invoice_credit_or_void.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/fixed_fee_quantity_schedule_entry.rb

@@ -0,0 +1,145 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # FixedFeeQuantityScheduleEntry Model.
+  class FixedFeeQuantityScheduleEntry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :price_id
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['price_id'] = 'price_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['quantity'] = 'quantity'
+      @_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(price_id:, start_date:, end_date:, quantity:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @price_id = price_id
+      @start_date = start_date
+      @end_date = end_date
+      @quantity = quantity
+      @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'] : nil
+      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
+      quantity = hash.key?('quantity') ? hash['quantity'] : 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.
+      FixedFeeQuantityScheduleEntry.new(price_id: price_id,
+                                        start_date: start_date,
+                                        end_date: end_date,
+                                        quantity: quantity,
+                                        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 [FixedFeeQuantityScheduleEntry | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.price_id,
+                                ->(val) { val.instance_of? String }) and
+            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.quantity,
+                                  ->(val) { val.instance_of? Float })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['price_id'],
+                              ->(val) { val.instance_of? String }) and
+          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['quantity'],
+                                ->(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} price_id: #{@price_id}, start_date: #{@start_date}, end_date: #{@end_date},"\
+      " quantity: #{@quantity}, 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}, start_date: #{@start_date.inspect},"\
+      " end_date: #{@end_date.inspect}, quantity: #{@quantity.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/fixed_fee_quantity_transition.rb

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

data/lib/api_reference/models/granularity.rb

@@ -0,0 +1,26 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Granularity.
+  class Granularity
+    GRANULARITY = [
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+end

data/lib/api_reference/models/grouped_allocation_config.rb

@@ -0,0 +1,79 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Configuration for grouped allocation pricing
+  class GroupedAllocationConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # How to determine the groups that should each be allocated some quantity
+    # @return [String]
+    attr_accessor :grouping_key
+
+    # Unit rate for post-allocation
+    # @return [String]
+    attr_accessor :overage_unit_rate
+
+    # Usage allocation per group
+    # @return [String]
+    attr_accessor :allocation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grouping_key'] = 'grouping_key'
+      @_hash['overage_unit_rate'] = 'overage_unit_rate'
+      @_hash['allocation'] = 'allocation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grouping_key:, overage_unit_rate:, allocation:)
+      @grouping_key = grouping_key
+      @overage_unit_rate = overage_unit_rate
+      @allocation = allocation
+    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
+      overage_unit_rate =
+        hash.key?('overage_unit_rate') ? hash['overage_unit_rate'] : nil
+      allocation = hash.key?('allocation') ? hash['allocation'] : nil
+
+      # Create object from extracted values.
+      GroupedAllocationConfig.new(grouping_key: grouping_key,
+                                  overage_unit_rate: overage_unit_rate,
+                                  allocation: allocation)
+    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}, overage_unit_rate: #{@overage_unit_rate},"\
+      " allocation: #{@allocation}>"
+    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}, overage_unit_rate:"\
+      " #{@overage_unit_rate.inspect}, allocation: #{@allocation.inspect}>"
+    end
+  end
+end