orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/trial_config.rb

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

data/lib/api_reference/models/trial_discount.rb

@@ -0,0 +1,161 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TrialDiscount Model.
+  class TrialDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # List of price_ids that this discount applies to. For plan/plan phase
+    # discounts, this can be a subset of prices.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_ids
+
+    # The filters that determine which prices to apply this discount to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # The filters that determine which prices to apply this discount to.
+    # @return [String]
+    attr_accessor :reason
+
+    # Only available if discount_type is `trial`
+    # @return [String]
+    attr_accessor :trial_amount_discount
+
+    # Only available if discount_type is `trial`
+    # @return [Float]
+    attr_accessor :trial_percentage_discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
+      @_hash['filters'] = 'filters'
+      @_hash['reason'] = 'reason'
+      @_hash['trial_amount_discount'] = 'trial_amount_discount'
+      @_hash['trial_percentage_discount'] = 'trial_percentage_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applies_to_price_ids
+        filters
+        reason
+        trial_amount_discount
+        trial_percentage_discount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        applies_to_price_ids
+        filters
+        reason
+        trial_amount_discount
+        trial_percentage_discount
+      ]
+    end
+
+    def initialize(applies_to_price_ids: SKIP, filters: SKIP, reason: SKIP,
+                   trial_amount_discount: SKIP, trial_percentage_discount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'trial'
+      @applies_to_price_ids = applies_to_price_ids unless applies_to_price_ids == SKIP
+      @filters = filters unless filters == SKIP
+      @reason = reason unless reason == SKIP
+      @trial_amount_discount = trial_amount_discount unless trial_amount_discount == SKIP
+      unless trial_percentage_discount == SKIP
+        @trial_percentage_discount =
+          trial_percentage_discount
+      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.
+      applies_to_price_ids =
+        hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      filters = nil
+      unless hash['filters'].nil?
+        filters = []
+        hash['filters'].each do |structure|
+          filters << (PriceFilter.from_hash(structure) if structure)
+        end
+      end
+
+      filters = SKIP unless hash.key?('filters')
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      trial_amount_discount =
+        hash.key?('trial_amount_discount') ? hash['trial_amount_discount'] : SKIP
+      trial_percentage_discount =
+        hash.key?('trial_percentage_discount') ? hash['trial_percentage_discount'] : 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.
+      TrialDiscount.new(applies_to_price_ids: applies_to_price_ids,
+                        filters: filters,
+                        reason: reason,
+                        trial_amount_discount: trial_amount_discount,
+                        trial_percentage_discount: trial_percentage_discount,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TrialDiscount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.discount_type,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['discount_type'],
+                            ->(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} discount_type: #{@discount_type}, applies_to_price_ids:"\
+      " #{@applies_to_price_ids}, filters: #{@filters}, reason: #{@reason}, trial_amount_discount:"\
+      " #{@trial_amount_discount}, trial_percentage_discount: #{@trial_percentage_discount},"\
+      " 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} discount_type: #{@discount_type.inspect}, applies_to_price_ids:"\
+      " #{@applies_to_price_ids.inspect}, filters: #{@filters.inspect}, reason:"\
+      " #{@reason.inspect}, trial_amount_discount: #{@trial_amount_discount.inspect},"\
+      " trial_percentage_discount: #{@trial_percentage_discount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/trial_end_date.rb

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

data/lib/api_reference/models/trigger_subscription_phase_params.rb

@@ -0,0 +1,84 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # TriggerSubscriptionPhaseParams Model.
+  class TriggerSubscriptionPhaseParams < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date on which the phase change should take effect. If not provided,
+    # defaults to today in the customer's timezone.
+    # @return [Date]
+    attr_accessor :effective_date
+
+    # 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['effective_date'] = 'effective_date'
+      @_hash['allow_invoice_credit_or_void'] = 'allow_invoice_credit_or_void'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        effective_date
+        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(effective_date: SKIP, allow_invoice_credit_or_void: true)
+      @effective_date = effective_date unless effective_date == 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.
+      effective_date =
+        hash.key?('effective_date') ? hash['effective_date'] : SKIP
+      allow_invoice_credit_or_void =
+        hash['allow_invoice_credit_or_void'] ||= true
+
+      # Create object from extracted values.
+      TriggerSubscriptionPhaseParams.new(effective_date: effective_date,
+                                         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} effective_date: #{@effective_date}, 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} effective_date: #{@effective_date.inspect}, allow_invoice_credit_or_void:"\
+      " #{@allow_invoice_credit_or_void.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/type.rb

@@ -0,0 +1,40 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Type.
+  class Type
+    TYPE = [
+      # TODO: Write general description for CREDIT_BALANCE_DEPLETED
+      CREDIT_BALANCE_DEPLETED = 'credit_balance_depleted'.freeze,
+
+      # TODO: Write general description for CREDIT_BALANCE_DROPPED
+      CREDIT_BALANCE_DROPPED = 'credit_balance_dropped'.freeze,
+
+      # TODO: Write general description for CREDIT_BALANCE_RECOVERED
+      CREDIT_BALANCE_RECOVERED = 'credit_balance_recovered'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREDIT_BALANCE_DEPLETED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit_balance_depleted' then CREDIT_BALANCE_DEPLETED
+      when 'credit_balance_dropped' then CREDIT_BALANCE_DROPPED
+      when 'credit_balance_recovered' then CREDIT_BALANCE_RECOVERED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/api_reference/models/type1.rb

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

data/lib/api_reference/models/type2.rb

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

data/lib/api_reference/models/type3.rb

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

data/lib/api_reference/models/type4.rb

@@ -0,0 +1,36 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # Type4.
+  class Type4
+    TYPE4 = [
+      # TODO: Write general description for INCREMENT
+      INCREMENT = 'increment'.freeze,
+
+      # TODO: Write general description for DECREMENT
+      DECREMENT = 'decrement'.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
+      else
+        default_value
+      end
+    end
+  end
+end