orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/new_plan_version.rb

@@ -0,0 +1,197 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewPlanVersion Model.
+  class NewPlanVersion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Additional prices to be added to the plan.
+    # @return [Array[AddPlanPriceParams]]
+    attr_accessor :add_prices
+
+    # Prices to be removed from the plan.
+    # @return [Array[RemovePlanPriceParams]]
+    attr_accessor :remove_prices
+
+    # Prices to be replaced with additional prices on the plan.
+    # @return [Array[ReplacePlanPriceParams]]
+    attr_accessor :replace_prices
+
+    # Additional adjustments to be added to the plan.
+    # @return [Array[AddPlanAdjustmentParams]]
+    attr_accessor :add_adjustments
+
+    # Adjustments to be removed from the plan.
+    # @return [Array[RemovePlanAdjustmentParams]]
+    attr_accessor :remove_adjustments
+
+    # Adjustments to be replaced with additional adjustments on the plan.
+    # @return [Array[ReplacePlanAdjustmentParams]]
+    attr_accessor :replace_adjustments
+
+    # Set this new plan version as the default
+    # @return [TrueClass | FalseClass]
+    attr_accessor :set_as_default
+
+    # New version number.
+    # @return [Integer]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['add_prices'] = 'add_prices'
+      @_hash['remove_prices'] = 'remove_prices'
+      @_hash['replace_prices'] = 'replace_prices'
+      @_hash['add_adjustments'] = 'add_adjustments'
+      @_hash['remove_adjustments'] = 'remove_adjustments'
+      @_hash['replace_adjustments'] = 'replace_adjustments'
+      @_hash['set_as_default'] = 'set_as_default'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        add_prices
+        remove_prices
+        replace_prices
+        add_adjustments
+        remove_adjustments
+        replace_adjustments
+        set_as_default
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        add_prices
+        remove_prices
+        replace_prices
+        add_adjustments
+        remove_adjustments
+        replace_adjustments
+        set_as_default
+      ]
+    end
+
+    def initialize(version:, add_prices: SKIP, remove_prices: SKIP,
+                   replace_prices: SKIP, add_adjustments: SKIP,
+                   remove_adjustments: SKIP, replace_adjustments: SKIP,
+                   set_as_default: SKIP)
+      @add_prices = add_prices unless add_prices == SKIP
+      @remove_prices = remove_prices unless remove_prices == SKIP
+      @replace_prices = replace_prices unless replace_prices == SKIP
+      @add_adjustments = add_adjustments unless add_adjustments == SKIP
+      @remove_adjustments = remove_adjustments unless remove_adjustments == SKIP
+      @replace_adjustments = replace_adjustments unless replace_adjustments == SKIP
+      @set_as_default = set_as_default unless set_as_default == SKIP
+      @version = version
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      version = hash.key?('version') ? hash['version'] : nil
+      # Parameter is an array, so we need to iterate through it
+      add_prices = nil
+      unless hash['add_prices'].nil?
+        add_prices = []
+        hash['add_prices'].each do |structure|
+          add_prices << (AddPlanPriceParams.from_hash(structure) if structure)
+        end
+      end
+
+      add_prices = SKIP unless hash.key?('add_prices')
+      # Parameter is an array, so we need to iterate through it
+      remove_prices = nil
+      unless hash['remove_prices'].nil?
+        remove_prices = []
+        hash['remove_prices'].each do |structure|
+          remove_prices << (RemovePlanPriceParams.from_hash(structure) if structure)
+        end
+      end
+
+      remove_prices = SKIP unless hash.key?('remove_prices')
+      # Parameter is an array, so we need to iterate through it
+      replace_prices = nil
+      unless hash['replace_prices'].nil?
+        replace_prices = []
+        hash['replace_prices'].each do |structure|
+          replace_prices << (ReplacePlanPriceParams.from_hash(structure) if structure)
+        end
+      end
+
+      replace_prices = SKIP unless hash.key?('replace_prices')
+      # Parameter is an array, so we need to iterate through it
+      add_adjustments = nil
+      unless hash['add_adjustments'].nil?
+        add_adjustments = []
+        hash['add_adjustments'].each do |structure|
+          add_adjustments << (AddPlanAdjustmentParams.from_hash(structure) if structure)
+        end
+      end
+
+      add_adjustments = SKIP unless hash.key?('add_adjustments')
+      # Parameter is an array, so we need to iterate through it
+      remove_adjustments = nil
+      unless hash['remove_adjustments'].nil?
+        remove_adjustments = []
+        hash['remove_adjustments'].each do |structure|
+          remove_adjustments << (RemovePlanAdjustmentParams.from_hash(structure) if structure)
+        end
+      end
+
+      remove_adjustments = SKIP unless hash.key?('remove_adjustments')
+      # Parameter is an array, so we need to iterate through it
+      replace_adjustments = nil
+      unless hash['replace_adjustments'].nil?
+        replace_adjustments = []
+        hash['replace_adjustments'].each do |structure|
+          replace_adjustments << (ReplacePlanAdjustmentParams.from_hash(structure) if structure)
+        end
+      end
+
+      replace_adjustments = SKIP unless hash.key?('replace_adjustments')
+      set_as_default =
+        hash.key?('set_as_default') ? hash['set_as_default'] : SKIP
+
+      # Create object from extracted values.
+      NewPlanVersion.new(version: version,
+                         add_prices: add_prices,
+                         remove_prices: remove_prices,
+                         replace_prices: replace_prices,
+                         add_adjustments: add_adjustments,
+                         remove_adjustments: remove_adjustments,
+                         replace_adjustments: replace_adjustments,
+                         set_as_default: set_as_default)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add_prices: #{@add_prices}, remove_prices: #{@remove_prices},"\
+      " replace_prices: #{@replace_prices}, add_adjustments: #{@add_adjustments},"\
+      " remove_adjustments: #{@remove_adjustments}, replace_adjustments: #{@replace_adjustments},"\
+      " set_as_default: #{@set_as_default}, version: #{@version}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} add_prices: #{@add_prices.inspect}, remove_prices:"\
+      " #{@remove_prices.inspect}, replace_prices: #{@replace_prices.inspect}, add_adjustments:"\
+      " #{@add_adjustments.inspect}, remove_adjustments: #{@remove_adjustments.inspect},"\
+      " replace_adjustments: #{@replace_adjustments.inspect}, set_as_default:"\
+      " #{@set_as_default.inspect}, version: #{@version.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_portal_session.rb

