maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/invoice_address.rb

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

data/lib/advanced_billing/models/invoice_balance_item.rb

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

data/lib/advanced_billing/models/invoice_consolidation_level.rb

@@ -0,0 +1,34 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Consolidation level of the invoice, which is applicable to invoice
+  # consolidation.  It will hold one of the following values: * "none": A normal
+  # invoice with no consolidation. * "child": An invoice segment which has been
+  # combined into a consolidated invoice. * "parent": A consolidated invoice,
+  # whose contents are composed of invoice segments. "Parent" invoices do not
+  # have lines of their own, but they have subtotals and totals which aggregate
+  # the member invoice segments. See also the [invoice consolidation
+  # documentation](https://chargify.zendesk.com/hc/en-us/articles/4407746391835)
+  # .
+  class InvoiceConsolidationLevel
+    INVOICE_CONSOLIDATION_LEVEL = [
+      # TODO: Write general description for NONE
+      NONE = 'none'.freeze,
+
+      # TODO: Write general description for CHILD
+      CHILD = 'child'.freeze,
+
+      # TODO: Write general description for PARENT
+      PARENT = 'parent'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_CONSOLIDATION_LEVEL.include?(value)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_credit.rb

@@ -0,0 +1,123 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # InvoiceCredit Model.
+  class InvoiceCredit < 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 :credit_note_number
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :credit_note_uid
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uid'] = 'uid'
+      @_hash['credit_note_number'] = 'credit_note_number'
+      @_hash['credit_note_uid'] = 'credit_note_uid'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_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
+        credit_note_number
+        credit_note_uid
+        transaction_time
+        memo
+        original_amount
+        applied_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uid = SKIP,
+                   credit_note_number = SKIP,
+                   credit_note_uid = SKIP,
+                   transaction_time = SKIP,
+                   memo = SKIP,
+                   original_amount = SKIP,
+                   applied_amount = SKIP)
+      @uid = uid unless uid == SKIP
+      @credit_note_number = credit_note_number unless credit_note_number == SKIP
+      @credit_note_uid = credit_note_uid unless credit_note_uid == 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
+    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
+      credit_note_number =
+        hash.key?('credit_note_number') ? hash['credit_note_number'] : SKIP
+      credit_note_uid =
+        hash.key?('credit_note_uid') ? hash['credit_note_uid'] : SKIP
+      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
+
+      # Create object from extracted values.
+      InvoiceCredit.new(uid,
+                        credit_note_number,
+                        credit_note_uid,
+                        transaction_time,
+                        memo,
+                        original_amount,
+                        applied_amount)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_custom_field.rb

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

data/lib/advanced_billing/models/invoice_customer.rb

@@ -0,0 +1,115 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Information about the customer who is owner or recipient the invoiced
+  # subscription.
+  class InvoiceCustomer < 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
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # 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['reference'] = 'reference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        chargify_id
+        first_name
+        last_name
+        organization
+        email
+        vat_number
+        reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        organization
+        vat_number
+        reference
+      ]
+    end
+
+    def initialize(chargify_id = SKIP,
+                   first_name = SKIP,
+                   last_name = SKIP,
+                   organization = SKIP,
+                   email = SKIP,
+                   vat_number = SKIP,
+                   reference = 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
+      @reference = reference unless reference == 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
+      reference = hash.key?('reference') ? hash['reference'] : SKIP
+
+      # Create object from extracted values.
+      InvoiceCustomer.new(chargify_id,
+                          first_name,
+                          last_name,
+                          organization,
+                          email,
+                          vat_number,
+                          reference)
+    end
+  end
+end

data/lib/advanced_billing/models/invoice_date_field.rb

@@ -0,0 +1,32 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AdvancedBilling
+  # Invoice Date Field.
+  class InvoiceDateField
+    INVOICE_DATE_FIELD = [
+      # TODO: Write general description for CREATED_AT
+      CREATED_AT = 'created_at'.freeze,
+
+      # TODO: Write general description for DUE_DATE
+      DUE_DATE = 'due_date'.freeze,
+
+      # TODO: Write general description for ISSUE_DATE
+      ISSUE_DATE = 'issue_date'.freeze,
+
+      # TODO: Write general description for UPDATED_AT
+      UPDATED_AT = 'updated_at'.freeze,
+
+      # TODO: Write general description for PAID_DATE
+      PAID_DATE = 'paid_date'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INVOICE_DATE_FIELD.include?(value)
+    end
+  end
+end