orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/amendment_ledger_entry.rb

@@ -0,0 +1,301 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # AmendmentLedgerEntry Model.
+  class AmendmentLedgerEntry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Hash[String, String]]
+    attr_accessor :metadata
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :id
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Integer]
+    attr_accessor :ledger_sequence_number
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [EntryStatus]
+    attr_accessor :entry_status
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [CustomerMinified]
+    attr_accessor :customer
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :starting_balance
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :ending_balance
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [Float]
+    attr_accessor :amount
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :currency
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_accessor :description
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [AffectedBlock]
+    attr_accessor :credit_block
+
+    # User specified key-value pairs for the resource. If not present, this
+    # defaults to an empty dictionary. Individual keys can be removed by setting
+    # the value to `null`, and the entire metadata mapping can be cleared by
+    # setting `metadata` to `null`.
+    # @return [String]
+    attr_reader :entry_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['id'] = 'id'
+      @_hash['ledger_sequence_number'] = 'ledger_sequence_number'
+      @_hash['entry_status'] = 'entry_status'
+      @_hash['customer'] = 'customer'
+      @_hash['starting_balance'] = 'starting_balance'
+      @_hash['ending_balance'] = 'ending_balance'
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['created_at'] = 'created_at'
+      @_hash['description'] = 'description'
+      @_hash['credit_block'] = 'credit_block'
+      @_hash['entry_type'] = 'entry_type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(metadata:, id:, ledger_sequence_number:, entry_status:,
+                   customer:, starting_balance:, ending_balance:, amount:,
+                   currency:, created_at:, description:, credit_block:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @id = id
+      @ledger_sequence_number = ledger_sequence_number
+      @entry_status = entry_status
+      @customer = customer
+      @starting_balance = starting_balance
+      @ending_balance = ending_balance
+      @amount = amount
+      @currency = currency
+      @created_at = created_at
+      @description = description
+      @credit_block = credit_block
+      @entry_type = 'amendment'
+      @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.
+      metadata = hash.key?('metadata') ? hash['metadata'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      ledger_sequence_number =
+        hash.key?('ledger_sequence_number') ? hash['ledger_sequence_number'] : nil
+      entry_status = hash.key?('entry_status') ? hash['entry_status'] : nil
+      customer = CustomerMinified.from_hash(hash['customer']) if hash['customer']
+      starting_balance =
+        hash.key?('starting_balance') ? hash['starting_balance'] : nil
+      ending_balance =
+        hash.key?('ending_balance') ? hash['ending_balance'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   end
+      description = hash.key?('description') ? hash['description'] : nil
+      credit_block = AffectedBlock.from_hash(hash['credit_block']) if hash['credit_block']
+
+      # 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.
+      AmendmentLedgerEntry.new(metadata: metadata,
+                               id: id,
+                               ledger_sequence_number: ledger_sequence_number,
+                               entry_status: entry_status,
+                               customer: customer,
+                               starting_balance: starting_balance,
+                               ending_balance: ending_balance,
+                               amount: amount,
+                               currency: currency,
+                               created_at: created_at,
+                               description: description,
+                               credit_block: credit_block,
+                               additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AmendmentLedgerEntry | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.metadata,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.id,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.ledger_sequence_number,
+                                  ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.entry_status,
+                                  ->(val) { EntryStatus.validate(val) }) and
+            APIHelper.valid_type?(value.customer,
+                                  ->(val) { CustomerMinified.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.starting_balance,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.ending_balance,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.created_at,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.description,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.credit_block,
+                                  ->(val) { AffectedBlock.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.entry_type,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['metadata'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['id'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['ledger_sequence_number'],
+                                ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['entry_status'],
+                                ->(val) { EntryStatus.validate(val) }) and
+          APIHelper.valid_type?(value['customer'],
+                                ->(val) { CustomerMinified.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['starting_balance'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['ending_balance'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['created_at'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['description'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['credit_block'],
+                                ->(val) { AffectedBlock.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['entry_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} metadata: #{@metadata}, id: #{@id}, ledger_sequence_number:"\
+      " #{@ledger_sequence_number}, entry_status: #{@entry_status}, customer: #{@customer},"\
+      " starting_balance: #{@starting_balance}, ending_balance: #{@ending_balance}, amount:"\
+      " #{@amount}, currency: #{@currency}, created_at: #{@created_at}, description:"\
+      " #{@description}, credit_block: #{@credit_block}, entry_type: #{@entry_type},"\
+      " 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} metadata: #{@metadata.inspect}, id: #{@id.inspect}, ledger_sequence_number:"\
+      " #{@ledger_sequence_number.inspect}, entry_status: #{@entry_status.inspect}, customer:"\
+      " #{@customer.inspect}, starting_balance: #{@starting_balance.inspect}, ending_balance:"\
+      " #{@ending_balance.inspect}, amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " created_at: #{@created_at.inspect}, description: #{@description.inspect}, credit_block:"\
+      " #{@credit_block.inspect}, entry_type: #{@entry_type.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/amount_discount.rb

@@ -0,0 +1,150 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # AmountDiscount Model.
+  class AmountDiscount < 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 `amount`.
+    # @return [String]
+    attr_accessor :amount_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['amount_discount'] = 'amount_discount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applies_to_price_ids
+        filters
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        applies_to_price_ids
+        filters
+        reason
+      ]
+    end
+
+    def initialize(amount_discount:, applies_to_price_ids: SKIP, filters: SKIP,
+                   reason: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'amount'
+      @applies_to_price_ids = applies_to_price_ids unless applies_to_price_ids == SKIP
+      @filters = filters unless filters == SKIP
+      @reason = reason unless reason == SKIP
+      @amount_discount = amount_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.
+      amount_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : nil
+      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
+
+      # 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.
+      AmountDiscount.new(amount_discount: amount_discount,
+                         applies_to_price_ids: applies_to_price_ids,
+                         filters: filters,
+                         reason: reason,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AmountDiscount | 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 }) and
+            APIHelper.valid_type?(value.amount_discount,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['discount_type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount_discount'],
+                                ->(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}, amount_discount:"\
+      " #{@amount_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}, amount_discount: #{@amount_discount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/amount_discount_creation_params.rb

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