maxio-advanced-billing-sdk 0.0.3 → 0.0.4

data/lib/advanced_billing/models/upsert_prepaid_configuration_request.rb

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

data/lib/advanced_billing/models/usage.rb

@@ -0,0 +1,155 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Usage Model.
+  class Usage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :memo
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :price_point_id
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :quantity
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :overage_quantity
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :component_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :component_handle
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :subscription_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['memo'] = 'memo'
+      @_hash['created_at'] = 'created_at'
+      @_hash['price_point_id'] = 'price_point_id'
+      @_hash['quantity'] = 'quantity'
+      @_hash['overage_quantity'] = 'overage_quantity'
+      @_hash['component_id'] = 'component_id'
+      @_hash['component_handle'] = 'component_handle'
+      @_hash['subscription_id'] = 'subscription_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        memo
+        created_at
+        price_point_id
+        quantity
+        overage_quantity
+        component_id
+        component_handle
+        subscription_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   memo = SKIP,
+                   created_at = SKIP,
+                   price_point_id = SKIP,
+                   quantity = SKIP,
+                   overage_quantity = SKIP,
+                   component_id = SKIP,
+                   component_handle = SKIP,
+                   subscription_id = SKIP)
+      @id = id unless id == SKIP
+      @memo = memo unless memo == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @price_point_id = price_point_id unless price_point_id == SKIP
+      @quantity = quantity unless quantity == SKIP
+      @overage_quantity = overage_quantity unless overage_quantity == SKIP
+      @component_id = component_id unless component_id == SKIP
+      @component_handle = component_handle unless component_handle == SKIP
+      @subscription_id = subscription_id unless subscription_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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      created_at = if hash.key?('created_at')
+                     (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
+                   else
+                     SKIP
+                   end
+      price_point_id =
+        hash.key?('price_point_id') ? hash['price_point_id'] : SKIP
+      quantity = hash.key?('quantity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:UsageQuantity), hash['quantity']
+      ) : SKIP
+      overage_quantity =
+        hash.key?('overage_quantity') ? hash['overage_quantity'] : SKIP
+      component_id = hash.key?('component_id') ? hash['component_id'] : SKIP
+      component_handle =
+        hash.key?('component_handle') ? hash['component_handle'] : SKIP
+      subscription_id =
+        hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
+
+      # Create object from extracted values.
+      Usage.new(id,
+                memo,
+                created_at,
+                price_point_id,
+                quantity,
+                overage_quantity,
+                component_id,
+                component_handle,
+                subscription_id)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Usage | 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

data/lib/advanced_billing/models/usage_response.rb

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

data/lib/advanced_billing/models/void_invoice.rb

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

data/lib/advanced_billing/models/void_invoice_event_data.rb

@@ -0,0 +1,148 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `void_invoice` event
+  class VoidInvoiceEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreditNote]
+    attr_accessor :credit_note_attributes
+
+    # The memo provided during invoice voiding.
+    # @return [String]
+    attr_accessor :memo
+
+    # The amount of the void.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The time the refund was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # If true, the invoice is an advance invoice.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_advance_invoice
+
+    # The reason for the void.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_note_attributes'] = 'credit_note_attributes'
+      @_hash['memo'] = 'memo'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash['is_advance_invoice'] = 'is_advance_invoice'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        credit_note_attributes
+        memo
+        applied_amount
+        transaction_time
+      ]
+    end
+
+    def initialize(credit_note_attributes = nil,
+                   memo = nil,
+                   applied_amount = nil,
+                   transaction_time = nil,
+                   is_advance_invoice = nil,
+                   reason = nil)
+      @credit_note_attributes = credit_note_attributes
+      @memo = memo
+      @applied_amount = applied_amount
+      @transaction_time = transaction_time
+      @is_advance_invoice = is_advance_invoice
+      @reason = reason
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      credit_note_attributes = hash.key?('credit_note_attributes') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:VoidInvoiceEventDataCreditNoteAttributes), hash['credit_note_attributes']
+      ) : nil
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         end
+      is_advance_invoice =
+        hash.key?('is_advance_invoice') ? hash['is_advance_invoice'] : nil
+      reason = hash.key?('reason') ? hash['reason'] : nil
+
+      # Create object from extracted values.
+      VoidInvoiceEventData.new(credit_note_attributes,
+                               memo,
+                               applied_amount,
+                               transaction_time,
+                               is_advance_invoice,
+                               reason)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoidInvoiceEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:VoidInvoiceEventDataCreditNoteAttributes)
+                         .validate(value.credit_note_attributes) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.applied_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.transaction_time,
+                                  ->(val) { val.instance_of? DateTime }) and
+            APIHelper.valid_type?(value.is_advance_invoice,
+                                  ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+            APIHelper.valid_type?(value.reason,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:VoidInvoiceEventDataCreditNoteAttributes)
+                       .validate(value['credit_note_attributes']) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['applied_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['transaction_time'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['is_advance_invoice'],
+                                ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass }) and
+          APIHelper.valid_type?(value['reason'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end

data/lib/advanced_billing/models/void_invoice_request.rb

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

data/lib/advanced_billing/models/void_remainder_event_data.rb

@@ -0,0 +1,115 @@
+# advanced_billing
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module AdvancedBilling
+  # Example schema for an `void_remainder` event
+  class VoidRemainderEventData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CreditNote]
+    attr_accessor :credit_note_attributes
+
+    # The memo provided during invoice remainder voiding.
+    # @return [String]
+    attr_accessor :memo
+
+    # The amount of the void.
+    # @return [String]
+    attr_accessor :applied_amount
+
+    # The time the refund was applied, in ISO 8601 format, i.e.
+    # "2019-06-07T17:20:06Z"
+    # @return [DateTime]
+    attr_accessor :transaction_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_note_attributes'] = 'credit_note_attributes'
+      @_hash['memo'] = 'memo'
+      @_hash['applied_amount'] = 'applied_amount'
+      @_hash['transaction_time'] = 'transaction_time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit_note_attributes = nil,
+                   memo = nil,
+                   applied_amount = nil,
+                   transaction_time = nil)
+      @credit_note_attributes = credit_note_attributes
+      @memo = memo
+      @applied_amount = applied_amount
+      @transaction_time = transaction_time
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      credit_note_attributes = CreditNote.from_hash(hash['credit_note_attributes']) if
+        hash['credit_note_attributes']
+      memo = hash.key?('memo') ? hash['memo'] : nil
+      applied_amount =
+        hash.key?('applied_amount') ? hash['applied_amount'] : nil
+      transaction_time = if hash.key?('transaction_time')
+                           (DateTimeHelper.from_rfc3339(hash['transaction_time']) if hash['transaction_time'])
+                         end
+
+      # Create object from extracted values.
+      VoidRemainderEventData.new(credit_note_attributes,
+                                 memo,
+                                 applied_amount,
+                                 transaction_time)
+    end
+
+    def to_custom_transaction_time
+      DateTimeHelper.to_rfc3339(transaction_time)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [VoidRemainderEventData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.credit_note_attributes,
+                                ->(val) { CreditNote.validate(val) }) and
+            APIHelper.valid_type?(value.memo,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.applied_amount,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.transaction_time,
+                                  ->(val) { val.instance_of? DateTime })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['credit_note_attributes'],
+                              ->(val) { CreditNote.validate(val) }) and
+          APIHelper.valid_type?(value['memo'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['applied_amount'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['transaction_time'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+  end
+end