maxio-advanced-billing-sdk 0.0.3 → 1.0.0

data/lib/advanced_billing/models/invoice_discount.rb

@@ -0,0 +1,174 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceDiscount Model.
+  class InvoiceDiscount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :title
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :description
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source_type
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :source_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :discount_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :percentage
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :eligible_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceDiscountBreakout]]
+    attr_accessor :line_item_breakouts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['title'] = 'title'
+      @_hash['description'] = 'description'
+      @_hash['code'] = 'code'
+      @_hash['source_type'] = 'source_type'
+      @_hash['source_id'] = 'source_id'
+      @_hash['discount_type'] = 'discount_type'
+      @_hash['percentage'] = 'percentage'
+      @_hash['eligible_amount'] = 'eligible_amount'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['line_item_breakouts'] = 'line_item_breakouts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        title
+        description
+        code
+        source_type
+        source_id
+        discount_type
+        percentage
+        eligible_amount
+        discount_amount
+        transaction_id
+        line_item_breakouts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        description
+      ]
+    end
+
+    def initialize(uid = SKIP,
+                   title = SKIP,
+                   description = SKIP,
+                   code = SKIP,
+                   source_type = SKIP,
+                   source_id = SKIP,
+                   discount_type = SKIP,
+                   percentage = SKIP,
+                   eligible_amount = SKIP,
+                   discount_amount = SKIP,
+                   transaction_id = SKIP,
+                   line_item_breakouts = SKIP)
+      @uid = uid unless uid == SKIP
+      @title = title unless title == SKIP
+      @description = description unless description == SKIP
+      @code = code unless code == SKIP
+      @source_type = source_type unless source_type == SKIP
+      @source_id = source_id unless source_id == SKIP
+      @discount_type = discount_type unless discount_type == SKIP
+      @percentage = percentage unless percentage == SKIP
+      @eligible_amount = eligible_amount unless eligible_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @line_item_breakouts = line_item_breakouts unless line_item_breakouts == 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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      title = hash.key?('title') ? hash['title'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      source_type = hash.key?('source_type') ? hash['source_type'] : SKIP
+      source_id = hash.key?('source_id') ? hash['source_id'] : SKIP
+      discount_type = hash.key?('discount_type') ? hash['discount_type'] : SKIP
+      percentage = hash.key?('percentage') ? hash['percentage'] : SKIP
+      eligible_amount =
+        hash.key?('eligible_amount') ? hash['eligible_amount'] : SKIP
+      discount_amount =
+        hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_item_breakouts = nil
+      unless hash['line_item_breakouts'].nil?
+        line_item_breakouts = []
+        hash['line_item_breakouts'].each do |structure|
+          line_item_breakouts << (InvoiceDiscountBreakout.from_hash(structure) if structure)
+        end
+      end
+
+      line_item_breakouts = SKIP unless hash.key?('line_item_breakouts')
+
+      # Create object from extracted values.
+      InvoiceDiscount.new(uid,
+                          title,
+                          description,
+                          code,
+                          source_type,
+                          source_id,
+                          discount_type,
+                          percentage,
+                          eligible_amount,
+                          discount_amount,
+                          transaction_id,
+                          line_item_breakouts)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_discount_breakout.rb

@@ -0,0 +1,72 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceDiscountBreakout Model.
+  class InvoiceDiscountBreakout < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :uid
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :eligible_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['eligible_amount'] = 'eligible_amount'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        eligible_amount
+        discount_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   eligible_amount = SKIP,
+                   discount_amount = SKIP)
+      @uid = uid unless uid == SKIP
+      @eligible_amount = eligible_amount unless eligible_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == 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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      eligible_amount =
+        hash.key?('eligible_amount') ? hash['eligible_amount'] : SKIP
+      discount_amount =
+        hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDiscountBreakout.new(uid,
+                                  eligible_amount,
+                                  discount_amount)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_display_settings.rb

@@ -0,0 +1,65 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceDisplaySettings Model.
+  class InvoiceDisplaySettings < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :hide_zero_subtotal_lines
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_discounts_on_lines
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['hide_zero_subtotal_lines'] = 'hide_zero_subtotal_lines'
+      @_hash['include_discounts_on_lines'] = 'include_discounts_on_lines'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        hide_zero_subtotal_lines
+        include_discounts_on_lines
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(hide_zero_subtotal_lines = SKIP,
+                   include_discounts_on_lines = SKIP)
+      @hide_zero_subtotal_lines = hide_zero_subtotal_lines unless hide_zero_subtotal_lines == SKIP
+      unless include_discounts_on_lines == SKIP
+        @include_discounts_on_lines =
+          include_discounts_on_lines
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      hide_zero_subtotal_lines =
+        hash.key?('hide_zero_subtotal_lines') ? hash['hide_zero_subtotal_lines'] : SKIP
+      include_discounts_on_lines =
+        hash.key?('include_discounts_on_lines') ? hash['include_discounts_on_lines'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceDisplaySettings.new(hide_zero_subtotal_lines,
+                                 include_discounts_on_lines)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_event.rb

@@ -0,0 +1,105 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceEvent Model.
+  class InvoiceEvent < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # Invoice Event Type
+    # @return [InvoiceEventType]
+    attr_accessor :event_type
+
+    # The event data is the data that, when combined with the command, results
+    # in the output invoice found in the invoice field.
+    # @return [InvoiceEventData]
+    attr_accessor :event_data
+
+    # The event data is the data that, when combined with the command, results
+    # in the output invoice found in the invoice field.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # The event data is the data that, when combined with the command, results
+    # in the output invoice found in the invoice field.
+    # @return [Invoice]
+    attr_accessor :invoice
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['event_type'] = 'event_type'
+      @_hash['event_data'] = 'event_data'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['invoice'] = 'invoice'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        event_type
+        event_data
+        timestamp
+        invoice
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   event_type = SKIP,
+                   event_data = SKIP,
+                   timestamp = SKIP,
+                   invoice = SKIP)
+      @id = id unless id == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @event_data = event_data unless event_data == SKIP
+      @timestamp = timestamp unless timestamp == SKIP
+      @invoice = invoice unless invoice == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      event_type = hash.key?('event_type') ? hash['event_type'] : SKIP
+      event_data = hash.key?('event_data') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:InvoiceEventEventData), hash['event_data']
+      ) : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      invoice = Invoice.from_hash(hash['invoice']) if hash['invoice']
+
+      # Create object from extracted values.
+      InvoiceEvent.new(id,
+                       event_type,
+                       event_data,
+                       timestamp,
+                       invoice)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InvoiceEvent | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+  end
+end