@@ -0,0 +1,78 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewPortalSession Model.
+  class NewPortalSession < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Duration in minutes until the portal session expires. Defaults to 60.
+    # Maximum 180.
+    # @return [Integer]
+    attr_accessor :expires_in_minutes
+
+    # When true (default), creating this session soft-deletes any other active
+    # portal sessions for the customer. Set to false to allow concurrent
+    # sessions — useful when minting portal links for multiple authenticated
+    # end-users at once. The customer's permanent portal link (if any) is never
+    # invalidated by this.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :invalidate_existing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['expires_in_minutes'] = 'expires_in_minutes'
+      @_hash['invalidate_existing'] = 'invalidate_existing'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        expires_in_minutes
+        invalidate_existing
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(expires_in_minutes: 60, invalidate_existing: true)
+      @expires_in_minutes = expires_in_minutes unless expires_in_minutes == SKIP
+      @invalidate_existing = invalidate_existing unless invalidate_existing == 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.
+      expires_in_minutes = hash['expires_in_minutes'] ||= 60
+      invalidate_existing = hash['invalidate_existing'] ||= true
+
+      # Create object from extracted values.
+      NewPortalSession.new(expires_in_minutes: expires_in_minutes,
+                           invalidate_existing: invalidate_existing)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} expires_in_minutes: #{@expires_in_minutes}, invalidate_existing:"\
+      " #{@invalidate_existing}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} expires_in_minutes: #{@expires_in_minutes.inspect}, invalidate_existing:"\
+      " #{@invalidate_existing.inspect}>"
+    end
+  end
+end

data/lib/api_reference/models/new_reporting_configuration.rb

@@ -0,0 +1,73 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewReportingConfiguration Model.
+  class NewReportingConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exempt
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['exempt'] = 'exempt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(exempt:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @exempt = exempt
+      @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.
+      exempt = hash.key?('exempt') ? hash['exempt'] : 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.
+      NewReportingConfiguration.new(exempt: exempt,
+                                    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} exempt: #{@exempt}, 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} exempt: #{@exempt.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_sphere_configuration.rb

@@ -0,0 +1,100 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewSphereConfiguration Model.
+  class NewSphereConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :automatic_tax_enabled
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [String]
+    attr_reader :tax_provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['automatic_tax_enabled'] = 'automatic_tax_enabled'
+      @_hash['tax_provider'] = 'tax_provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        automatic_tax_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        automatic_tax_enabled
+      ]
+    end
+
+    def initialize(tax_exempt:, automatic_tax_enabled: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_exempt = tax_exempt
+      @automatic_tax_enabled = automatic_tax_enabled unless automatic_tax_enabled == SKIP
+      @tax_provider = 'sphere'
+      @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.
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : nil
+      automatic_tax_enabled =
+        hash.key?('automatic_tax_enabled') ? hash['automatic_tax_enabled'] : 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.
+      NewSphereConfiguration.new(tax_exempt: tax_exempt,
+                                 automatic_tax_enabled: automatic_tax_enabled,
+                                 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} tax_exempt: #{@tax_exempt}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled}, tax_provider: #{@tax_provider}, 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} tax_exempt: #{@tax_exempt.inspect}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled.inspect}, tax_provider: #{@tax_provider.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/new_stripe_tax_configuration.rb

@@ -0,0 +1,100 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # NewStripeTaxConfiguration Model.
+  class NewStripeTaxConfiguration < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :tax_exempt
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :automatic_tax_enabled
+
+    # Whether to automatically calculate tax for this customer. When null,
+    # inherits from account-level setting. When true or false, overrides the
+    # account setting.
+    # @return [String]
+    attr_reader :tax_provider
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_exempt'] = 'tax_exempt'
+      @_hash['automatic_tax_enabled'] = 'automatic_tax_enabled'
+      @_hash['tax_provider'] = 'tax_provider'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        automatic_tax_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        automatic_tax_enabled
+      ]
+    end
+
+    def initialize(tax_exempt:, automatic_tax_enabled: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_exempt = tax_exempt
+      @automatic_tax_enabled = automatic_tax_enabled unless automatic_tax_enabled == SKIP
+      @tax_provider = 'stripe'
+      @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.
+      tax_exempt = hash.key?('tax_exempt') ? hash['tax_exempt'] : nil
+      automatic_tax_enabled =
+        hash.key?('automatic_tax_enabled') ? hash['automatic_tax_enabled'] : 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.
+      NewStripeTaxConfiguration.new(tax_exempt: tax_exempt,
+                                    automatic_tax_enabled: automatic_tax_enabled,
+                                    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} tax_exempt: #{@tax_exempt}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled}, tax_provider: #{@tax_provider}, 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} tax_exempt: #{@tax_exempt.inspect}, automatic_tax_enabled:"\
+      " #{@automatic_tax_enabled.inspect}, tax_provider: #{@tax_provider.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end