orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/price_interval.rb

@@ -0,0 +1,319 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # The Price Interval resource represents a period of time for which a price
+  # will bill on a subscription. A subscription’s price intervals define its
+  # billing behavior.
+  class PriceInterval < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # The start date of the price interval. This is the date that Orb starts
+    # billing for this price.
+    # @return [DateTime]
+    attr_accessor :start_date
+
+    # The end date of the price interval. This is the date that Orb stops
+    # billing for this price.
+    # @return [DateTime]
+    attr_accessor :end_date
+
+    # The Price resource represents a price that can be billed on a
+    # subscription, resulting in a charge on an invoice in
+    # the form of an invoice line item. Prices take a quantity and determine an
+    # amount to bill.
+    # Orb supports a few different pricing models out of the box. Each of these
+    # models is serialized differently in a
+    # given Price object. The model_type field determines the key for the
+    # configuration object that is present.
+    # For more on the types of prices, see [the core concepts
+    # documentation](/core-concepts#plan-and-price)
+    # @return [Object]
+    attr_accessor :price
+
+    # The day of the month that Orb bills for this price
+    # @return [Integer]
+    attr_accessor :billing_cycle_day
+
+    # For in-arrears prices. If true, and the price interval ends mid-cycle, the
+    # final line item will be deferred to the next scheduled invoice instead of
+    # being billed mid-cycle.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :can_defer_billing
+
+    # The fixed fee quantity transitions for this price interval. This is only
+    # relevant for fixed fees.
+    # @return [Array[FixedFeeQuantityTransition]]
+    attr_accessor :fixed_fee_quantity_transitions
+
+    # The start date of the current billing period. This is an inclusive
+    # timestamp; the instant returned is exactly the beginning of the billing
+    # period. Set to null if this price interval is not currently active.
+    # @return [DateTime]
+    attr_accessor :current_billing_period_start_date
+
+    # The end of the current billing period. This is an exclusive timestamp,
+    # such that the instant returned is exactly the end of the billing period.
+    # Set to null if this price interval is not currently active.
+    # @return [DateTime]
+    attr_accessor :current_billing_period_end_date
+
+    # An additional filter to apply to usage queries.
+    # @return [String]
+    attr_accessor :filter
+
+    # A list of customer IDs whose usage events will be aggregated and billed
+    # under this price interval.
+    # @return [Array[String]]
+    attr_accessor :usage_customer_ids
+
+    # Override values for parameterized billable metric variables. Keys are
+    # parameter names, values are the override values.
+    # @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['id'] = 'id'
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['price'] = 'price'
+      @_hash['billing_cycle_day'] = 'billing_cycle_day'
+      @_hash['can_defer_billing'] = 'can_defer_billing'
+      @_hash['fixed_fee_quantity_transitions'] =
+        'fixed_fee_quantity_transitions'
+      @_hash['current_billing_period_start_date'] =
+        'current_billing_period_start_date'
+      @_hash['current_billing_period_end_date'] =
+        'current_billing_period_end_date'
+      @_hash['filter'] = 'filter'
+      @_hash['usage_customer_ids'] = 'usage_customer_ids'
+      @_hash['metric_parameter_overrides'] = 'metric_parameter_overrides'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        metric_parameter_overrides
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        end_date
+        fixed_fee_quantity_transitions
+        current_billing_period_start_date
+        current_billing_period_end_date
+        filter
+        usage_customer_ids
+        metric_parameter_overrides
+      ]
+    end
+
+    def initialize(id:, start_date:, end_date:, price:, billing_cycle_day:,
+                   can_defer_billing:, fixed_fee_quantity_transitions:,
+                   current_billing_period_start_date:,
+                   current_billing_period_end_date:, filter:,
+                   usage_customer_ids:, metric_parameter_overrides: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @start_date = start_date
+      @end_date = end_date
+      @price = price
+      @billing_cycle_day = billing_cycle_day
+      @can_defer_billing = can_defer_billing
+      @fixed_fee_quantity_transitions = fixed_fee_quantity_transitions
+      @current_billing_period_start_date = current_billing_period_start_date
+      @current_billing_period_end_date = current_billing_period_end_date
+      @filter = filter
+      @usage_customer_ids = usage_customer_ids
+      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.
+      id = hash.key?('id') ? hash['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
+      price = hash.key?('price') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Price), hash['price']
+      ) : nil
+      billing_cycle_day =
+        hash.key?('billing_cycle_day') ? hash['billing_cycle_day'] : nil
+      can_defer_billing =
+        hash.key?('can_defer_billing') ? hash['can_defer_billing'] : nil
+      # 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 << (FixedFeeQuantityTransition.from_hash(structure) if structure)
+        end
+      end
+
+      fixed_fee_quantity_transitions = nil unless hash.key?('fixed_fee_quantity_transitions')
+      current_billing_period_start_date = if hash.key?('current_billing_period_start_date')
+                                            (DateTimeHelper.from_rfc3339(hash['current_billing_period_start_date']) if hash['current_billing_period_start_date'])
+                                          end
+      current_billing_period_end_date = if hash.key?('current_billing_period_end_date')
+                                          (DateTimeHelper.from_rfc3339(hash['current_billing_period_end_date']) if hash['current_billing_period_end_date'])
+                                        end
+      filter = hash.key?('filter') ? hash['filter'] : nil
+      usage_customer_ids =
+        hash.key?('usage_customer_ids') ? hash['usage_customer_ids'] : nil
+      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.
+      PriceInterval.new(id: id,
+                        start_date: start_date,
+                        end_date: end_date,
+                        price: price,
+                        billing_cycle_day: billing_cycle_day,
+                        can_defer_billing: can_defer_billing,
+                        fixed_fee_quantity_transitions: fixed_fee_quantity_transitions,
+                        current_billing_period_start_date: current_billing_period_start_date,
+                        current_billing_period_end_date: current_billing_period_end_date,
+                        filter: filter,
+                        usage_customer_ids: usage_customer_ids,
+                        metric_parameter_overrides: metric_parameter_overrides,
+                        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
+
+    def to_custom_current_billing_period_start_date
+      DateTimeHelper.to_rfc3339(current_billing_period_start_date)
+    end
+
+    def to_custom_current_billing_period_end_date
+      DateTimeHelper.to_rfc3339(current_billing_period_end_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PriceInterval | 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.start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            UnionTypeLookUp.get(:Price)
+                           .validate(value.price) and
+            APIHelper.valid_type?(value.billing_cycle_day,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.can_defer_billing,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.fixed_fee_quantity_transitions,
+                                  ->(val) { FixedFeeQuantityTransition.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.current_billing_period_start_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.current_billing_period_end_date,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.filter,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.usage_customer_ids,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['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
+          UnionTypeLookUp.get(:Price)
+                         .validate(value['price']) and
+          APIHelper.valid_type?(value['billing_cycle_day'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['can_defer_billing'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['fixed_fee_quantity_transitions'],
+                                ->(val) { FixedFeeQuantityTransition.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['current_billing_period_start_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['current_billing_period_end_date'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['filter'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['usage_customer_ids'],
+                                ->(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}, start_date: #{@start_date}, end_date: #{@end_date}, price:"\
+      " #{@price}, billing_cycle_day: #{@billing_cycle_day}, can_defer_billing:"\
+      " #{@can_defer_billing}, fixed_fee_quantity_transitions: #{@fixed_fee_quantity_transitions},"\
+      " current_billing_period_start_date: #{@current_billing_period_start_date},"\
+      " current_billing_period_end_date: #{@current_billing_period_end_date}, filter: #{@filter},"\
+      " usage_customer_ids: #{@usage_customer_ids}, 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} id: #{@id.inspect}, start_date: #{@start_date.inspect}, end_date:"\
+      " #{@end_date.inspect}, price: #{@price.inspect}, billing_cycle_day:"\
+      " #{@billing_cycle_day.inspect}, can_defer_billing: #{@can_defer_billing.inspect},"\
+      " fixed_fee_quantity_transitions: #{@fixed_fee_quantity_transitions.inspect},"\
+      " current_billing_period_start_date: #{@current_billing_period_start_date.inspect},"\
+      " current_billing_period_end_date: #{@current_billing_period_end_date.inspect}, filter:"\
+      " #{@filter.inspect}, usage_customer_ids: #{@usage_customer_ids.inspect},"\
+      " metric_parameter_overrides: #{@metric_parameter_overrides.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/price_interval_fixed_fee_quantity_transition_params.rb

@@ -0,0 +1,112 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PriceIntervalFixedFeeQuantityTransitionParams Model.
+  class PriceIntervalFixedFeeQuantityTransitionParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The quantity of the fixed fee quantity transition.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # The date that the fixed fee quantity transition should take effect.
+    # @return [Object]
+    attr_accessor :effective_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['quantity'] = 'quantity'
+      @_hash['effective_date'] = 'effective_date'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(quantity:, effective_date:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @quantity = quantity
+      @effective_date = effective_date
+      @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.
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      effective_date = hash.key?('effective_date') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate), hash['effective_date']
+      ) : 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.
+      PriceIntervalFixedFeeQuantityTransitionParams.new(quantity: quantity,
+                                                        effective_date: effective_date,
+                                                        additional_properties: additional_properties)
+    end
+
+    def to_union_type_effective_date
+      UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate)
+                     .validate(effective_date)
+                     .serialize(effective_date)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PriceIntervalFixedFeeQuantityTransitionParams | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.quantity,
+                                ->(val) { val.instance_of? Integer }) and
+            UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate)
+                           .validate(value.effective_date)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['quantity'],
+                              ->(val) { val.instance_of? Integer }) and
+          UnionTypeLookUp.get(:PriceIntervalFixedFeeQuantityTransitionParamsEffectiveDate)
+                         .validate(value['effective_date'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} quantity: #{@quantity}, effective_date: #{@effective_date},"\
+      " 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} quantity: #{@quantity.inspect}, effective_date: #{@effective_date.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/price_type.rb

@@ -0,0 +1,48 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Price Type.
+  class PriceType
+    PRICE_TYPE = [
+      # TODO: Write general description for USAGE
+      USAGE = 'usage'.freeze,
+
+      # TODO: Write general description for FIXED_IN_ADVANCE
+      FIXED_IN_ADVANCE = 'fixed_in_advance'.freeze,
+
+      # TODO: Write general description for FIXED_IN_ARREARS
+      FIXED_IN_ARREARS = 'fixed_in_arrears'.freeze,
+
+      # TODO: Write general description for FIXED
+      FIXED = 'fixed'.freeze,
+
+      # TODO: Write general description for IN_ARREARS
+      IN_ARREARS = 'in_arrears'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = USAGE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'usage' then USAGE
+      when 'fixed_in_advance' then FIXED_IN_ADVANCE
+      when 'fixed_in_arrears' then FIXED_IN_ARREARS
+      when 'fixed' then FIXED
+      when 'in_arrears' then IN_ARREARS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/price_type6.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Price Type6.
+  class PriceType6
+    PRICE_TYPE6 = [
+      # TODO: Write general description for USAGE_PRICE
+      USAGE_PRICE = 'usage_price'.freeze,
+
+      # TODO: Write general description for FIXED_PRICE
+      FIXED_PRICE = 'fixed_price'.freeze,
+
+      # TODO: Write general description for COMPOSITE_PRICE
+      COMPOSITE_PRICE = 'composite_price'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = USAGE_PRICE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'usage_price' then USAGE_PRICE
+      when 'fixed_price' then FIXED_PRICE
+      when 'composite_price' then COMPOSITE_PRICE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/prices.rb

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