orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/edit_price_interval_params.rb

@@ -0,0 +1,237 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EditPriceIntervalParams Model.
+  class EditPriceIntervalParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of customer IDs whose usage events will be aggregated and billed
+    # under this subscription. By default, a subscription only considers usage
+    # events associated with its attached customer's customer_id. When
+    # usage_customer_ids is provided, the subscription includes usage events
+    # from the specified customers only. Provided usage_customer_ids must be
+    # either the customer for this subscription itself, or any of that
+    # customer's children.
+    # @return [Array[String]]
+    attr_accessor :usage_customer_ids
+
+    # An additional filter to apply to usage queries. This filter must be
+    # expressed as a boolean [computed
+    # property](/extensibility/advanced-metrics#computed-properties). If null,
+    # usage queries will not include any additional filter.
+    # @return [String]
+    attr_accessor :filter
+
+    # The id of the price interval to edit.
+    # @return [String]
+    attr_accessor :price_interval_id
+
+    # The updated start date of this price interval. If not specified, the start
+    # date will not be updated.
+    # @return [Object]
+    attr_accessor :start_date
+
+    # The updated end date of this price interval. If not specified, the end
+    # date will not be updated.
+    # @return [Object]
+    attr_accessor :end_date
+
+    # A list of fixed fee quantity transitions to use for this price interval.
+    # Note that this list will overwrite all existing fixed fee quantity
+    # transitions on the price interval.
+    # @return [Array[PriceIntervalFixedFeeQuantityTransitionParams]]
+    attr_accessor :fixed_fee_quantity_transitions
+
+    # The updated billing cycle day for this price interval. If not specified,
+    # the billing cycle day will not be updated. Note that overlapping price
+    # intervals must have the same billing cycle day.
+    # @return [Integer]
+    attr_accessor :billing_cycle_day
+
+    # If true, an in-arrears price interval ending mid-cycle will defer billing
+    # the final line item until the next scheduled invoice. If false, it will be
+    # billed on its end date.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_defer_billing
+
+    # Override values for parameterized billable metric variables. Keys are
+    # parameter names, values are the override values (number or string).
+    # @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['usage_customer_ids'] = 'usage_customer_ids'
+      @_hash['filter'] = 'filter'
+      @_hash['price_interval_id'] = 'price_interval_id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['fixed_fee_quantity_transitions'] =
+        'fixed_fee_quantity_transitions'
+      @_hash['billing_cycle_day'] = 'billing_cycle_day'
+      @_hash['can_defer_billing'] = 'can_defer_billing'
+      @_hash['metric_parameter_overrides'] = 'metric_parameter_overrides'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        usage_customer_ids
+        filter
+        start_date
+        end_date
+        fixed_fee_quantity_transitions
+        billing_cycle_day
+        can_defer_billing
+        metric_parameter_overrides
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        usage_customer_ids
+        filter
+        end_date
+        fixed_fee_quantity_transitions
+        billing_cycle_day
+        can_defer_billing
+        metric_parameter_overrides
+      ]
+    end
+
+    def initialize(price_interval_id:, usage_customer_ids: SKIP, filter: SKIP,
+                   start_date: SKIP, end_date: SKIP,
+                   fixed_fee_quantity_transitions: SKIP,
+                   billing_cycle_day: SKIP, can_defer_billing: SKIP,
+                   metric_parameter_overrides: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @usage_customer_ids = usage_customer_ids unless usage_customer_ids == SKIP
+      @filter = filter unless filter == SKIP
+      @price_interval_id = price_interval_id
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      unless fixed_fee_quantity_transitions == SKIP
+        @fixed_fee_quantity_transitions =
+          fixed_fee_quantity_transitions
+      end
+      @billing_cycle_day = billing_cycle_day unless billing_cycle_day == SKIP
+      @can_defer_billing = can_defer_billing unless can_defer_billing == 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_interval_id =
+        hash.key?('price_interval_id') ? hash['price_interval_id'] : nil
+      usage_customer_ids =
+        hash.key?('usage_customer_ids') ? hash['usage_customer_ids'] : SKIP
+      filter = hash.key?('filter') ? hash['filter'] : SKIP
+      start_date = hash.key?('start_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EditPriceIntervalParamsStartDate), hash['start_date']
+      ) : SKIP
+      end_date = hash.key?('end_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EditPriceIntervalParamsEndDate), hash['end_date']
+      ) : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fixed_fee_quantity_transitions = nil
+      unless hash['fixed_fee_quantity_transitions'].nil?
+        fixed_fee_quantity_transitions = []
+        hash['fixed_fee_quantity_transitions'].each do |structure|
+          fixed_fee_quantity_transitions << (PriceIntervalFixedFeeQuantityTransitionParams.from_hash(structure) if structure)
+        end
+      end
+
+      fixed_fee_quantity_transitions = SKIP unless hash.key?('fixed_fee_quantity_transitions')
+      billing_cycle_day =
+        hash.key?('billing_cycle_day') ? hash['billing_cycle_day'] : SKIP
+      can_defer_billing =
+        hash.key?('can_defer_billing') ? hash['can_defer_billing'] : SKIP
+      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.
+      EditPriceIntervalParams.new(price_interval_id: price_interval_id,
+                                  usage_customer_ids: usage_customer_ids,
+                                  filter: filter,
+                                  start_date: start_date,
+                                  end_date: end_date,
+                                  fixed_fee_quantity_transitions: fixed_fee_quantity_transitions,
+                                  billing_cycle_day: billing_cycle_day,
+                                  can_defer_billing: can_defer_billing,
+                                  metric_parameter_overrides: metric_parameter_overrides,
+                                  additional_properties: additional_properties)
+    end
+
+    def to_union_type_start_date
+      UnionTypeLookUp.get(:EditPriceIntervalParamsStartDate)
+                     .validate(start_date)
+                     .serialize(start_date)
+    end
+
+    def to_union_type_end_date
+      UnionTypeLookUp.get(:EditPriceIntervalParamsEndDate)
+                     .validate(end_date)
+                     .serialize(end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EditPriceIntervalParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.price_interval_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['price_interval_id'],
+                            ->(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} usage_customer_ids: #{@usage_customer_ids}, filter: #{@filter},"\
+      " price_interval_id: #{@price_interval_id}, start_date: #{@start_date}, end_date:"\
+      " #{@end_date}, fixed_fee_quantity_transitions: #{@fixed_fee_quantity_transitions},"\
+      " billing_cycle_day: #{@billing_cycle_day}, can_defer_billing: #{@can_defer_billing},"\
+      " 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} usage_customer_ids: #{@usage_customer_ids.inspect}, filter:"\
+      " #{@filter.inspect}, price_interval_id: #{@price_interval_id.inspect}, start_date:"\
+      " #{@start_date.inspect}, end_date: #{@end_date.inspect}, fixed_fee_quantity_transitions:"\
+      " #{@fixed_fee_quantity_transitions.inspect}, billing_cycle_day:"\
+      " #{@billing_cycle_day.inspect}, can_defer_billing: #{@can_defer_billing.inspect},"\
+      " metric_parameter_overrides: #{@metric_parameter_overrides.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/effective_time.rb

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

data/lib/api_reference/models/end_of_term.rb

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

data/lib/api_reference/models/entry_status.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Entry Status.
+  class EntryStatus
+    ENTRY_STATUS = [
+      # TODO: Write general description for COMMITTED
+      COMMITTED = 'committed'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = COMMITTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'committed' then COMMITTED
+      when 'pending' then PENDING
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/entry_type.rb

@@ -0,0 +1,56 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Entry Type.
+  class EntryType
+    ENTRY_TYPE = [
+      # TODO: Write general description for INCREMENT
+      INCREMENT = 'increment'.freeze,
+
+      # TODO: Write general description for DECREMENT
+      DECREMENT = 'decrement'.freeze,
+
+      # TODO: Write general description for EXPIRATION_CHANGE
+      EXPIRATION_CHANGE = 'expiration_change'.freeze,
+
+      # TODO: Write general description for CREDIT_BLOCK_EXPIRY
+      CREDIT_BLOCK_EXPIRY = 'credit_block_expiry'.freeze,
+
+      # TODO: Write general description for VOID
+      VOID = 'void'.freeze,
+
+      # TODO: Write general description for VOID_INITIATED
+      VOID_INITIATED = 'void_initiated'.freeze,
+
+      # TODO: Write general description for AMENDMENT
+      AMENDMENT = 'amendment'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = INCREMENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'increment' then INCREMENT
+      when 'decrement' then DECREMENT
+      when 'expiration_change' then EXPIRATION_CHANGE
+      when 'credit_block_expiry' then CREDIT_BLOCK_EXPIRY
+      when 'void' then VOID
+      when 'void_initiated' then VOID_INITIATED
+      when 'amendment' then AMENDMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/evaluate_multiple_price_resource.rb

@@ -0,0 +1,81 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # EvaluateMultiplePriceResource Model.
+  class EvaluateMultiplePriceResource < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[EvaluatePriceResourceForMultiplePrice]]
+    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 << (EvaluatePriceResourceForMultiplePrice.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.
+      EvaluateMultiplePriceResource.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_multiple_prices_body.rb

@@ -0,0 +1,129 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # EvaluateMultiplePricesBody Model.
+  class EvaluateMultiplePricesBody < 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 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['price_evaluations'] = 'price_evaluations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        external_customer_id
+        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, 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
+      @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
+      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.
+      EvaluateMultiplePricesBody.new(timeframe_start: timeframe_start,
+                                     timeframe_end: timeframe_end,
+                                     customer_id: customer_id,
+                                     external_customer_id: external_customer_id,
+                                     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}, 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}, price_evaluations:"\
+      " #{@price_evaluations.inspect}>"
+    end
+  end
+end