orb-apiamtic-sdk 0.0.1

data/lib/api_reference/models/credit_note_discount.rb

@@ -0,0 +1,152 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditNoteDiscount Model.
+  class CreditNoteDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :discount_type
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount_applied
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [Array[CreditNoteDiscountAppliesToPrice]]
+    attr_accessor :applies_to_prices
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['percentage_discount'] = 'percentage_discount'
+      @_hash['amount_applied'] = 'amount_applied'
+      @_hash['reason'] = 'reason'
+      @_hash['applies_to_prices'] = 'applies_to_prices'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+        applies_to_prices
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        reason
+        applies_to_prices
+      ]
+    end
+
+    def initialize(percentage_discount:, amount_applied:, reason: SKIP,
+                   applies_to_prices: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @discount_type = 'percentage'
+      @percentage_discount = percentage_discount
+      @amount_applied = amount_applied
+      @reason = reason unless reason == SKIP
+      @applies_to_prices = applies_to_prices unless applies_to_prices == SKIP
+      @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.
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : nil
+      amount_applied =
+        hash.key?('amount_applied') ? hash['amount_applied'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      applies_to_prices = nil
+      unless hash['applies_to_prices'].nil?
+        applies_to_prices = []
+        hash['applies_to_prices'].each do |structure|
+          applies_to_prices << (CreditNoteDiscountAppliesToPrice.from_hash(structure) if structure)
+        end
+      end
+
+      applies_to_prices = SKIP unless hash.key?('applies_to_prices')
+
+      # 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.
+      CreditNoteDiscount.new(percentage_discount: percentage_discount,
+                             amount_applied: amount_applied,
+                             reason: reason,
+                             applies_to_prices: applies_to_prices,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteDiscount | 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.percentage_discount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.amount_applied,
+                                  ->(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['percentage_discount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['amount_applied'],
+                                ->(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}, percentage_discount:"\
+      " #{@percentage_discount}, amount_applied: #{@amount_applied}, reason: #{@reason},"\
+      " applies_to_prices: #{@applies_to_prices}, 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}, percentage_discount:"\
+      " #{@percentage_discount.inspect}, amount_applied: #{@amount_applied.inspect}, reason:"\
+      " #{@reason.inspect}, applies_to_prices: #{@applies_to_prices.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_note_discount_applies_to_price.rb

@@ -0,0 +1,104 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditNoteDiscountAppliesToPrice Model.
+  class CreditNoteDiscountAppliesToPrice < 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 :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, name:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @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
+      name = hash.key?('name') ? hash['name'] : 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.
+      CreditNoteDiscountAppliesToPrice.new(id: id,
+                                           name: name,
+                                           additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteDiscountAppliesToPrice | 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.name,
+                                  ->(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['name'],
+                                ->(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}, name: #{@name}, 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}, name: #{@name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_note_line_item.rb

@@ -0,0 +1,244 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module ApiReference
+  # CreditNoteLineItem Model.
+  class CreditNoteLineItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Orb id of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The name of the corresponding invoice line item.
+    # @return [String]
+    attr_accessor :name
+
+    # The amount of the line item, excluding any line item minimums and
+    # discounts.
+    # @return [String]
+    attr_accessor :subtotal
+
+    # The amount of the line item, including any line item minimums and
+    # discounts.
+    # @return [String]
+    attr_accessor :amount
+
+    # An optional quantity credited.
+    # @return [Float]
+    attr_accessor :quantity
+
+    # Any line item discounts from the invoice's line item.
+    # @return [Array[CreditNoteLineItemDiscount]]
+    attr_accessor :discounts
+
+    # Any tax amounts applied onto the line item.
+    # @return [Array[TaxAmount]]
+    attr_accessor :tax_amounts
+
+    # The id of the item associated with this line item.
+    # @return [String]
+    attr_accessor :item_id
+
+    # The start time of the service period for this credit note line item.
+    # @return [DateTime]
+    attr_accessor :start_time_inclusive
+
+    # The end time of the service period for this credit note line item.
+    # @return [DateTime]
+    attr_accessor :end_time_exclusive
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['name'] = 'name'
+      @_hash['subtotal'] = 'subtotal'
+      @_hash['amount'] = 'amount'
+      @_hash['quantity'] = 'quantity'
+      @_hash['discounts'] = 'discounts'
+      @_hash['tax_amounts'] = 'tax_amounts'
+      @_hash['item_id'] = 'item_id'
+      @_hash['start_time_inclusive'] = 'start_time_inclusive'
+      @_hash['end_time_exclusive'] = 'end_time_exclusive'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        discounts
+        start_time_inclusive
+        end_time_exclusive
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        quantity
+        start_time_inclusive
+        end_time_exclusive
+      ]
+    end
+
+    def initialize(id:, name:, subtotal:, amount:, quantity:, tax_amounts:,
+                   item_id:, discounts: SKIP, start_time_inclusive: SKIP,
+                   end_time_exclusive: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @name = name
+      @subtotal = subtotal
+      @amount = amount
+      @quantity = quantity
+      @discounts = discounts unless discounts == SKIP
+      @tax_amounts = tax_amounts
+      @item_id = item_id
+      @start_time_inclusive = start_time_inclusive unless start_time_inclusive == SKIP
+      @end_time_exclusive = end_time_exclusive unless end_time_exclusive == SKIP
+      @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
+      name = hash.key?('name') ? hash['name'] : nil
+      subtotal = hash.key?('subtotal') ? hash['subtotal'] : nil
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      quantity = hash.key?('quantity') ? hash['quantity'] : nil
+      # Parameter is an array, so we need to iterate through it
+      tax_amounts = nil
+      unless hash['tax_amounts'].nil?
+        tax_amounts = []
+        hash['tax_amounts'].each do |structure|
+          tax_amounts << (TaxAmount.from_hash(structure) if structure)
+        end
+      end
+
+      tax_amounts = nil unless hash.key?('tax_amounts')
+      item_id = hash.key?('item_id') ? hash['item_id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      discounts = nil
+      unless hash['discounts'].nil?
+        discounts = []
+        hash['discounts'].each do |structure|
+          discounts << (CreditNoteLineItemDiscount.from_hash(structure) if structure)
+        end
+      end
+
+      discounts = SKIP unless hash.key?('discounts')
+      start_time_inclusive = if hash.key?('start_time_inclusive')
+                               (DateTimeHelper.from_rfc3339(hash['start_time_inclusive']) if hash['start_time_inclusive'])
+                             else
+                               SKIP
+                             end
+      end_time_exclusive = if hash.key?('end_time_exclusive')
+                             (DateTimeHelper.from_rfc3339(hash['end_time_exclusive']) if hash['end_time_exclusive'])
+                           else
+                             SKIP
+                           end
+
+      # 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.
+      CreditNoteLineItem.new(id: id,
+                             name: name,
+                             subtotal: subtotal,
+                             amount: amount,
+                             quantity: quantity,
+                             tax_amounts: tax_amounts,
+                             item_id: item_id,
+                             discounts: discounts,
+                             start_time_inclusive: start_time_inclusive,
+                             end_time_exclusive: end_time_exclusive,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_start_time_inclusive
+      DateTimeHelper.to_rfc3339(start_time_inclusive)
+    end
+
+    def to_custom_end_time_exclusive
+      DateTimeHelper.to_rfc3339(end_time_exclusive)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteLineItem | 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.name,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.subtotal,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.quantity,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.tax_amounts,
+                                  ->(val) { TaxAmount.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            APIHelper.valid_type?(value.item_id,
+                                  ->(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['name'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['subtotal'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['quantity'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['tax_amounts'],
+                                ->(val) { TaxAmount.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          APIHelper.valid_type?(value['item_id'],
+                                ->(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}, name: #{@name}, subtotal: #{@subtotal}, amount: #{@amount},"\
+      " quantity: #{@quantity}, discounts: #{@discounts}, tax_amounts: #{@tax_amounts}, item_id:"\
+      " #{@item_id}, start_time_inclusive: #{@start_time_inclusive}, end_time_exclusive:"\
+      " #{@end_time_exclusive}, 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}, name: #{@name.inspect}, subtotal: #{@subtotal.inspect},"\
+      " amount: #{@amount.inspect}, quantity: #{@quantity.inspect}, discounts:"\
+      " #{@discounts.inspect}, tax_amounts: #{@tax_amounts.inspect}, item_id: #{@item_id.inspect},"\
+      " start_time_inclusive: #{@start_time_inclusive.inspect}, end_time_exclusive:"\
+      " #{@end_time_exclusive.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/api_reference/models/credit_note_line_item_discount.rb

@@ -0,0 +1,173 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # CreditNoteLineItemDiscount Model.
+  class CreditNoteLineItemDiscount < 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 [DiscountType1]
+    attr_accessor :discount_type
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :percentage_discount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount_discount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount_applied
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :applies_to_price_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['percentage_discount'] = 'percentage_discount'
+      @_hash['amount_discount'] = 'amount_discount'
+      @_hash['amount_applied'] = 'amount_applied'
+      @_hash['reason'] = 'reason'
+      @_hash['applies_to_price_ids'] = 'applies_to_price_ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount_discount
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        amount_discount
+        reason
+      ]
+    end
+
+    def initialize(id:, discount_type:, percentage_discount:, amount_applied:,
+                   applies_to_price_ids:, amount_discount: SKIP, reason: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @discount_type = discount_type
+      @percentage_discount = percentage_discount
+      @amount_discount = amount_discount unless amount_discount == SKIP
+      @amount_applied = amount_applied
+      @reason = reason unless reason == SKIP
+      @applies_to_price_ids = applies_to_price_ids
+      @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
+      discount_type = hash.key?('discount_type') ? hash['discount_type'] : nil
+      percentage_discount =
+        hash.key?('percentage_discount') ? hash['percentage_discount'] : nil
+      amount_applied =
+        hash.key?('amount_applied') ? hash['amount_applied'] : nil
+      applies_to_price_ids =
+        hash.key?('applies_to_price_ids') ? hash['applies_to_price_ids'] : nil
+      amount_discount =
+        hash.key?('amount_discount') ? hash['amount_discount'] : SKIP
+      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.
+      CreditNoteLineItemDiscount.new(id: id,
+                                     discount_type: discount_type,
+                                     percentage_discount: percentage_discount,
+                                     amount_applied: amount_applied,
+                                     applies_to_price_ids: applies_to_price_ids,
+                                     amount_discount: amount_discount,
+                                     reason: reason,
+                                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CreditNoteLineItemDiscount | 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.discount_type,
+                                  ->(val) { DiscountType1.validate(val) }) and
+            APIHelper.valid_type?(value.percentage_discount,
+                                  ->(val) { val.instance_of? Float }) and
+            APIHelper.valid_type?(value.amount_applied,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.applies_to_price_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['discount_type'],
+                                ->(val) { DiscountType1.validate(val) }) and
+          APIHelper.valid_type?(value['percentage_discount'],
+                                ->(val) { val.instance_of? Float }) and
+          APIHelper.valid_type?(value['amount_applied'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['applies_to_price_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}, discount_type: #{@discount_type}, percentage_discount:"\
+      " #{@percentage_discount}, amount_discount: #{@amount_discount}, amount_applied:"\
+      " #{@amount_applied}, reason: #{@reason}, applies_to_price_ids: #{@applies_to_price_ids},"\
+      " 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}, discount_type: #{@discount_type.inspect},"\
+      " percentage_discount: #{@percentage_discount.inspect}, amount_discount:"\
+      " #{@amount_discount.inspect}, amount_applied: #{@amount_applied.inspect}, reason:"\
+      " #{@reason.inspect}, applies_to_price_ids: #{@applies_to_price_ids.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end