subtain-apimatic-sdk 4.1.1 → 9.1.1

data/lib/advanced_billing/models/proforma_invoice.rb

@@ -0,0 +1,463 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ProformaInvoice Model.
+  class ProformaInvoice < 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 [Integer]
+    attr_accessor :site_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :customer_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subscription_id
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :sequence_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :delivery_date
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :collection_method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_instructions
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :currency
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :consolidation_level
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :product_family_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :role
+
+    # Information about the seller (merchant) listed on the masthead of the
+    # invoice.
+    # @return [InvoiceSeller]
+    attr_accessor :seller
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [InvoiceCustomer]
+    attr_accessor :customer
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :memo
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [InvoiceAddress]
+    attr_accessor :billing_address
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [InvoiceAddress]
+    attr_accessor :shipping_address
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :subtotal_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :discount_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :tax_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :total_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :credit_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :paid_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :refund_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :due_amount
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [Array[InvoiceLineItem]]
+    attr_accessor :line_items
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [Array[ProformaInvoiceDiscount]]
+    attr_accessor :discounts
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [Array[ProformaInvoiceTax]]
+    attr_accessor :taxes
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [Array[ProformaInvoiceCredit]]
+    attr_accessor :credits
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [Array[ProformaInvoicePayment]]
+    attr_accessor :payments
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [Array[ProformaCustomField]]
+    attr_accessor :custom_fields
+
+    # Information about the customer who is owner or recipient the invoiced
+    # subscription.
+    # @return [String]
+    attr_accessor :public_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['site_id'] = 'site_id'
+      @_hash['customer_id'] = 'customer_id'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash['number'] = 'number'
+      @_hash['sequence_number'] = 'sequence_number'
+      @_hash['created_at'] = 'created_at'
+      @_hash['delivery_date'] = 'delivery_date'
+      @_hash['status'] = 'status'
+      @_hash['collection_method'] = 'collection_method'
+      @_hash['payment_instructions'] = 'payment_instructions'
+      @_hash['currency'] = 'currency'
+      @_hash['consolidation_level'] = 'consolidation_level'
+      @_hash['product_name'] = 'product_name'
+      @_hash['product_family_name'] = 'product_family_name'
+      @_hash['role'] = 'role'
+      @_hash['seller'] = 'seller'
+      @_hash['customer'] = 'customer'
+      @_hash['memo'] = 'memo'
+      @_hash['billing_address'] = 'billing_address'
+      @_hash['shipping_address'] = 'shipping_address'
+      @_hash['subtotal_amount'] = 'subtotal_amount'
+      @_hash['discount_amount'] = 'discount_amount'
+      @_hash['tax_amount'] = 'tax_amount'
+      @_hash['total_amount'] = 'total_amount'
+      @_hash['credit_amount'] = 'credit_amount'
+      @_hash['paid_amount'] = 'paid_amount'
+      @_hash['refund_amount'] = 'refund_amount'
+      @_hash['due_amount'] = 'due_amount'
+      @_hash['line_items'] = 'line_items'
+      @_hash['discounts'] = 'discounts'
+      @_hash['taxes'] = 'taxes'
+      @_hash['credits'] = 'credits'
+      @_hash['payments'] = 'payments'
+      @_hash['custom_fields'] = 'custom_fields'
+      @_hash['public_url'] = 'public_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        site_id
+        customer_id
+        subscription_id
+        number
+        sequence_number
+        created_at
+        delivery_date
+        status
+        collection_method
+        payment_instructions
+        currency
+        consolidation_level
+        product_name
+        product_family_name
+        role
+        seller
+        customer
+        memo
+        billing_address
+        shipping_address
+        subtotal_amount
+        discount_amount
+        tax_amount
+        total_amount
+        credit_amount
+        paid_amount
+        refund_amount
+        due_amount
+        line_items
+        discounts
+        taxes
+        credits
+        payments
+        custom_fields
+        public_url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, site_id = SKIP, customer_id = SKIP,
+                   subscription_id = SKIP, number = SKIP,
+                   sequence_number = SKIP, created_at = SKIP,
+                   delivery_date = SKIP, status = SKIP,
+                   collection_method = SKIP, payment_instructions = SKIP,
+                   currency = SKIP, consolidation_level = SKIP,
+                   product_name = SKIP, product_family_name = SKIP, role = SKIP,
+                   seller = SKIP, customer = SKIP, memo = SKIP,
+                   billing_address = SKIP, shipping_address = SKIP,
+                   subtotal_amount = SKIP, discount_amount = SKIP,
+                   tax_amount = SKIP, total_amount = SKIP, credit_amount = SKIP,
+                   paid_amount = SKIP, refund_amount = SKIP, due_amount = SKIP,
+                   line_items = SKIP, discounts = SKIP, taxes = SKIP,
+                   credits = SKIP, payments = SKIP, custom_fields = SKIP,
+                   public_url = SKIP)
+      @uid = uid unless uid == SKIP
+      @site_id = site_id unless site_id == SKIP
+      @customer_id = customer_id unless customer_id == SKIP
+      @subscription_id = subscription_id unless subscription_id == SKIP
+      @number = number unless number == SKIP
+      @sequence_number = sequence_number unless sequence_number == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @delivery_date = delivery_date unless delivery_date == SKIP
+      @status = status unless status == SKIP
+      @collection_method = collection_method unless collection_method == SKIP
+      @payment_instructions = payment_instructions unless payment_instructions == SKIP
+      @currency = currency unless currency == SKIP
+      @consolidation_level = consolidation_level unless consolidation_level == SKIP
+      @product_name = product_name unless product_name == SKIP
+      @product_family_name = product_family_name unless product_family_name == SKIP
+      @role = role unless role == SKIP
+      @seller = seller unless seller == SKIP
+      @customer = customer unless customer == SKIP
+      @memo = memo unless memo == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @shipping_address = shipping_address unless shipping_address == SKIP
+      @subtotal_amount = subtotal_amount unless subtotal_amount == SKIP
+      @discount_amount = discount_amount unless discount_amount == SKIP
+      @tax_amount = tax_amount unless tax_amount == SKIP
+      @total_amount = total_amount unless total_amount == SKIP
+      @credit_amount = credit_amount unless credit_amount == SKIP
+      @paid_amount = paid_amount unless paid_amount == SKIP
+      @refund_amount = refund_amount unless refund_amount == SKIP
+      @due_amount = due_amount unless due_amount == SKIP
+      @line_items = line_items unless line_items == SKIP
+      @discounts = discounts unless discounts == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @credits = credits unless credits == SKIP
+      @payments = payments unless payments == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @public_url = public_url unless public_url == 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
+      site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
+      customer_id = hash.key?('customer_id') ? hash['customer_id'] : SKIP
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+      number = hash.key?('number') ? hash['number'] : SKIP
+      sequence_number =
+        hash.key?('sequence_number') ? hash['sequence_number'] : SKIP
+      created_at = hash.key?('created_at') ? hash['created_at'] : SKIP
+      delivery_date = hash.key?('delivery_date') ? hash['delivery_date'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      collection_method =
+        hash.key?('collection_method') ? hash['collection_method'] : SKIP
+      payment_instructions =
+        hash.key?('payment_instructions') ? hash['payment_instructions'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      consolidation_level =
+        hash.key?('consolidation_level') ? hash['consolidation_level'] : SKIP
+      product_name = hash.key?('product_name') ? hash['product_name'] : SKIP
+      product_family_name =
+        hash.key?('product_family_name') ? hash['product_family_name'] : SKIP
+      role = hash.key?('role') ? hash['role'] : SKIP
+      seller = InvoiceSeller.from_hash(hash['seller']) if hash['seller']
+      customer = InvoiceCustomer.from_hash(hash['customer']) if hash['customer']
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      billing_address = InvoiceAddress.from_hash(hash['billing_address']) if
+        hash['billing_address']
+      shipping_address = InvoiceAddress.from_hash(hash['shipping_address']) if
+        hash['shipping_address']
+      subtotal_amount =
+        hash.key?('subtotal_amount') ? hash['subtotal_amount'] : SKIP
+      discount_amount =
+        hash.key?('discount_amount') ? hash['discount_amount'] : SKIP
+      tax_amount = hash.key?('tax_amount') ? hash['tax_amount'] : SKIP
+      total_amount = hash.key?('total_amount') ? hash['total_amount'] : SKIP
+      credit_amount = hash.key?('credit_amount') ? hash['credit_amount'] : SKIP
+      paid_amount = hash.key?('paid_amount') ? hash['paid_amount'] : SKIP
+      refund_amount = hash.key?('refund_amount') ? hash['refund_amount'] : SKIP
+      due_amount = hash.key?('due_amount') ? hash['due_amount'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      line_items = nil
+      unless hash['line_items'].nil?
+        line_items = []
+        hash['line_items'].each do |structure|
+          line_items << (InvoiceLineItem.from_hash(structure) if structure)
+        end
+      end
+
+      line_items = SKIP unless hash.key?('line_items')
+      # Parameter is an array, so we need to iterate through it
+      discounts = nil
+      unless hash['discounts'].nil?
+        discounts = []
+        hash['discounts'].each do |structure|
+          discounts << (ProformaInvoiceDiscount.from_hash(structure) if structure)
+        end
+      end
+
+      discounts = SKIP unless hash.key?('discounts')
+      # Parameter is an array, so we need to iterate through it
+      taxes = nil
+      unless hash['taxes'].nil?
+        taxes = []
+        hash['taxes'].each do |structure|
+          taxes << (ProformaInvoiceTax.from_hash(structure) if structure)
+        end
+      end
+
+      taxes = SKIP unless hash.key?('taxes')
+      # Parameter is an array, so we need to iterate through it
+      credits = nil
+      unless hash['credits'].nil?
+        credits = []
+        hash['credits'].each do |structure|
+          credits << (ProformaInvoiceCredit.from_hash(structure) if structure)
+        end
+      end
+
+      credits = SKIP unless hash.key?('credits')
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['payments'].nil?
+        payments = []
+        hash['payments'].each do |structure|
+          payments << (ProformaInvoicePayment.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('payments')
+      # Parameter is an array, so we need to iterate through it
+      custom_fields = nil
+      unless hash['custom_fields'].nil?
+        custom_fields = []
+        hash['custom_fields'].each do |structure|
+          custom_fields << (ProformaCustomField.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('custom_fields')
+      public_url = hash.key?('public_url') ? hash['public_url'] : SKIP
+
+      # Create object from extracted values.
+      ProformaInvoice.new(uid,
+                          site_id,
+                          customer_id,
+                          subscription_id,
+                          number,
+                          sequence_number,
+                          created_at,
+                          delivery_date,
+                          status,
+                          collection_method,
+                          payment_instructions,
+                          currency,
+                          consolidation_level,
+                          product_name,
+                          product_family_name,
+                          role,
+                          seller,
+                          customer,
+                          memo,
+                          billing_address,
+                          shipping_address,
+                          subtotal_amount,
+                          discount_amount,
+                          tax_amount,
+                          total_amount,
+                          credit_amount,
+                          paid_amount,
+                          refund_amount,
+                          due_amount,
+                          line_items,
+                          discounts,
+                          taxes,
+                          credits,
+                          payments,
+                          custom_fields,
+                          public_url)
+    end
+  end
+end

data/lib/advanced_billing/models/proforma_invoice_credit.rb

@@ -0,0 +1,80 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # ProformaInvoiceCredit Model.
+  class ProformaInvoiceCredit < 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 :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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['memo'] = 'memo'
+      @_hash['original_amount'] = 'original_amount'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uid
+        memo
+        original_amount
+        applied_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP, memo = SKIP, original_amount = SKIP,
+                   applied_amount = SKIP)
+      @uid = uid unless uid == SKIP
+      @memo = memo unless memo == SKIP
+      @original_amount = original_amount unless original_amount == 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.
+      uid = hash.key?('uid') ? hash['uid'] : SKIP
+      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
+
+      # Create object from extracted values.
+      ProformaInvoiceCredit.new(uid,
+                                memo,
+                                original_amount,
+                                applied_amount)
+    end
+  end
+end

data/lib/advanced_billing/models/proforma_invoice_discount.rb

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