orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/plan_minified_with_version.rb

@@ -0,0 +1,141 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanMinifiedWithVersion Model.
+  class PlanMinifiedWithVersion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # An optional user-defined ID for this plan resource, used throughout the
+    # system as an alias for this Plan. Use this field to identify a plan by an
+    # existing identifier in your system.
+    # @return [String]
+    attr_accessor :external_plan_id
+
+    # An optional user-defined ID for this plan resource, used throughout the
+    # system as an alias for this Plan. Use this field to identify a plan by an
+    # existing identifier in your system.
+    # @return [String]
+    attr_accessor :name
+
+    # An optional user-defined ID for this plan resource, used throughout the
+    # system as an alias for this Plan. Use this field to identify a plan by an
+    # existing identifier in your system.
+    # @return [String]
+    attr_accessor :plan_version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['external_plan_id'] = 'external_plan_id'
+      @_hash['name'] = 'name'
+      @_hash['plan_version'] = 'plan_version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        external_plan_id
+        name
+      ]
+    end
+
+    def initialize(id:, external_plan_id:, name:, plan_version:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @external_plan_id = external_plan_id
+      @name = name
+      @plan_version = plan_version
+      @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
+      external_plan_id =
+        hash.key?('external_plan_id') ? hash['external_plan_id'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      plan_version = hash.key?('plan_version') ? hash['plan_version'] : 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.
+      PlanMinifiedWithVersion.new(id: id,
+                                  external_plan_id: external_plan_id,
+                                  name: name,
+                                  plan_version: plan_version,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PlanMinifiedWithVersion | 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.external_plan_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.plan_version,
+                                  ->(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['external_plan_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['plan_version'],
+                                ->(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}, external_plan_id: #{@external_plan_id}, name: #{@name},"\
+      " plan_version: #{@plan_version}, 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}, external_plan_id: #{@external_plan_id.inspect}, name:"\
+      " #{@name.inspect}, plan_version: #{@plan_version.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/plan_phase.rb

@@ -0,0 +1,244 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanPhase Model.
+  class PlanPhase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # How many terms of length `duration_unit` this phase is active for. If
+    # null, this phase is evergreen and active indefinitely
+    # @return [Integer]
+    attr_accessor :duration
+
+    # How many terms of length `duration_unit` this phase is active for. If
+    # null, this phase is evergreen and active indefinitely
+    # @return [DurationUnit3]
+    attr_accessor :duration_unit
+
+    # How many terms of length `duration_unit` this phase is active for. If
+    # null, this phase is evergreen and active indefinitely
+    # @return [String]
+    attr_accessor :name
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [Integer]
+    attr_accessor :order
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [Minimum]
+    attr_accessor :minimum
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [Maximum]
+    attr_accessor :maximum
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [String]
+    attr_accessor :maximum_amount
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [String]
+    attr_accessor :minimum_amount
+
+    # Determines the ordering of the phase in a plan's lifecycle. 1 = first
+    # phase.
+    # @return [Object]
+    attr_accessor :discount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['description'] = 'description'
+      @_hash['duration'] = 'duration'
+      @_hash['duration_unit'] = 'duration_unit'
+      @_hash['name'] = 'name'
+      @_hash['order'] = 'order'
+      @_hash['minimum'] = 'minimum'
+      @_hash['maximum'] = 'maximum'
+      @_hash['maximum_amount'] = 'maximum_amount'
+      @_hash['minimum_amount'] = 'minimum_amount'
+      @_hash['discount'] = 'discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+        duration
+        duration_unit
+        minimum
+        maximum
+        maximum_amount
+        minimum_amount
+        discount
+      ]
+    end
+
+    def initialize(id:, description:, duration:, duration_unit:, name:, order:,
+                   minimum:, maximum:, maximum_amount:, minimum_amount:,
+                   discount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @description = description
+      @duration = duration
+      @duration_unit = duration_unit
+      @name = name
+      @order = order
+      @minimum = minimum
+      @maximum = maximum
+      @maximum_amount = maximum_amount
+      @minimum_amount = minimum_amount
+      @discount = discount
+      @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
+      description = hash.key?('description') ? hash['description'] : nil
+      duration = hash.key?('duration') ? hash['duration'] : nil
+      duration_unit = hash.key?('duration_unit') ? hash['duration_unit'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      order = hash.key?('order') ? hash['order'] : nil
+      minimum = Minimum.from_hash(hash['minimum']) if hash['minimum']
+      maximum = Maximum.from_hash(hash['maximum']) if hash['maximum']
+      maximum_amount =
+        hash.key?('maximum_amount') ? hash['maximum_amount'] : nil
+      minimum_amount =
+        hash.key?('minimum_amount') ? hash['minimum_amount'] : nil
+      discount = hash.key?('discount') ? hash['discount'] : 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.
+      PlanPhase.new(id: id,
+                    description: description,
+                    duration: duration,
+                    duration_unit: duration_unit,
+                    name: name,
+                    order: order,
+                    minimum: minimum,
+                    maximum: maximum,
+                    maximum_amount: maximum_amount,
+                    minimum_amount: minimum_amount,
+                    discount: discount,
+                    additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PlanPhase | 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.description,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.duration,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.duration_unit,
+                                  ->(val) { DurationUnit3.validate(val) }) and
+            APIHelper.valid_type?(value.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.order,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.minimum,
+                                  ->(val) { Minimum.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.maximum,
+                                  ->(val) { Maximum.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.maximum_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.minimum_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.discount,
+                                  ->(val) { val.instance_of? Object })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['duration'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['duration_unit'],
+                                ->(val) { DurationUnit3.validate(val) }) and
+          APIHelper.valid_type?(value['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['order'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['minimum'],
+                                ->(val) { Minimum.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['maximum'],
+                                ->(val) { Maximum.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['maximum_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['minimum_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['discount'],
+                                ->(val) { val.instance_of? Object })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, description: #{@description}, duration: #{@duration},"\
+      " duration_unit: #{@duration_unit}, name: #{@name}, order: #{@order}, minimum: #{@minimum},"\
+      " maximum: #{@maximum}, maximum_amount: #{@maximum_amount}, minimum_amount:"\
+      " #{@minimum_amount}, discount: #{@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} id: #{@id.inspect}, description: #{@description.inspect}, duration:"\
+      " #{@duration.inspect}, duration_unit: #{@duration_unit.inspect}, name: #{@name.inspect},"\
+      " order: #{@order.inspect}, minimum: #{@minimum.inspect}, maximum: #{@maximum.inspect},"\
+      " maximum_amount: #{@maximum_amount.inspect}, minimum_amount: #{@minimum_amount.inspect},"\
+      " discount: #{@discount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/plan_phase_amount_discount_adjustment.rb

@@ -0,0 +1,221 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # PlanPhaseAmountDiscountAdjustment Model.
+  class PlanPhaseAmountDiscountAdjustment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # True for adjustments that apply to an entire invoice, false for
+    # adjustments that apply to only one price.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_invoice_level
+
+    # The filters that determine which prices to apply this adjustment to.
+    # @return [Array[PriceFilter]]
+    attr_accessor :filters
+
+    # The price IDs that this adjustment applies to.
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_ids
+
+    # The reason for the adjustment.
+    # @return [String]
+    attr_accessor :reason
+
+    # The adjustment id this adjustment replaces. This adjustment will take the
+    # place of the replaced adjustment in plan version migrations.
+    # @return [String]
+    attr_accessor :replaces_adjustment_id
+
+    # The adjustment id this adjustment replaces. This adjustment will take the
+    # place of the replaced adjustment in plan version migrations.
+    # @return [String]
+    attr_reader :adjustment_type
+
+    # The amount by which to discount the prices this adjustment applies to in a
+    # given billing period.
+    # @return [String]
+    attr_accessor :amount_discount
+
+    # The plan phase in which this adjustment is active.
+    # @return [Integer]
+    attr_accessor :plan_phase_order
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['is_invoice_level'] = 'is_invoice_level'
+      @_hash['filters'] = 'filters'
+      @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
+      @_hash['reason'] = 'reason'
+      @_hash['replaces_adjustment_id'] = 'replaces_adjustment_id'
+      @_hash['adjustment_type'] = 'adjustment_type'
+      @_hash['amount_discount'] = 'amount_discount'
+      @_hash['plan_phase_order'] = 'plan_phase_order'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason
+        replaces_adjustment_id
+        plan_phase_order
+      ]
+    end
+
+    def initialize(id:, is_invoice_level:, filters:, applies_to_price_ids:,
+                   reason:, replaces_adjustment_id:, amount_discount:,
+                   plan_phase_order:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @is_invoice_level = is_invoice_level
+      @filters = filters
+      @applies_to_price_ids = applies_to_price_ids
+      @reason = reason
+      @replaces_adjustment_id = replaces_adjustment_id
+      @adjustment_type = 'amount_discount'
+      @amount_discount = amount_discount
+      @plan_phase_order = plan_phase_order
+      @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
+      is_invoice_level =
+        hash.key?('is_invoice_level') ? hash['is_invoice_level'] : nil
+      # 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 = nil unless hash.key?('filters')
+      applies_to_price_ids =
+        hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+      replaces_adjustment_id =
+        hash.key?('replaces_adjustment_id') ? hash['replaces_adjustment_id'] : nil
+      amount_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : nil
+      plan_phase_order =
+        hash.key?('plan_phase_order') ? hash['plan_phase_order'] : 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.
+      PlanPhaseAmountDiscountAdjustment.new(id: id,
+                                            is_invoice_level: is_invoice_level,
+                                            filters: filters,
+                                            applies_to_price_ids: applies_to_price_ids,
+                                            reason: reason,
+                                            replaces_adjustment_id: replaces_adjustment_id,
+                                            amount_discount: amount_discount,
+                                            plan_phase_order: plan_phase_order,
+                                            additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PlanPhaseAmountDiscountAdjustment | 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.is_invoice_level,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.filters,
+                                  ->(val) { PriceFilter.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.applies_to_price_ids,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.reason,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.replaces_adjustment_id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.adjustment_type,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount_discount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.plan_phase_order,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['is_invoice_level'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['filters'],
+                                ->(val) { PriceFilter.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['applies_to_price_ids'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['reason'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['replaces_adjustment_id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['adjustment_type'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_discount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['plan_phase_order'],
+                                ->(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} id: #{@id}, is_invoice_level: #{@is_invoice_level}, filters: #{@filters},"\
+      " applies_to_price_ids: #{@applies_to_price_ids}, reason: #{@reason},"\
+      " replaces_adjustment_id: #{@replaces_adjustment_id}, adjustment_type: #{@adjustment_type},"\
+      " amount_discount: #{@amount_discount}, plan_phase_order: #{@plan_phase_order},"\
+      " 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}, is_invoice_level: #{@is_invoice_level.inspect},"\
+      " filters: #{@filters.inspect}, applies_to_price_ids: #{@applies_to_price_ids.inspect},"\
+      " reason: #{@reason.inspect}, replaces_adjustment_id: #{@replaces_adjustment_id.inspect},"\
+      " adjustment_type: #{@adjustment_type.inspect}, amount_discount:"\
+      " #{@amount_discount.inspect}, plan_phase_order: #{@plan_phase_order.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end