maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/invoice_line_item_event_data.rb

@@ -0,0 +1,266 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoiceLineItemEventData Model.
+  class InvoiceLineItemEventData < 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 [Integer]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :quantity_delta
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :unit_price
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :period_range_start
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :period_range_end
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :line_references
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :pricing_details_index
+
+    # TODO: Write general description for this method
+    # @return [Array[InvoiceLineItemPricingDetail]]
+    attr_accessor :pricing_details
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tax_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :product_price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :billing_schedule_item_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :custom_item
+
+    # 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['quantity'] = 'quantity'
+      @_hash['quantity_delta'] = 'quantity_delta'
+      @_hash['unit_price'] = 'unit_price'
+      @_hash['period_range_start'] = 'period_range_start'
+      @_hash['period_range_end'] = 'period_range_end'
+      @_hash['amount'] = 'amount'
+      @_hash['line_references'] = 'line_references'
+      @_hash['pricing_details_index'] = 'pricing_details_index'
+      @_hash['pricing_details'] = 'pricing_details'
+      @_hash['tax_code'] = 'tax_code'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['product_id'] = 'product_id'
+      @_hash['product_price_point_id'] = 'product_price_point_id'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['component_id'] = 'component_id'
+      @_hash['billing_schedule_item_id'] = 'billing_schedule_item_id'
+      @_hash['custom_item'] = 'custom_item'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        title
+        description
+        quantity
+        quantity_delta
+        unit_price
+        period_range_start
+        period_range_end
+        amount
+        line_references
+        pricing_details_index
+        pricing_details
+        tax_code
+        tax_amount
+        product_id
+        product_price_point_id
+        price_point_id
+        component_id
+        billing_schedule_item_id
+        custom_item
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        quantity_delta
+        pricing_details_index
+        tax_code
+        product_price_point_id
+        price_point_id
+        component_id
+        billing_schedule_item_id
+        custom_item
+      ]
+    end
+
+    def initialize(uid = SKIP,
+                   title = SKIP,
+                   description = SKIP,
+                   quantity = SKIP,
+                   quantity_delta = SKIP,
+                   unit_price = SKIP,
+                   period_range_start = SKIP,
+                   period_range_end = SKIP,
+                   amount = SKIP,
+                   line_references = SKIP,
+                   pricing_details_index = SKIP,
+                   pricing_details = SKIP,
+                   tax_code = SKIP,
+                   tax_amount = SKIP,
+                   product_id = SKIP,
+                   product_price_point_id = SKIP,
+                   price_point_id = SKIP,
+                   component_id = SKIP,
+                   billing_schedule_item_id = SKIP,
+                   custom_item = SKIP)
+      @uid = uid unless uid == SKIP
+      @title = title unless title == SKIP
+      @description = description unless description == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @quantity_delta = quantity_delta unless quantity_delta == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @period_range_start = period_range_start unless period_range_start == SKIP
+      @period_range_end = period_range_end unless period_range_end == SKIP
+      @amount = amount unless amount == SKIP
+      @line_references = line_references unless line_references == SKIP
+      @pricing_details_index = pricing_details_index unless pricing_details_index == SKIP
+      @pricing_details = pricing_details unless pricing_details == SKIP
+      @tax_code = tax_code unless tax_code == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @product_id = product_id unless product_id == SKIP
+      @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @billing_schedule_item_id = billing_schedule_item_id unless billing_schedule_item_id == SKIP
+      @custom_item = custom_item unless custom_item == 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
+      quantity = hash.key?('quantity') ? hash['quantity'] : SKIP
+      quantity_delta =
+        hash.key?('quantity_delta') ? hash['quantity_delta'] : SKIP
+      unit_price = hash.key?('unit_price') ? hash['unit_price'] : SKIP
+      period_range_start =
+        hash.key?('period_range_start') ? hash['period_range_start'] : SKIP
+      period_range_end =
+        hash.key?('period_range_end') ? hash['period_range_end'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      line_references =
+        hash.key?('line_references') ? hash['line_references'] : SKIP
+      pricing_details_index =
+        hash.key?('pricing_details_index') ? hash['pricing_details_index'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      pricing_details = nil
+      unless hash['pricing_details'].nil?
+        pricing_details = []
+        hash['pricing_details'].each do |structure|
+          pricing_details << (InvoiceLineItemPricingDetail.from_hash(structure) if structure)
+        end
+      end
+
+      pricing_details = SKIP unless hash.key?('pricing_details')
+      tax_code = hash.key?('tax_code') ? hash['tax_code'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
+      product_price_point_id =
+        hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      billing_schedule_item_id =
+        hash.key?('billing_schedule_item_id') ? hash['billing_schedule_item_id'] : SKIP
+      custom_item = hash.key?('custom_item') ? hash['custom_item'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceLineItemEventData.new(uid,
+                                   title,
+                                   description,
+                                   quantity,
+                                   quantity_delta,
+                                   unit_price,
+                                   period_range_start,
+                                   period_range_end,
+                                   amount,
+                                   line_references,
+                                   pricing_details_index,
+                                   pricing_details,
+                                   tax_code,
+                                   tax_amount,
+                                   product_id,
+                                   product_price_point_id,
+                                   price_point_id,
+                                   component_id,
+                                   billing_schedule_item_id,
+                                   custom_item)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_line_item_pricing_detail.rb

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

data/lib/advanced_billing/models/invoice_payer.rb

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

data/lib/advanced_billing/models/invoice_payment.rb

@@ -0,0 +1,158 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # InvoicePayment Model.
+  class InvoicePayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :original_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # TODO: Write general description for this method
+    # @return [InvoicePaymentMethod]
+    attr_accessor :payment_method
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :transaction_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prepayment
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :gateway_handle
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :gateway_used
+
+    # The transaction ID for the payment as returned from the payment gateway
+    # @return [String]
+    attr_accessor :gateway_transaction_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['payment_method'] = 'payment_method'
+      @_hash['transaction_id'] = 'transaction_id'
+      @_hash['prepayment'] = 'prepayment'
+      @_hash['gateway_handle'] = 'gateway_handle'
+      @_hash['gateway_used'] = 'gateway_used'
+      @_hash['gateway_transaction_id'] = 'gateway_transaction_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_time
+        memo
+        original_amount
+        applied_amount
+        payment_method
+        transaction_id
+        prepayment
+        gateway_handle
+        gateway_used
+        gateway_transaction_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        gateway_handle
+        gateway_transaction_id
+      ]
+    end
+
+    def initialize(transaction_time = SKIP,
+                   memo = SKIP,
+                   original_amount = SKIP,
+                   applied_amount = SKIP,
+                   payment_method = SKIP,
+                   transaction_id = SKIP,
+                   prepayment = SKIP,
+                   gateway_handle = SKIP,
+                   gateway_used = SKIP,
+                   gateway_transaction_id = SKIP)
+      @transaction_time = transaction_time unless transaction_time == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == SKIP
+      @applied_amount = applied_amount unless applied_amount == SKIP
+      @payment_method = payment_method unless payment_method == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @prepayment = prepayment unless prepayment == SKIP
+      @gateway_handle = gateway_handle unless gateway_handle == SKIP
+      @gateway_used = gateway_used unless gateway_used == SKIP
+      @gateway_transaction_id = gateway_transaction_id unless gateway_transaction_id == 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.
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         else
+                           SKIP
+                         end
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      original_amount =
+        hash.key?('original_amount') ? hash['original_amount'] : SKIP
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
+      payment_method = InvoicePaymentMethod.from_hash(hash['payment_method']) if
+        hash['payment_method']
+      transaction_id =
+        hash.key?('transaction_id') ? hash['transaction_id'] : SKIP
+      prepayment = hash.key?('prepayment') ? hash['prepayment'] : SKIP
+      gateway_handle =
+        hash.key?('gateway_handle') ? hash['gateway_handle'] : SKIP
+      gateway_used = hash.key?('gateway_used') ? hash['gateway_used'] : SKIP
+      gateway_transaction_id =
+        hash.key?('gateway_transaction_id') ? hash['gateway_transaction_id'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePayment.new(transaction_time,
+                         memo,
+                         original_amount,
+                         applied_amount,
+                         payment_method,
+                         transaction_id,
+                         prepayment,
+                         gateway_handle,
+                         gateway_used,
+                         gateway_transaction_id)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_payment_application.rb

@@ -0,0 +1,74 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # InvoicePaymentApplication Model.
+  class InvoicePaymentApplication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the paid invoice. It has the prefix "inv_" followed
+    # by alphanumeric characters.
+    # @return [String]
+    attr_accessor :invoice_uid
+
+    # Unique identifier for the payment. It has the prefix "pmt_" followed by
+    # alphanumeric characters.
+    # @return [String]
+    attr_accessor :application_uid
+
+    # Dollar amount of the paid invoice.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['invoice_uid'] = 'invoice_uid'
+      @_hash['application_uid'] = 'application_uid'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        invoice_uid
+        application_uid
+        applied_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(invoice_uid = SKIP,
+                   application_uid = SKIP,
+                   applied_amount = SKIP)
+      @invoice_uid = invoice_uid unless invoice_uid == SKIP
+      @application_uid = application_uid unless application_uid == SKIP
+      @applied_amount = applied_amount unless applied_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.
+      invoice_uid = hash.key?('invoice_uid') ? hash['invoice_uid'] : SKIP
+      application_uid =
+        hash.key?('application_uid') ? hash['application_uid'] : SKIP
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : SKIP
+
+      # Create object from extracted values.
+      InvoicePaymentApplication.new(invoice_uid,
+                                    application_uid,
+                                    applied_amount)
+    end
+  end
+end